aws-sdk-recyclebin 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-recyclebin/client.rb +761 -0
- data/lib/aws-sdk-recyclebin/client_api.rb +291 -0
- data/lib/aws-sdk-recyclebin/customizations.rb +0 -0
- data/lib/aws-sdk-recyclebin/errors.rb +117 -0
- data/lib/aws-sdk-recyclebin/resource.rb +26 -0
- data/lib/aws-sdk-recyclebin/types.rb +652 -0
- data/lib/aws-sdk-recyclebin.rb +53 -0
- metadata +90 -0
@@ -0,0 +1,652 @@
|
|
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::RecycleBin
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# @note When making an API call, you may pass CreateRuleRequest
|
14
|
+
# data as a hash:
|
15
|
+
#
|
16
|
+
# {
|
17
|
+
# retention_period: { # required
|
18
|
+
# retention_period_value: 1, # required
|
19
|
+
# retention_period_unit: "DAYS", # required, accepts DAYS
|
20
|
+
# },
|
21
|
+
# description: "Description",
|
22
|
+
# tags: [
|
23
|
+
# {
|
24
|
+
# key: "TagKey", # required
|
25
|
+
# value: "TagValue", # required
|
26
|
+
# },
|
27
|
+
# ],
|
28
|
+
# resource_type: "EBS_SNAPSHOT", # required, accepts EBS_SNAPSHOT
|
29
|
+
# resource_tags: [
|
30
|
+
# {
|
31
|
+
# resource_tag_key: "ResourceTagKey", # required
|
32
|
+
# resource_tag_value: "ResourceTagValue",
|
33
|
+
# },
|
34
|
+
# ],
|
35
|
+
# }
|
36
|
+
#
|
37
|
+
# @!attribute [rw] retention_period
|
38
|
+
# Information about the retention period for which the retention rule
|
39
|
+
# is to retain resources.
|
40
|
+
# @return [Types::RetentionPeriod]
|
41
|
+
#
|
42
|
+
# @!attribute [rw] description
|
43
|
+
# A brief description for the retention rule.
|
44
|
+
# @return [String]
|
45
|
+
#
|
46
|
+
# @!attribute [rw] tags
|
47
|
+
# Information about the tags to assign to the retention rule.
|
48
|
+
# @return [Array<Types::Tag>]
|
49
|
+
#
|
50
|
+
# @!attribute [rw] resource_type
|
51
|
+
# The resource type to be retained by the retention rule. Currently,
|
52
|
+
# only Amazon EBS snapshots are supported.
|
53
|
+
# @return [String]
|
54
|
+
#
|
55
|
+
# @!attribute [rw] resource_tags
|
56
|
+
# Information about the resource tags to use to identify resources
|
57
|
+
# that are to be retained by the retention rule. The retention rule
|
58
|
+
# retains only deleted snapshots that have one or more of the
|
59
|
+
# specified tag key and value pairs. If a snapshot is deleted, but it
|
60
|
+
# does not have any of the specified tag key and value pairs, it is
|
61
|
+
# immediately deleted without being retained by the retention rule.
|
62
|
+
#
|
63
|
+
# You can add the same tag key and value pair to a maximum or five
|
64
|
+
# retention rules.
|
65
|
+
# @return [Array<Types::ResourceTag>]
|
66
|
+
#
|
67
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/CreateRuleRequest AWS API Documentation
|
68
|
+
#
|
69
|
+
class CreateRuleRequest < Struct.new(
|
70
|
+
:retention_period,
|
71
|
+
:description,
|
72
|
+
:tags,
|
73
|
+
:resource_type,
|
74
|
+
:resource_tags)
|
75
|
+
SENSITIVE = []
|
76
|
+
include Aws::Structure
|
77
|
+
end
|
78
|
+
|
79
|
+
# @!attribute [rw] identifier
|
80
|
+
# The unique identifier of the retention rule.
|
81
|
+
# @return [String]
|
82
|
+
#
|
83
|
+
# @!attribute [rw] retention_period
|
84
|
+
# Information about the retention period for which a retention rule is
|
85
|
+
# to retain resources.
|
86
|
+
# @return [Types::RetentionPeriod]
|
87
|
+
#
|
88
|
+
# @!attribute [rw] description
|
89
|
+
# The retention rule description.
|
90
|
+
# @return [String]
|
91
|
+
#
|
92
|
+
# @!attribute [rw] tags
|
93
|
+
# The tags assigned to the retention rule.
|
94
|
+
# @return [Array<Types::Tag>]
|
95
|
+
#
|
96
|
+
# @!attribute [rw] resource_type
|
97
|
+
# The resource type retained by the retention rule.
|
98
|
+
# @return [String]
|
99
|
+
#
|
100
|
+
# @!attribute [rw] resource_tags
|
101
|
+
# Information about the resource tags used to identify resources that
|
102
|
+
# are retained by the retention rule.
|
103
|
+
# @return [Array<Types::ResourceTag>]
|
104
|
+
#
|
105
|
+
# @!attribute [rw] status
|
106
|
+
# The state of the retention rule. Only retention rules that are in
|
107
|
+
# the `available` state retain snapshots.
|
108
|
+
# @return [String]
|
109
|
+
#
|
110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/CreateRuleResponse AWS API Documentation
|
111
|
+
#
|
112
|
+
class CreateRuleResponse < Struct.new(
|
113
|
+
:identifier,
|
114
|
+
:retention_period,
|
115
|
+
:description,
|
116
|
+
:tags,
|
117
|
+
:resource_type,
|
118
|
+
:resource_tags,
|
119
|
+
:status)
|
120
|
+
SENSITIVE = []
|
121
|
+
include Aws::Structure
|
122
|
+
end
|
123
|
+
|
124
|
+
# @note When making an API call, you may pass DeleteRuleRequest
|
125
|
+
# data as a hash:
|
126
|
+
#
|
127
|
+
# {
|
128
|
+
# identifier: "RuleIdentifier", # required
|
129
|
+
# }
|
130
|
+
#
|
131
|
+
# @!attribute [rw] identifier
|
132
|
+
# The unique ID of the retention rule to delete.
|
133
|
+
# @return [String]
|
134
|
+
#
|
135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/DeleteRuleRequest AWS API Documentation
|
136
|
+
#
|
137
|
+
class DeleteRuleRequest < Struct.new(
|
138
|
+
:identifier)
|
139
|
+
SENSITIVE = []
|
140
|
+
include Aws::Structure
|
141
|
+
end
|
142
|
+
|
143
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/DeleteRuleResponse AWS API Documentation
|
144
|
+
#
|
145
|
+
class DeleteRuleResponse < Aws::EmptyStructure; end
|
146
|
+
|
147
|
+
# @note When making an API call, you may pass GetRuleRequest
|
148
|
+
# data as a hash:
|
149
|
+
#
|
150
|
+
# {
|
151
|
+
# identifier: "RuleIdentifier", # required
|
152
|
+
# }
|
153
|
+
#
|
154
|
+
# @!attribute [rw] identifier
|
155
|
+
# The unique ID of the retention rule.
|
156
|
+
# @return [String]
|
157
|
+
#
|
158
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/GetRuleRequest AWS API Documentation
|
159
|
+
#
|
160
|
+
class GetRuleRequest < Struct.new(
|
161
|
+
:identifier)
|
162
|
+
SENSITIVE = []
|
163
|
+
include Aws::Structure
|
164
|
+
end
|
165
|
+
|
166
|
+
# @!attribute [rw] identifier
|
167
|
+
# The unique ID of the retention rule.
|
168
|
+
# @return [String]
|
169
|
+
#
|
170
|
+
# @!attribute [rw] description
|
171
|
+
# The description assigned to the retention rule.
|
172
|
+
# @return [String]
|
173
|
+
#
|
174
|
+
# @!attribute [rw] resource_type
|
175
|
+
# The resource type retained by the retention rule. Currently, only
|
176
|
+
# Amazon EBS snapshots are supported.
|
177
|
+
# @return [String]
|
178
|
+
#
|
179
|
+
# @!attribute [rw] retention_period
|
180
|
+
# Information about the period for which the retention rule retains
|
181
|
+
# resources.
|
182
|
+
# @return [Types::RetentionPeriod]
|
183
|
+
#
|
184
|
+
# @!attribute [rw] resource_tags
|
185
|
+
# The resource tags used to identify resources that are to be retained
|
186
|
+
# by the retention rule.
|
187
|
+
# @return [Array<Types::ResourceTag>]
|
188
|
+
#
|
189
|
+
# @!attribute [rw] status
|
190
|
+
# The state of the retention rule. Only retention rules that are in
|
191
|
+
# the `available` state retain snapshots.
|
192
|
+
# @return [String]
|
193
|
+
#
|
194
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/GetRuleResponse AWS API Documentation
|
195
|
+
#
|
196
|
+
class GetRuleResponse < Struct.new(
|
197
|
+
:identifier,
|
198
|
+
:description,
|
199
|
+
:resource_type,
|
200
|
+
:retention_period,
|
201
|
+
:resource_tags,
|
202
|
+
:status)
|
203
|
+
SENSITIVE = []
|
204
|
+
include Aws::Structure
|
205
|
+
end
|
206
|
+
|
207
|
+
# The service could not respond to the request due to an internal
|
208
|
+
# problem.
|
209
|
+
#
|
210
|
+
# @!attribute [rw] message
|
211
|
+
# @return [String]
|
212
|
+
#
|
213
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/InternalServerException AWS API Documentation
|
214
|
+
#
|
215
|
+
class InternalServerException < Struct.new(
|
216
|
+
:message)
|
217
|
+
SENSITIVE = []
|
218
|
+
include Aws::Structure
|
219
|
+
end
|
220
|
+
|
221
|
+
# @note When making an API call, you may pass ListRulesRequest
|
222
|
+
# data as a hash:
|
223
|
+
#
|
224
|
+
# {
|
225
|
+
# max_results: 1,
|
226
|
+
# next_token: "NextToken",
|
227
|
+
# resource_type: "EBS_SNAPSHOT", # required, accepts EBS_SNAPSHOT
|
228
|
+
# resource_tags: [
|
229
|
+
# {
|
230
|
+
# resource_tag_key: "ResourceTagKey", # required
|
231
|
+
# resource_tag_value: "ResourceTagValue",
|
232
|
+
# },
|
233
|
+
# ],
|
234
|
+
# }
|
235
|
+
#
|
236
|
+
# @!attribute [rw] max_results
|
237
|
+
# The maximum number of results to return for the request in a single
|
238
|
+
# page. The remaining results can be seen by sending another request
|
239
|
+
# with the returned `nextToken` value. This value can be between 5 and
|
240
|
+
# 500. If `maxResults` is given a larger value than 500, you receive
|
241
|
+
# an error.
|
242
|
+
# @return [Integer]
|
243
|
+
#
|
244
|
+
# @!attribute [rw] next_token
|
245
|
+
# The token to use to retrieve the next page of results.
|
246
|
+
# @return [String]
|
247
|
+
#
|
248
|
+
# @!attribute [rw] resource_type
|
249
|
+
# The resource type retained by the retention rule. Only retention
|
250
|
+
# rules that retain the specified resource type are listed.
|
251
|
+
# @return [String]
|
252
|
+
#
|
253
|
+
# @!attribute [rw] resource_tags
|
254
|
+
# The tags used to identify resources that are to be retained by the
|
255
|
+
# retention rule.
|
256
|
+
# @return [Array<Types::ResourceTag>]
|
257
|
+
#
|
258
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ListRulesRequest AWS API Documentation
|
259
|
+
#
|
260
|
+
class ListRulesRequest < Struct.new(
|
261
|
+
:max_results,
|
262
|
+
:next_token,
|
263
|
+
:resource_type,
|
264
|
+
:resource_tags)
|
265
|
+
SENSITIVE = []
|
266
|
+
include Aws::Structure
|
267
|
+
end
|
268
|
+
|
269
|
+
# @!attribute [rw] rules
|
270
|
+
# Information about the retention rules.
|
271
|
+
# @return [Array<Types::RuleSummary>]
|
272
|
+
#
|
273
|
+
# @!attribute [rw] next_token
|
274
|
+
# The token to use to retrieve the next page of results. This value is
|
275
|
+
# `null` when there are no more results to return.
|
276
|
+
# @return [String]
|
277
|
+
#
|
278
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ListRulesResponse AWS API Documentation
|
279
|
+
#
|
280
|
+
class ListRulesResponse < Struct.new(
|
281
|
+
:rules,
|
282
|
+
:next_token)
|
283
|
+
SENSITIVE = []
|
284
|
+
include Aws::Structure
|
285
|
+
end
|
286
|
+
|
287
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
288
|
+
# data as a hash:
|
289
|
+
#
|
290
|
+
# {
|
291
|
+
# resource_arn: "RuleArn", # required
|
292
|
+
# }
|
293
|
+
#
|
294
|
+
# @!attribute [rw] resource_arn
|
295
|
+
# The Amazon Resource Name (ARN) of the resource for which to list the
|
296
|
+
# tags.
|
297
|
+
# @return [String]
|
298
|
+
#
|
299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ListTagsForResourceRequest AWS API Documentation
|
300
|
+
#
|
301
|
+
class ListTagsForResourceRequest < Struct.new(
|
302
|
+
:resource_arn)
|
303
|
+
SENSITIVE = []
|
304
|
+
include Aws::Structure
|
305
|
+
end
|
306
|
+
|
307
|
+
# @!attribute [rw] tags
|
308
|
+
# Information about the tags assigned to the resource.
|
309
|
+
# @return [Array<Types::Tag>]
|
310
|
+
#
|
311
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ListTagsForResourceResponse AWS API Documentation
|
312
|
+
#
|
313
|
+
class ListTagsForResourceResponse < Struct.new(
|
314
|
+
:tags)
|
315
|
+
SENSITIVE = []
|
316
|
+
include Aws::Structure
|
317
|
+
end
|
318
|
+
|
319
|
+
# The specified resource was not found.
|
320
|
+
#
|
321
|
+
# @!attribute [rw] message
|
322
|
+
# @return [String]
|
323
|
+
#
|
324
|
+
# @!attribute [rw] reason
|
325
|
+
# The reason for the exception.
|
326
|
+
# @return [String]
|
327
|
+
#
|
328
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ResourceNotFoundException AWS API Documentation
|
329
|
+
#
|
330
|
+
class ResourceNotFoundException < Struct.new(
|
331
|
+
:message,
|
332
|
+
:reason)
|
333
|
+
SENSITIVE = []
|
334
|
+
include Aws::Structure
|
335
|
+
end
|
336
|
+
|
337
|
+
# Information about a resource tag used to identify resources that are
|
338
|
+
# to be retained by a Recycle Bin retention rule.
|
339
|
+
#
|
340
|
+
# @note When making an API call, you may pass ResourceTag
|
341
|
+
# data as a hash:
|
342
|
+
#
|
343
|
+
# {
|
344
|
+
# resource_tag_key: "ResourceTagKey", # required
|
345
|
+
# resource_tag_value: "ResourceTagValue",
|
346
|
+
# }
|
347
|
+
#
|
348
|
+
# @!attribute [rw] resource_tag_key
|
349
|
+
# The tag key.
|
350
|
+
# @return [String]
|
351
|
+
#
|
352
|
+
# @!attribute [rw] resource_tag_value
|
353
|
+
# The tag value.
|
354
|
+
# @return [String]
|
355
|
+
#
|
356
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ResourceTag AWS API Documentation
|
357
|
+
#
|
358
|
+
class ResourceTag < Struct.new(
|
359
|
+
:resource_tag_key,
|
360
|
+
:resource_tag_value)
|
361
|
+
SENSITIVE = []
|
362
|
+
include Aws::Structure
|
363
|
+
end
|
364
|
+
|
365
|
+
# Information about the retention period for which a retention rule is
|
366
|
+
# to retain resources.
|
367
|
+
#
|
368
|
+
# @note When making an API call, you may pass RetentionPeriod
|
369
|
+
# data as a hash:
|
370
|
+
#
|
371
|
+
# {
|
372
|
+
# retention_period_value: 1, # required
|
373
|
+
# retention_period_unit: "DAYS", # required, accepts DAYS
|
374
|
+
# }
|
375
|
+
#
|
376
|
+
# @!attribute [rw] retention_period_value
|
377
|
+
# The period value for which the retention rule is to retain
|
378
|
+
# resources. The period is measured using the unit specified for
|
379
|
+
# **RetentionPeriodUnit**.
|
380
|
+
# @return [Integer]
|
381
|
+
#
|
382
|
+
# @!attribute [rw] retention_period_unit
|
383
|
+
# The unit of time in which the retention period is measured.
|
384
|
+
# Currently, only `DAYS` is supported.
|
385
|
+
# @return [String]
|
386
|
+
#
|
387
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/RetentionPeriod AWS API Documentation
|
388
|
+
#
|
389
|
+
class RetentionPeriod < Struct.new(
|
390
|
+
:retention_period_value,
|
391
|
+
:retention_period_unit)
|
392
|
+
SENSITIVE = []
|
393
|
+
include Aws::Structure
|
394
|
+
end
|
395
|
+
|
396
|
+
# Information about a Recycle Bin retention rule.
|
397
|
+
#
|
398
|
+
# @!attribute [rw] identifier
|
399
|
+
# The unique ID of the retention rule.
|
400
|
+
# @return [String]
|
401
|
+
#
|
402
|
+
# @!attribute [rw] description
|
403
|
+
# The description for the retention rule.
|
404
|
+
# @return [String]
|
405
|
+
#
|
406
|
+
# @!attribute [rw] retention_period
|
407
|
+
# Information about the retention period for which the retention rule
|
408
|
+
# retains resources
|
409
|
+
# @return [Types::RetentionPeriod]
|
410
|
+
#
|
411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/RuleSummary AWS API Documentation
|
412
|
+
#
|
413
|
+
class RuleSummary < Struct.new(
|
414
|
+
:identifier,
|
415
|
+
:description,
|
416
|
+
:retention_period)
|
417
|
+
SENSITIVE = []
|
418
|
+
include Aws::Structure
|
419
|
+
end
|
420
|
+
|
421
|
+
# The request would cause a service quota for the number of tags per
|
422
|
+
# resource to be exceeded.
|
423
|
+
#
|
424
|
+
# @!attribute [rw] message
|
425
|
+
# @return [String]
|
426
|
+
#
|
427
|
+
# @!attribute [rw] reason
|
428
|
+
# The reason for the exception.
|
429
|
+
# @return [String]
|
430
|
+
#
|
431
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ServiceQuotaExceededException AWS API Documentation
|
432
|
+
#
|
433
|
+
class ServiceQuotaExceededException < Struct.new(
|
434
|
+
:message,
|
435
|
+
:reason)
|
436
|
+
SENSITIVE = []
|
437
|
+
include Aws::Structure
|
438
|
+
end
|
439
|
+
|
440
|
+
# Information about the tags assigned to a Recycle Bin retention rule.
|
441
|
+
#
|
442
|
+
# @note When making an API call, you may pass Tag
|
443
|
+
# data as a hash:
|
444
|
+
#
|
445
|
+
# {
|
446
|
+
# key: "TagKey", # required
|
447
|
+
# value: "TagValue", # required
|
448
|
+
# }
|
449
|
+
#
|
450
|
+
# @!attribute [rw] key
|
451
|
+
# The tag key.
|
452
|
+
# @return [String]
|
453
|
+
#
|
454
|
+
# @!attribute [rw] value
|
455
|
+
# The tag value.
|
456
|
+
# @return [String]
|
457
|
+
#
|
458
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/Tag AWS API Documentation
|
459
|
+
#
|
460
|
+
class Tag < Struct.new(
|
461
|
+
:key,
|
462
|
+
:value)
|
463
|
+
SENSITIVE = []
|
464
|
+
include Aws::Structure
|
465
|
+
end
|
466
|
+
|
467
|
+
# @note When making an API call, you may pass TagResourceRequest
|
468
|
+
# data as a hash:
|
469
|
+
#
|
470
|
+
# {
|
471
|
+
# resource_arn: "RuleArn", # required
|
472
|
+
# tags: [ # required
|
473
|
+
# {
|
474
|
+
# key: "TagKey", # required
|
475
|
+
# value: "TagValue", # required
|
476
|
+
# },
|
477
|
+
# ],
|
478
|
+
# }
|
479
|
+
#
|
480
|
+
# @!attribute [rw] resource_arn
|
481
|
+
# The Amazon Resource Name (ARN) of the resource to which to assign
|
482
|
+
# the tags.
|
483
|
+
# @return [String]
|
484
|
+
#
|
485
|
+
# @!attribute [rw] tags
|
486
|
+
# Information about the tags to assign to the resource.
|
487
|
+
# @return [Array<Types::Tag>]
|
488
|
+
#
|
489
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/TagResourceRequest AWS API Documentation
|
490
|
+
#
|
491
|
+
class TagResourceRequest < Struct.new(
|
492
|
+
:resource_arn,
|
493
|
+
:tags)
|
494
|
+
SENSITIVE = []
|
495
|
+
include Aws::Structure
|
496
|
+
end
|
497
|
+
|
498
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/TagResourceResponse AWS API Documentation
|
499
|
+
#
|
500
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
501
|
+
|
502
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
503
|
+
# data as a hash:
|
504
|
+
#
|
505
|
+
# {
|
506
|
+
# resource_arn: "RuleArn", # required
|
507
|
+
# tag_keys: ["TagKey"], # required
|
508
|
+
# }
|
509
|
+
#
|
510
|
+
# @!attribute [rw] resource_arn
|
511
|
+
# The Amazon Resource Name (ARN) of the resource from which to
|
512
|
+
# unassign the tags.
|
513
|
+
# @return [String]
|
514
|
+
#
|
515
|
+
# @!attribute [rw] tag_keys
|
516
|
+
# Information about the tags to unassign from the resource.
|
517
|
+
# @return [Array<String>]
|
518
|
+
#
|
519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UntagResourceRequest AWS API Documentation
|
520
|
+
#
|
521
|
+
class UntagResourceRequest < Struct.new(
|
522
|
+
:resource_arn,
|
523
|
+
:tag_keys)
|
524
|
+
SENSITIVE = []
|
525
|
+
include Aws::Structure
|
526
|
+
end
|
527
|
+
|
528
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UntagResourceResponse AWS API Documentation
|
529
|
+
#
|
530
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
531
|
+
|
532
|
+
# @note When making an API call, you may pass UpdateRuleRequest
|
533
|
+
# data as a hash:
|
534
|
+
#
|
535
|
+
# {
|
536
|
+
# identifier: "RuleIdentifier", # required
|
537
|
+
# retention_period: {
|
538
|
+
# retention_period_value: 1, # required
|
539
|
+
# retention_period_unit: "DAYS", # required, accepts DAYS
|
540
|
+
# },
|
541
|
+
# description: "Description",
|
542
|
+
# resource_type: "EBS_SNAPSHOT", # accepts EBS_SNAPSHOT
|
543
|
+
# resource_tags: [
|
544
|
+
# {
|
545
|
+
# resource_tag_key: "ResourceTagKey", # required
|
546
|
+
# resource_tag_value: "ResourceTagValue",
|
547
|
+
# },
|
548
|
+
# ],
|
549
|
+
# }
|
550
|
+
#
|
551
|
+
# @!attribute [rw] identifier
|
552
|
+
# The unique ID of the retention rule to update.
|
553
|
+
# @return [String]
|
554
|
+
#
|
555
|
+
# @!attribute [rw] retention_period
|
556
|
+
# Information about the retention period for which the retention rule
|
557
|
+
# is to retain resources.
|
558
|
+
# @return [Types::RetentionPeriod]
|
559
|
+
#
|
560
|
+
# @!attribute [rw] description
|
561
|
+
# The retention rule description.
|
562
|
+
# @return [String]
|
563
|
+
#
|
564
|
+
# @!attribute [rw] resource_type
|
565
|
+
# The resource type to be retained by the retention rule. Currently,
|
566
|
+
# only Amazon EBS snapshots are supported.
|
567
|
+
# @return [String]
|
568
|
+
#
|
569
|
+
# @!attribute [rw] resource_tags
|
570
|
+
# Information about the resource tags to use to identify resources
|
571
|
+
# that are to be retained by the retention rule. The retention rule
|
572
|
+
# retains only deleted snapshots that have one or more of the
|
573
|
+
# specified tag key and value pairs. If a snapshot is deleted, but it
|
574
|
+
# does not have any of the specified tag key and value pairs, it is
|
575
|
+
# immediately deleted without being retained by the retention rule.
|
576
|
+
#
|
577
|
+
# You can add the same tag key and value pair to a maximum or five
|
578
|
+
# retention rules.
|
579
|
+
# @return [Array<Types::ResourceTag>]
|
580
|
+
#
|
581
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UpdateRuleRequest AWS API Documentation
|
582
|
+
#
|
583
|
+
class UpdateRuleRequest < Struct.new(
|
584
|
+
:identifier,
|
585
|
+
:retention_period,
|
586
|
+
:description,
|
587
|
+
:resource_type,
|
588
|
+
:resource_tags)
|
589
|
+
SENSITIVE = []
|
590
|
+
include Aws::Structure
|
591
|
+
end
|
592
|
+
|
593
|
+
# @!attribute [rw] identifier
|
594
|
+
# The unique ID of the retention rule.
|
595
|
+
# @return [String]
|
596
|
+
#
|
597
|
+
# @!attribute [rw] retention_period
|
598
|
+
# Information about the retention period for which a retention rule is
|
599
|
+
# to retain resources.
|
600
|
+
# @return [Types::RetentionPeriod]
|
601
|
+
#
|
602
|
+
# @!attribute [rw] description
|
603
|
+
# The retention rule description.
|
604
|
+
# @return [String]
|
605
|
+
#
|
606
|
+
# @!attribute [rw] resource_type
|
607
|
+
# The resource type retained by the retention rule.
|
608
|
+
# @return [String]
|
609
|
+
#
|
610
|
+
# @!attribute [rw] resource_tags
|
611
|
+
# Information about the resource tags used to identify resources that
|
612
|
+
# are retained by the retention rule.
|
613
|
+
# @return [Array<Types::ResourceTag>]
|
614
|
+
#
|
615
|
+
# @!attribute [rw] status
|
616
|
+
# The state of the retention rule. Only retention rules that are in
|
617
|
+
# the `available` state retain snapshots.
|
618
|
+
# @return [String]
|
619
|
+
#
|
620
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UpdateRuleResponse AWS API Documentation
|
621
|
+
#
|
622
|
+
class UpdateRuleResponse < Struct.new(
|
623
|
+
:identifier,
|
624
|
+
:retention_period,
|
625
|
+
:description,
|
626
|
+
:resource_type,
|
627
|
+
:resource_tags,
|
628
|
+
:status)
|
629
|
+
SENSITIVE = []
|
630
|
+
include Aws::Structure
|
631
|
+
end
|
632
|
+
|
633
|
+
# One or more of the parameters in the request is not valid.
|
634
|
+
#
|
635
|
+
# @!attribute [rw] message
|
636
|
+
# @return [String]
|
637
|
+
#
|
638
|
+
# @!attribute [rw] reason
|
639
|
+
# The reason for the exception.
|
640
|
+
# @return [String]
|
641
|
+
#
|
642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ValidationException AWS API Documentation
|
643
|
+
#
|
644
|
+
class ValidationException < Struct.new(
|
645
|
+
:message,
|
646
|
+
:reason)
|
647
|
+
SENSITIVE = []
|
648
|
+
include Aws::Structure
|
649
|
+
end
|
650
|
+
|
651
|
+
end
|
652
|
+
end
|
@@ -0,0 +1,53 @@
|
|
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
|
+
require_relative 'aws-sdk-recyclebin/types'
|
15
|
+
require_relative 'aws-sdk-recyclebin/client_api'
|
16
|
+
require_relative 'aws-sdk-recyclebin/client'
|
17
|
+
require_relative 'aws-sdk-recyclebin/errors'
|
18
|
+
require_relative 'aws-sdk-recyclebin/resource'
|
19
|
+
require_relative 'aws-sdk-recyclebin/customizations'
|
20
|
+
|
21
|
+
# This module provides support for Amazon Recycle Bin. This module is available in the
|
22
|
+
# `aws-sdk-recyclebin` gem.
|
23
|
+
#
|
24
|
+
# # Client
|
25
|
+
#
|
26
|
+
# The {Client} class provides one method for each API operation. Operation
|
27
|
+
# methods each accept a hash of request parameters and return a response
|
28
|
+
# structure.
|
29
|
+
#
|
30
|
+
# recycle_bin = Aws::RecycleBin::Client.new
|
31
|
+
# resp = recycle_bin.create_rule(params)
|
32
|
+
#
|
33
|
+
# See {Client} for more information.
|
34
|
+
#
|
35
|
+
# # Errors
|
36
|
+
#
|
37
|
+
# Errors returned from Amazon Recycle Bin are defined in the
|
38
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
39
|
+
#
|
40
|
+
# begin
|
41
|
+
# # do stuff
|
42
|
+
# rescue Aws::RecycleBin::Errors::ServiceError
|
43
|
+
# # rescues all Amazon Recycle Bin API errors
|
44
|
+
# end
|
45
|
+
#
|
46
|
+
# See {Errors} for more information.
|
47
|
+
#
|
48
|
+
# @!group service
|
49
|
+
module Aws::RecycleBin
|
50
|
+
|
51
|
+
GEM_VERSION = '1.0.0'
|
52
|
+
|
53
|
+
end
|