aws-sdk-simpledbv2 1.0.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 +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-simpledbv2/client.rb +865 -0
- data/lib/aws-sdk-simpledbv2/client_api.rb +184 -0
- data/lib/aws-sdk-simpledbv2/customizations.rb +0 -0
- data/lib/aws-sdk-simpledbv2/endpoint_parameters.rb +69 -0
- data/lib/aws-sdk-simpledbv2/endpoint_provider.rb +53 -0
- data/lib/aws-sdk-simpledbv2/endpoints.rb +20 -0
- data/lib/aws-sdk-simpledbv2/errors.rb +150 -0
- data/lib/aws-sdk-simpledbv2/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-simpledbv2/resource.rb +26 -0
- data/lib/aws-sdk-simpledbv2/types.rb +369 -0
- data/lib/aws-sdk-simpledbv2/waiters.rb +120 -0
- data/lib/aws-sdk-simpledbv2.rb +62 -0
- data/sig/client.rbs +144 -0
- data/sig/errors.rbs +37 -0
- data/sig/resource.rbs +85 -0
- data/sig/types.rbs +109 -0
- data/sig/waiters.rbs +23 -0
- metadata +97 -0
|
@@ -0,0 +1,369 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
|
4
|
+
#
|
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
|
+
#
|
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
|
9
|
+
|
|
10
|
+
module Aws::SimpleDBv2
|
|
11
|
+
module Types
|
|
12
|
+
|
|
13
|
+
# Indicates a conflict with one or more parameters of the request.
|
|
14
|
+
#
|
|
15
|
+
# @!attribute [rw] message
|
|
16
|
+
# @return [String]
|
|
17
|
+
#
|
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/simpledbv2-2025-09-26/ConflictException AWS API Documentation
|
|
19
|
+
#
|
|
20
|
+
class ConflictException < Struct.new(
|
|
21
|
+
:message)
|
|
22
|
+
SENSITIVE = []
|
|
23
|
+
include Aws::Structure
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
# Summary information about an export, including its unique identifier,
|
|
27
|
+
# current status, creation time, and the domain being exported.
|
|
28
|
+
#
|
|
29
|
+
# @!attribute [rw] export_arn
|
|
30
|
+
# Unique ARN identifier of the export.
|
|
31
|
+
# @return [String]
|
|
32
|
+
#
|
|
33
|
+
# @!attribute [rw] export_status
|
|
34
|
+
# The current state of the export. Current possible values include :
|
|
35
|
+
# PENDING - export request received, IN\_PROGRESS - export is being
|
|
36
|
+
# processed, SUCCEEDED - export completed successfully, and FAILED -
|
|
37
|
+
# export encountered an error.
|
|
38
|
+
# @return [String]
|
|
39
|
+
#
|
|
40
|
+
# @!attribute [rw] requested_at
|
|
41
|
+
# Timestamp when the export request was received by the service
|
|
42
|
+
# @return [Time]
|
|
43
|
+
#
|
|
44
|
+
# @!attribute [rw] domain_name
|
|
45
|
+
# The name of the domain for which the export was created.
|
|
46
|
+
# @return [String]
|
|
47
|
+
#
|
|
48
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/simpledbv2-2025-09-26/ExportSummary AWS API Documentation
|
|
49
|
+
#
|
|
50
|
+
class ExportSummary < Struct.new(
|
|
51
|
+
:export_arn,
|
|
52
|
+
:export_status,
|
|
53
|
+
:requested_at,
|
|
54
|
+
:domain_name)
|
|
55
|
+
SENSITIVE = []
|
|
56
|
+
include Aws::Structure
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
# @!attribute [rw] export_arn
|
|
60
|
+
# Unique ARN identifier of the export.
|
|
61
|
+
# @return [String]
|
|
62
|
+
#
|
|
63
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/simpledbv2-2025-09-26/GetExportRequest AWS API Documentation
|
|
64
|
+
#
|
|
65
|
+
class GetExportRequest < Struct.new(
|
|
66
|
+
:export_arn)
|
|
67
|
+
SENSITIVE = []
|
|
68
|
+
include Aws::Structure
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
# @!attribute [rw] export_arn
|
|
72
|
+
# Unique ARN identifier of the export.
|
|
73
|
+
# @return [String]
|
|
74
|
+
#
|
|
75
|
+
# @!attribute [rw] client_token
|
|
76
|
+
# The client token provided for this export.
|
|
77
|
+
# @return [String]
|
|
78
|
+
#
|
|
79
|
+
# @!attribute [rw] export_status
|
|
80
|
+
# The current state of the export. Current possible values include :
|
|
81
|
+
# PENDING - export request received, IN\_PROGRESS - export is being
|
|
82
|
+
# processed, SUCCEEDED - export completed successfully, and FAILED -
|
|
83
|
+
# export encountered an error.
|
|
84
|
+
# @return [String]
|
|
85
|
+
#
|
|
86
|
+
# @!attribute [rw] domain_name
|
|
87
|
+
# The name of the domain that was exported.
|
|
88
|
+
# @return [String]
|
|
89
|
+
#
|
|
90
|
+
# @!attribute [rw] requested_at
|
|
91
|
+
# Timestamp when the export request was received by the service.
|
|
92
|
+
# @return [Time]
|
|
93
|
+
#
|
|
94
|
+
# @!attribute [rw] s3_bucket
|
|
95
|
+
# The name of the S3 bucket for this export.
|
|
96
|
+
# @return [String]
|
|
97
|
+
#
|
|
98
|
+
# @!attribute [rw] s3_key_prefix
|
|
99
|
+
# The S3 key prefix provided in the corresponding StartDomainExport
|
|
100
|
+
# request.
|
|
101
|
+
# @return [String]
|
|
102
|
+
#
|
|
103
|
+
# @!attribute [rw] s3_sse_algorithm
|
|
104
|
+
# The S3 SSE encryption algorithm for this export.
|
|
105
|
+
# @return [String]
|
|
106
|
+
#
|
|
107
|
+
# @!attribute [rw] s3_sse_kms_key_id
|
|
108
|
+
# The KMS key ID for this export.
|
|
109
|
+
# @return [String]
|
|
110
|
+
#
|
|
111
|
+
# @!attribute [rw] s3_bucket_owner
|
|
112
|
+
# The S3 bucket owner account ID for this export.
|
|
113
|
+
# @return [String]
|
|
114
|
+
#
|
|
115
|
+
# @!attribute [rw] failure_code
|
|
116
|
+
# Failure code for the result of the failed export.
|
|
117
|
+
# @return [String]
|
|
118
|
+
#
|
|
119
|
+
# @!attribute [rw] failure_message
|
|
120
|
+
# Export failure reason description.
|
|
121
|
+
# @return [String]
|
|
122
|
+
#
|
|
123
|
+
# @!attribute [rw] export_manifest
|
|
124
|
+
# The name of the manifest summary file for the export.
|
|
125
|
+
# @return [String]
|
|
126
|
+
#
|
|
127
|
+
# @!attribute [rw] items_count
|
|
128
|
+
# Total number of exported items.
|
|
129
|
+
# @return [Integer]
|
|
130
|
+
#
|
|
131
|
+
# @!attribute [rw] export_data_cutoff_time
|
|
132
|
+
# The timestamp indicating the cutoff point for data inclusion in the
|
|
133
|
+
# export. All data inserted or modified before this time will be
|
|
134
|
+
# present in the exported data. Data insertions or modifications after
|
|
135
|
+
# this timestamp may or may not be present in the export.
|
|
136
|
+
# @return [Time]
|
|
137
|
+
#
|
|
138
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/simpledbv2-2025-09-26/GetExportResponse AWS API Documentation
|
|
139
|
+
#
|
|
140
|
+
class GetExportResponse < Struct.new(
|
|
141
|
+
:export_arn,
|
|
142
|
+
:client_token,
|
|
143
|
+
:export_status,
|
|
144
|
+
:domain_name,
|
|
145
|
+
:requested_at,
|
|
146
|
+
:s3_bucket,
|
|
147
|
+
:s3_key_prefix,
|
|
148
|
+
:s3_sse_algorithm,
|
|
149
|
+
:s3_sse_kms_key_id,
|
|
150
|
+
:s3_bucket_owner,
|
|
151
|
+
:failure_code,
|
|
152
|
+
:failure_message,
|
|
153
|
+
:export_manifest,
|
|
154
|
+
:items_count,
|
|
155
|
+
:export_data_cutoff_time)
|
|
156
|
+
SENSITIVE = []
|
|
157
|
+
include Aws::Structure
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
# The specified next token is not valid.
|
|
161
|
+
#
|
|
162
|
+
# @!attribute [rw] message
|
|
163
|
+
# @return [String]
|
|
164
|
+
#
|
|
165
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/simpledbv2-2025-09-26/InvalidNextTokenException AWS API Documentation
|
|
166
|
+
#
|
|
167
|
+
class InvalidNextTokenException < Struct.new(
|
|
168
|
+
:message)
|
|
169
|
+
SENSITIVE = []
|
|
170
|
+
include Aws::Structure
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
# Parameters that must not be used together were used together in the
|
|
174
|
+
# request.
|
|
175
|
+
#
|
|
176
|
+
# @!attribute [rw] message
|
|
177
|
+
# @return [String]
|
|
178
|
+
#
|
|
179
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/simpledbv2-2025-09-26/InvalidParameterCombinationException AWS API Documentation
|
|
180
|
+
#
|
|
181
|
+
class InvalidParameterCombinationException < Struct.new(
|
|
182
|
+
:message)
|
|
183
|
+
SENSITIVE = []
|
|
184
|
+
include Aws::Structure
|
|
185
|
+
end
|
|
186
|
+
|
|
187
|
+
# The specified parameter value is not valid.
|
|
188
|
+
#
|
|
189
|
+
# @!attribute [rw] message
|
|
190
|
+
# @return [String]
|
|
191
|
+
#
|
|
192
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/simpledbv2-2025-09-26/InvalidParameterValueException AWS API Documentation
|
|
193
|
+
#
|
|
194
|
+
class InvalidParameterValueException < Struct.new(
|
|
195
|
+
:message)
|
|
196
|
+
SENSITIVE = []
|
|
197
|
+
include Aws::Structure
|
|
198
|
+
end
|
|
199
|
+
|
|
200
|
+
# @!attribute [rw] domain_name
|
|
201
|
+
# The name of the domain to filter exports. If not provided, exports
|
|
202
|
+
# for all the domains will be listed.
|
|
203
|
+
# @return [String]
|
|
204
|
+
#
|
|
205
|
+
# @!attribute [rw] max_results
|
|
206
|
+
# The maximum number of exports to return in a single response.
|
|
207
|
+
# @return [Integer]
|
|
208
|
+
#
|
|
209
|
+
# @!attribute [rw] next_token
|
|
210
|
+
# A pagination token used to retrieve the next page of results. This
|
|
211
|
+
# token is obtained from the nextToken field in the previous
|
|
212
|
+
# ListExportsResponse. Leave empty for the first request.
|
|
213
|
+
# @return [String]
|
|
214
|
+
#
|
|
215
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/simpledbv2-2025-09-26/ListExportsRequest AWS API Documentation
|
|
216
|
+
#
|
|
217
|
+
class ListExportsRequest < Struct.new(
|
|
218
|
+
:domain_name,
|
|
219
|
+
:max_results,
|
|
220
|
+
:next_token)
|
|
221
|
+
SENSITIVE = []
|
|
222
|
+
include Aws::Structure
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
# @!attribute [rw] export_summaries
|
|
226
|
+
# List of export summaries containing export ARN, status, request
|
|
227
|
+
# timestamp, and associated domain name.
|
|
228
|
+
# @return [Array<Types::ExportSummary>]
|
|
229
|
+
#
|
|
230
|
+
# @!attribute [rw] next_token
|
|
231
|
+
# A pagination token indicating that more results are available. To
|
|
232
|
+
# retrieve the next page of results, provide this token in a
|
|
233
|
+
# subsequent ListExports request. If null or empty, there are no more
|
|
234
|
+
# results to retrieve.
|
|
235
|
+
# @return [String]
|
|
236
|
+
#
|
|
237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/simpledbv2-2025-09-26/ListExportsResponse AWS API Documentation
|
|
238
|
+
#
|
|
239
|
+
class ListExportsResponse < Struct.new(
|
|
240
|
+
:export_summaries,
|
|
241
|
+
:next_token)
|
|
242
|
+
SENSITIVE = []
|
|
243
|
+
include Aws::Structure
|
|
244
|
+
end
|
|
245
|
+
|
|
246
|
+
# The specified domain does not exist.
|
|
247
|
+
#
|
|
248
|
+
# @!attribute [rw] message
|
|
249
|
+
# @return [String]
|
|
250
|
+
#
|
|
251
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/simpledbv2-2025-09-26/NoSuchDomainException AWS API Documentation
|
|
252
|
+
#
|
|
253
|
+
class NoSuchDomainException < Struct.new(
|
|
254
|
+
:message)
|
|
255
|
+
SENSITIVE = []
|
|
256
|
+
include Aws::Structure
|
|
257
|
+
end
|
|
258
|
+
|
|
259
|
+
# Export with specified ARN does not exist.
|
|
260
|
+
#
|
|
261
|
+
# @!attribute [rw] message
|
|
262
|
+
# @return [String]
|
|
263
|
+
#
|
|
264
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/simpledbv2-2025-09-26/NoSuchExportException AWS API Documentation
|
|
265
|
+
#
|
|
266
|
+
class NoSuchExportException < Struct.new(
|
|
267
|
+
:message)
|
|
268
|
+
SENSITIVE = []
|
|
269
|
+
include Aws::Structure
|
|
270
|
+
end
|
|
271
|
+
|
|
272
|
+
# Cannot start export as export quota limit was exceeded
|
|
273
|
+
#
|
|
274
|
+
# @!attribute [rw] message
|
|
275
|
+
# @return [String]
|
|
276
|
+
#
|
|
277
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/simpledbv2-2025-09-26/NumberExportsLimitExceeded AWS API Documentation
|
|
278
|
+
#
|
|
279
|
+
class NumberExportsLimitExceeded < Struct.new(
|
|
280
|
+
:message)
|
|
281
|
+
SENSITIVE = []
|
|
282
|
+
include Aws::Structure
|
|
283
|
+
end
|
|
284
|
+
|
|
285
|
+
# @!attribute [rw] client_token
|
|
286
|
+
# Providing a ClientToken makes the call to StartDomainExport API
|
|
287
|
+
# idempotent, meaning that multiple identical calls have the same
|
|
288
|
+
# effect as one single call. A client token is valid for 8 hours after
|
|
289
|
+
# the first request that uses it is completed. After 8 hours, any
|
|
290
|
+
# request with the same client token is treated as a new request. Do
|
|
291
|
+
# not resubmit the same request with the same client token for more
|
|
292
|
+
# than 8 hours, or the result might not be idempotent. If you submit a
|
|
293
|
+
# request with the same client token but a change in other parameters
|
|
294
|
+
# within the 8-hour idempotency window, a ConflictException will be
|
|
295
|
+
# returned.
|
|
296
|
+
#
|
|
297
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
298
|
+
# not need to pass this option.
|
|
299
|
+
# @return [String]
|
|
300
|
+
#
|
|
301
|
+
# @!attribute [rw] domain_name
|
|
302
|
+
# The name of the domain to export.
|
|
303
|
+
# @return [String]
|
|
304
|
+
#
|
|
305
|
+
# @!attribute [rw] s3_bucket
|
|
306
|
+
# The name of the S3 bucket where the domain data will be exported.
|
|
307
|
+
# @return [String]
|
|
308
|
+
#
|
|
309
|
+
# @!attribute [rw] s3_key_prefix
|
|
310
|
+
# The prefix string to be used to generate the S3 object keys for
|
|
311
|
+
# export artifacts.
|
|
312
|
+
# @return [String]
|
|
313
|
+
#
|
|
314
|
+
# @!attribute [rw] s3_sse_algorithm
|
|
315
|
+
# The server-side encryption algorithm to use for the exported data in
|
|
316
|
+
# S3. Valid values are: AES256 (SSE-S3) and KMS (SSE-KMS). If not
|
|
317
|
+
# specified, bucket's default encryption will apply.
|
|
318
|
+
# @return [String]
|
|
319
|
+
#
|
|
320
|
+
# @!attribute [rw] s3_sse_kms_key_id
|
|
321
|
+
# The KMS key ID to use for server-side encryption with AWS
|
|
322
|
+
# KMS-managed keys (SSE-KMS). This parameter is only expected with KMS
|
|
323
|
+
# as the S3 SSE algorithm.
|
|
324
|
+
# @return [String]
|
|
325
|
+
#
|
|
326
|
+
# @!attribute [rw] s3_bucket_owner
|
|
327
|
+
# The ID of the AWS account that owns the bucket the export will be
|
|
328
|
+
# stored in.
|
|
329
|
+
# @return [String]
|
|
330
|
+
#
|
|
331
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/simpledbv2-2025-09-26/StartDomainExportRequest AWS API Documentation
|
|
332
|
+
#
|
|
333
|
+
class StartDomainExportRequest < Struct.new(
|
|
334
|
+
:client_token,
|
|
335
|
+
:domain_name,
|
|
336
|
+
:s3_bucket,
|
|
337
|
+
:s3_key_prefix,
|
|
338
|
+
:s3_sse_algorithm,
|
|
339
|
+
:s3_sse_kms_key_id,
|
|
340
|
+
:s3_bucket_owner)
|
|
341
|
+
SENSITIVE = []
|
|
342
|
+
include Aws::Structure
|
|
343
|
+
end
|
|
344
|
+
|
|
345
|
+
# @!attribute [rw] client_token
|
|
346
|
+
# The client token that was provided in the request.
|
|
347
|
+
# @return [String]
|
|
348
|
+
#
|
|
349
|
+
# @!attribute [rw] export_arn
|
|
350
|
+
# Unique ARN identifier of the export.
|
|
351
|
+
# @return [String]
|
|
352
|
+
#
|
|
353
|
+
# @!attribute [rw] requested_at
|
|
354
|
+
# Timestamp when the export request was received by the service.
|
|
355
|
+
# @return [Time]
|
|
356
|
+
#
|
|
357
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/simpledbv2-2025-09-26/StartDomainExportResponse AWS API Documentation
|
|
358
|
+
#
|
|
359
|
+
class StartDomainExportResponse < Struct.new(
|
|
360
|
+
:client_token,
|
|
361
|
+
:export_arn,
|
|
362
|
+
:requested_at)
|
|
363
|
+
SENSITIVE = []
|
|
364
|
+
include Aws::Structure
|
|
365
|
+
end
|
|
366
|
+
|
|
367
|
+
end
|
|
368
|
+
end
|
|
369
|
+
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
|
4
|
+
#
|
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
|
+
#
|
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
|
9
|
+
|
|
10
|
+
require 'aws-sdk-core/waiters'
|
|
11
|
+
|
|
12
|
+
module Aws::SimpleDBv2
|
|
13
|
+
# Waiters are utility methods that poll for a particular state to occur
|
|
14
|
+
# on a client. Waiters can fail after a number of attempts at a polling
|
|
15
|
+
# interval defined for the service client.
|
|
16
|
+
#
|
|
17
|
+
# For a list of operations that can be waited for and the
|
|
18
|
+
# client methods called for each operation, see the table below or the
|
|
19
|
+
# {Client#wait_until} field documentation for the {Client}.
|
|
20
|
+
#
|
|
21
|
+
# # Invoking a Waiter
|
|
22
|
+
# To invoke a waiter, call #wait_until on a {Client}. The first parameter
|
|
23
|
+
# is the waiter name, which is specific to the service client and indicates
|
|
24
|
+
# which operation is being waited for. The second parameter is a hash of
|
|
25
|
+
# parameters that are passed to the client method called by the waiter,
|
|
26
|
+
# which varies according to the waiter name.
|
|
27
|
+
#
|
|
28
|
+
# # Wait Failures
|
|
29
|
+
# To catch errors in a waiter, use WaiterFailed,
|
|
30
|
+
# as shown in the following example.
|
|
31
|
+
#
|
|
32
|
+
# rescue rescue Aws::Waiters::Errors::WaiterFailed => error
|
|
33
|
+
# puts "failed waiting for instance running: #{error.message}
|
|
34
|
+
# end
|
|
35
|
+
#
|
|
36
|
+
# # Configuring a Waiter
|
|
37
|
+
# Each waiter has a default polling interval and a maximum number of
|
|
38
|
+
# attempts it will make before returning control to your program.
|
|
39
|
+
# To set these values, use the `max_attempts` and `delay` parameters
|
|
40
|
+
# in your `#wait_until` call.
|
|
41
|
+
# The following example waits for up to 25 seconds, polling every five seconds.
|
|
42
|
+
#
|
|
43
|
+
# client.wait_until(...) do |w|
|
|
44
|
+
# w.max_attempts = 5
|
|
45
|
+
# w.delay = 5
|
|
46
|
+
# end
|
|
47
|
+
#
|
|
48
|
+
# To disable wait failures, set the value of either of these parameters
|
|
49
|
+
# to `nil`.
|
|
50
|
+
#
|
|
51
|
+
# # Extending a Waiter
|
|
52
|
+
# To modify the behavior of waiters, you can register callbacks that are
|
|
53
|
+
# triggered before each polling attempt and before waiting.
|
|
54
|
+
#
|
|
55
|
+
# The following example implements an exponential backoff in a waiter
|
|
56
|
+
# by doubling the amount of time to wait on every attempt.
|
|
57
|
+
#
|
|
58
|
+
# client.wait_until(...) do |w|
|
|
59
|
+
# w.interval = 0 # disable normal sleep
|
|
60
|
+
# w.before_wait do |n, resp|
|
|
61
|
+
# sleep(n ** 2)
|
|
62
|
+
# end
|
|
63
|
+
# end
|
|
64
|
+
#
|
|
65
|
+
# # Available Waiters
|
|
66
|
+
#
|
|
67
|
+
# The following table lists the valid waiter names, the operations they call,
|
|
68
|
+
# and the default `:delay` and `:max_attempts` values.
|
|
69
|
+
#
|
|
70
|
+
# | waiter_name | params | :delay | :max_attempts |
|
|
71
|
+
# | ---------------- | ------------------- | -------- | ------------- |
|
|
72
|
+
# | export_succeeded | {Client#get_export} | 30 | 5 |
|
|
73
|
+
#
|
|
74
|
+
module Waiters
|
|
75
|
+
|
|
76
|
+
class ExportSucceeded
|
|
77
|
+
|
|
78
|
+
# @param [Hash] options
|
|
79
|
+
# @option options [required, Client] :client
|
|
80
|
+
# @option options [Integer] :max_attempts (5)
|
|
81
|
+
# @option options [Integer] :delay (30)
|
|
82
|
+
# @option options [Proc] :before_attempt
|
|
83
|
+
# @option options [Proc] :before_wait
|
|
84
|
+
def initialize(options)
|
|
85
|
+
@client = options.fetch(:client)
|
|
86
|
+
@waiter = Aws::Waiters::Waiter.new({
|
|
87
|
+
max_attempts: 5,
|
|
88
|
+
delay: 30,
|
|
89
|
+
poller: Aws::Waiters::Poller.new(
|
|
90
|
+
operation_name: :get_export,
|
|
91
|
+
acceptors: [
|
|
92
|
+
{
|
|
93
|
+
"matcher" => "path",
|
|
94
|
+
"argument" => "export_status",
|
|
95
|
+
"state" => "success",
|
|
96
|
+
"expected" => "SUCCEEDED"
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"matcher" => "path",
|
|
100
|
+
"argument" => "export_status",
|
|
101
|
+
"state" => "failure",
|
|
102
|
+
"expected" => "FAILED"
|
|
103
|
+
}
|
|
104
|
+
]
|
|
105
|
+
)
|
|
106
|
+
}.merge(options))
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
# @option (see Client#get_export)
|
|
110
|
+
# @return (see Client#get_export)
|
|
111
|
+
def wait(params = {})
|
|
112
|
+
@waiter.wait(client: @client, params: params)
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
# @api private
|
|
116
|
+
attr_reader :waiter
|
|
117
|
+
|
|
118
|
+
end
|
|
119
|
+
end
|
|
120
|
+
end
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
|
4
|
+
#
|
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
|
+
#
|
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
require 'aws-sdk-core'
|
|
12
|
+
require 'aws-sigv4'
|
|
13
|
+
|
|
14
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:simpledbv2)
|
|
15
|
+
|
|
16
|
+
# This module provides support for Amazon SimpleDB v2. This module is available in the
|
|
17
|
+
# `aws-sdk-simpledbv2` gem.
|
|
18
|
+
#
|
|
19
|
+
# # Client
|
|
20
|
+
#
|
|
21
|
+
# The {Client} class provides one method for each API operation. Operation
|
|
22
|
+
# methods each accept a hash of request parameters and return a response
|
|
23
|
+
# structure.
|
|
24
|
+
#
|
|
25
|
+
# simple_d_bv_2 = Aws::SimpleDBv2::Client.new
|
|
26
|
+
# resp = simple_d_bv_2.get_export(params)
|
|
27
|
+
#
|
|
28
|
+
# See {Client} for more information.
|
|
29
|
+
#
|
|
30
|
+
# # Errors
|
|
31
|
+
#
|
|
32
|
+
# Errors returned from Amazon SimpleDB v2 are defined in the
|
|
33
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
|
34
|
+
#
|
|
35
|
+
# begin
|
|
36
|
+
# # do stuff
|
|
37
|
+
# rescue Aws::SimpleDBv2::Errors::ServiceError
|
|
38
|
+
# # rescues all Amazon SimpleDB v2 API errors
|
|
39
|
+
# end
|
|
40
|
+
#
|
|
41
|
+
# See {Errors} for more information.
|
|
42
|
+
#
|
|
43
|
+
# @!group service
|
|
44
|
+
module Aws::SimpleDBv2
|
|
45
|
+
autoload :Types, 'aws-sdk-simpledbv2/types'
|
|
46
|
+
autoload :ClientApi, 'aws-sdk-simpledbv2/client_api'
|
|
47
|
+
module Plugins
|
|
48
|
+
autoload :Endpoints, 'aws-sdk-simpledbv2/plugins/endpoints.rb'
|
|
49
|
+
end
|
|
50
|
+
autoload :Client, 'aws-sdk-simpledbv2/client'
|
|
51
|
+
autoload :Errors, 'aws-sdk-simpledbv2/errors'
|
|
52
|
+
autoload :Waiters, 'aws-sdk-simpledbv2/waiters'
|
|
53
|
+
autoload :Resource, 'aws-sdk-simpledbv2/resource'
|
|
54
|
+
autoload :EndpointParameters, 'aws-sdk-simpledbv2/endpoint_parameters'
|
|
55
|
+
autoload :EndpointProvider, 'aws-sdk-simpledbv2/endpoint_provider'
|
|
56
|
+
autoload :Endpoints, 'aws-sdk-simpledbv2/endpoints'
|
|
57
|
+
|
|
58
|
+
GEM_VERSION = '1.0.0'
|
|
59
|
+
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
require_relative 'aws-sdk-simpledbv2/customizations'
|
data/sig/client.rbs
ADDED
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
|
2
|
+
#
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
5
|
+
#
|
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
|
7
|
+
|
|
8
|
+
module Aws
|
|
9
|
+
module SimpleDBv2
|
|
10
|
+
class Client < ::Seahorse::Client::Base
|
|
11
|
+
include ::Aws::ClientStubs
|
|
12
|
+
|
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SimpleDBv2/Client.html#initialize-instance_method
|
|
14
|
+
def self.new: (
|
|
15
|
+
?credentials: untyped,
|
|
16
|
+
?region: String,
|
|
17
|
+
?access_key_id: String,
|
|
18
|
+
?account_id: String,
|
|
19
|
+
?active_endpoint_cache: bool,
|
|
20
|
+
?adaptive_retry_wait_to_fill: bool,
|
|
21
|
+
?auth_scheme_preference: Array[String],
|
|
22
|
+
?client_side_monitoring: bool,
|
|
23
|
+
?client_side_monitoring_client_id: String,
|
|
24
|
+
?client_side_monitoring_host: String,
|
|
25
|
+
?client_side_monitoring_port: Integer,
|
|
26
|
+
?client_side_monitoring_publisher: untyped,
|
|
27
|
+
?convert_params: bool,
|
|
28
|
+
?correct_clock_skew: bool,
|
|
29
|
+
?defaults_mode: String,
|
|
30
|
+
?disable_host_prefix_injection: bool,
|
|
31
|
+
?disable_request_compression: bool,
|
|
32
|
+
?endpoint: String,
|
|
33
|
+
?endpoint_cache_max_entries: Integer,
|
|
34
|
+
?endpoint_cache_max_threads: Integer,
|
|
35
|
+
?endpoint_cache_poll_interval: Integer,
|
|
36
|
+
?endpoint_discovery: bool,
|
|
37
|
+
?ignore_configured_endpoint_urls: bool,
|
|
38
|
+
?log_formatter: untyped,
|
|
39
|
+
?log_level: Symbol,
|
|
40
|
+
?logger: untyped,
|
|
41
|
+
?max_attempts: Integer,
|
|
42
|
+
?profile: String,
|
|
43
|
+
?request_checksum_calculation: String,
|
|
44
|
+
?request_min_compression_size_bytes: Integer,
|
|
45
|
+
?response_checksum_validation: String,
|
|
46
|
+
?retry_backoff: Proc,
|
|
47
|
+
?retry_base_delay: Float,
|
|
48
|
+
?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
|
|
49
|
+
?retry_limit: Integer,
|
|
50
|
+
?retry_max_delay: Integer,
|
|
51
|
+
?retry_mode: ("legacy" | "standard" | "adaptive"),
|
|
52
|
+
?sdk_ua_app_id: String,
|
|
53
|
+
?secret_access_key: String,
|
|
54
|
+
?session_token: String,
|
|
55
|
+
?sigv4a_signing_region_set: Array[String],
|
|
56
|
+
?stub_responses: untyped,
|
|
57
|
+
?telemetry_provider: Aws::Telemetry::TelemetryProviderBase,
|
|
58
|
+
?token_provider: untyped,
|
|
59
|
+
?use_dualstack_endpoint: bool,
|
|
60
|
+
?use_fips_endpoint: bool,
|
|
61
|
+
?validate_params: bool,
|
|
62
|
+
?endpoint_provider: untyped,
|
|
63
|
+
?http_proxy: String,
|
|
64
|
+
?http_open_timeout: (Float | Integer),
|
|
65
|
+
?http_read_timeout: (Float | Integer),
|
|
66
|
+
?http_idle_timeout: (Float | Integer),
|
|
67
|
+
?http_continue_timeout: (Float | Integer),
|
|
68
|
+
?ssl_timeout: (Float | Integer | nil),
|
|
69
|
+
?http_wire_trace: bool,
|
|
70
|
+
?ssl_verify_peer: bool,
|
|
71
|
+
?ssl_ca_bundle: String,
|
|
72
|
+
?ssl_ca_directory: String,
|
|
73
|
+
?ssl_ca_store: String,
|
|
74
|
+
?on_chunk_received: Proc,
|
|
75
|
+
?on_chunk_sent: Proc,
|
|
76
|
+
?raise_response_errors: bool
|
|
77
|
+
) -> instance
|
|
78
|
+
| (?Hash[Symbol, untyped]) -> instance
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
interface _GetExportResponseSuccess
|
|
82
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetExportResponse]
|
|
83
|
+
def export_arn: () -> ::String
|
|
84
|
+
def client_token: () -> ::String
|
|
85
|
+
def export_status: () -> ("PENDING" | "IN_PROGRESS" | "SUCCEEDED" | "FAILED")
|
|
86
|
+
def domain_name: () -> ::String
|
|
87
|
+
def requested_at: () -> ::Time
|
|
88
|
+
def s3_bucket: () -> ::String
|
|
89
|
+
def s3_key_prefix: () -> ::String
|
|
90
|
+
def s3_sse_algorithm: () -> ("AES256" | "KMS")
|
|
91
|
+
def s3_sse_kms_key_id: () -> ::String
|
|
92
|
+
def s3_bucket_owner: () -> ::String
|
|
93
|
+
def failure_code: () -> ::String
|
|
94
|
+
def failure_message: () -> ::String
|
|
95
|
+
def export_manifest: () -> ::String
|
|
96
|
+
def items_count: () -> ::Integer
|
|
97
|
+
def export_data_cutoff_time: () -> ::Time
|
|
98
|
+
end
|
|
99
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SimpleDBv2/Client.html#get_export-instance_method
|
|
100
|
+
def get_export: (
|
|
101
|
+
export_arn: ::String
|
|
102
|
+
) -> _GetExportResponseSuccess
|
|
103
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetExportResponseSuccess
|
|
104
|
+
|
|
105
|
+
interface _ListExportsResponseSuccess
|
|
106
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListExportsResponse]
|
|
107
|
+
def export_summaries: () -> ::Array[Types::ExportSummary]
|
|
108
|
+
def next_token: () -> ::String
|
|
109
|
+
end
|
|
110
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SimpleDBv2/Client.html#list_exports-instance_method
|
|
111
|
+
def list_exports: (
|
|
112
|
+
?domain_name: ::String,
|
|
113
|
+
?max_results: ::Integer,
|
|
114
|
+
?next_token: ::String
|
|
115
|
+
) -> _ListExportsResponseSuccess
|
|
116
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListExportsResponseSuccess
|
|
117
|
+
|
|
118
|
+
interface _StartDomainExportResponseSuccess
|
|
119
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartDomainExportResponse]
|
|
120
|
+
def client_token: () -> ::String
|
|
121
|
+
def export_arn: () -> ::String
|
|
122
|
+
def requested_at: () -> ::Time
|
|
123
|
+
end
|
|
124
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SimpleDBv2/Client.html#start_domain_export-instance_method
|
|
125
|
+
def start_domain_export: (
|
|
126
|
+
?client_token: ::String,
|
|
127
|
+
domain_name: ::String,
|
|
128
|
+
s3_bucket: ::String,
|
|
129
|
+
?s3_key_prefix: ::String,
|
|
130
|
+
?s3_sse_algorithm: ("AES256" | "KMS"),
|
|
131
|
+
?s3_sse_kms_key_id: ::String,
|
|
132
|
+
?s3_bucket_owner: ::String
|
|
133
|
+
) -> _StartDomainExportResponseSuccess
|
|
134
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartDomainExportResponseSuccess
|
|
135
|
+
|
|
136
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SimpleDBv2/Client.html#wait_until-instance_method
|
|
137
|
+
def wait_until: (:export_succeeded waiter_name,
|
|
138
|
+
export_arn: ::String
|
|
139
|
+
) -> Client::_GetExportResponseSuccess
|
|
140
|
+
| (:export_succeeded waiter_name, Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> Client::_GetExportResponseSuccess
|
|
141
|
+
end
|
|
142
|
+
end
|
|
143
|
+
end
|
|
144
|
+
|