aws-sdk-recyclebin 1.6.0 → 1.8.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 +4 -4
- data/CHANGELOG.md +12 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-recyclebin/client.rb +147 -8
- data/lib/aws-sdk-recyclebin/client_api.rb +87 -0
- data/lib/aws-sdk-recyclebin/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-recyclebin/endpoint_provider.rb +35 -95
- data/lib/aws-sdk-recyclebin/endpoints.rb +28 -0
- data/lib/aws-sdk-recyclebin/errors.rb +21 -0
- data/lib/aws-sdk-recyclebin/plugins/endpoints.rb +4 -0
- data/lib/aws-sdk-recyclebin/types.rb +351 -131
- data/lib/aws-sdk-recyclebin.rb +1 -1
- metadata +2 -2
@@ -10,30 +10,24 @@
|
|
10
10
|
module Aws::RecycleBin
|
11
11
|
module Types
|
12
12
|
|
13
|
-
#
|
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, EC2_IMAGE
|
29
|
-
# resource_tags: [
|
30
|
-
# {
|
31
|
-
# resource_tag_key: "ResourceTagKey", # required
|
32
|
-
# resource_tag_value: "ResourceTagValue",
|
33
|
-
# },
|
34
|
-
# ],
|
35
|
-
# }
|
13
|
+
# The specified retention rule lock request can't be completed.
|
36
14
|
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @!attribute [rw] reason
|
19
|
+
# The reason for the exception.
|
20
|
+
# @return [String]
|
21
|
+
#
|
22
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ConflictException AWS API Documentation
|
23
|
+
#
|
24
|
+
class ConflictException < Struct.new(
|
25
|
+
:message,
|
26
|
+
:reason)
|
27
|
+
SENSITIVE = []
|
28
|
+
include Aws::Structure
|
29
|
+
end
|
30
|
+
|
37
31
|
# @!attribute [rw] retention_period
|
38
32
|
# Information about the retention period for which the retention rule
|
39
33
|
# is to retain resources.
|
@@ -73,6 +67,10 @@ module Aws::RecycleBin
|
|
73
67
|
# the resources are not tagged.
|
74
68
|
# @return [Array<Types::ResourceTag>]
|
75
69
|
#
|
70
|
+
# @!attribute [rw] lock_configuration
|
71
|
+
# Information about the retention rule lock configuration.
|
72
|
+
# @return [Types::LockConfiguration]
|
73
|
+
#
|
76
74
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/CreateRuleRequest AWS API Documentation
|
77
75
|
#
|
78
76
|
class CreateRuleRequest < Struct.new(
|
@@ -80,7 +78,8 @@ module Aws::RecycleBin
|
|
80
78
|
:description,
|
81
79
|
:tags,
|
82
80
|
:resource_type,
|
83
|
-
:resource_tags
|
81
|
+
:resource_tags,
|
82
|
+
:lock_configuration)
|
84
83
|
SENSITIVE = []
|
85
84
|
include Aws::Structure
|
86
85
|
end
|
@@ -116,6 +115,30 @@ module Aws::RecycleBin
|
|
116
115
|
# the `available` state retain resources.
|
117
116
|
# @return [String]
|
118
117
|
#
|
118
|
+
# @!attribute [rw] lock_configuration
|
119
|
+
# Information about the retention rule lock configuration.
|
120
|
+
# @return [Types::LockConfiguration]
|
121
|
+
#
|
122
|
+
# @!attribute [rw] lock_state
|
123
|
+
# The lock state for the retention rule.
|
124
|
+
#
|
125
|
+
# * `locked` - The retention rule is locked and can't be modified or
|
126
|
+
# deleted.
|
127
|
+
#
|
128
|
+
# * `pending_unlock` - The retention rule has been unlocked but it is
|
129
|
+
# still within the unlock delay period. The retention rule can be
|
130
|
+
# modified or deleted only after the unlock delay period has
|
131
|
+
# expired.
|
132
|
+
#
|
133
|
+
# * `unlocked` - The retention rule is unlocked and it can be modified
|
134
|
+
# or deleted by any user with the required permissions.
|
135
|
+
#
|
136
|
+
# * `null` - The retention rule has never been locked. Once a
|
137
|
+
# retention rule has been locked, it can transition between the
|
138
|
+
# `locked` and `unlocked` states only; it can never transition back
|
139
|
+
# to `null`.
|
140
|
+
# @return [String]
|
141
|
+
#
|
119
142
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/CreateRuleResponse AWS API Documentation
|
120
143
|
#
|
121
144
|
class CreateRuleResponse < Struct.new(
|
@@ -125,18 +148,13 @@ module Aws::RecycleBin
|
|
125
148
|
:tags,
|
126
149
|
:resource_type,
|
127
150
|
:resource_tags,
|
128
|
-
:status
|
151
|
+
:status,
|
152
|
+
:lock_configuration,
|
153
|
+
:lock_state)
|
129
154
|
SENSITIVE = []
|
130
155
|
include Aws::Structure
|
131
156
|
end
|
132
157
|
|
133
|
-
# @note When making an API call, you may pass DeleteRuleRequest
|
134
|
-
# data as a hash:
|
135
|
-
#
|
136
|
-
# {
|
137
|
-
# identifier: "RuleIdentifier", # required
|
138
|
-
# }
|
139
|
-
#
|
140
158
|
# @!attribute [rw] identifier
|
141
159
|
# The unique ID of the retention rule.
|
142
160
|
# @return [String]
|
@@ -153,13 +171,6 @@ module Aws::RecycleBin
|
|
153
171
|
#
|
154
172
|
class DeleteRuleResponse < Aws::EmptyStructure; end
|
155
173
|
|
156
|
-
# @note When making an API call, you may pass GetRuleRequest
|
157
|
-
# data as a hash:
|
158
|
-
#
|
159
|
-
# {
|
160
|
-
# identifier: "RuleIdentifier", # required
|
161
|
-
# }
|
162
|
-
#
|
163
174
|
# @!attribute [rw] identifier
|
164
175
|
# The unique ID of the retention rule.
|
165
176
|
# @return [String]
|
@@ -199,6 +210,36 @@ module Aws::RecycleBin
|
|
199
210
|
# the `available` state retain resources.
|
200
211
|
# @return [String]
|
201
212
|
#
|
213
|
+
# @!attribute [rw] lock_configuration
|
214
|
+
# Information about the retention rule lock configuration.
|
215
|
+
# @return [Types::LockConfiguration]
|
216
|
+
#
|
217
|
+
# @!attribute [rw] lock_state
|
218
|
+
# The lock state for the retention rule.
|
219
|
+
#
|
220
|
+
# * `locked` - The retention rule is locked and can't be modified or
|
221
|
+
# deleted.
|
222
|
+
#
|
223
|
+
# * `pending_unlock` - The retention rule has been unlocked but it is
|
224
|
+
# still within the unlock delay period. The retention rule can be
|
225
|
+
# modified or deleted only after the unlock delay period has
|
226
|
+
# expired.
|
227
|
+
#
|
228
|
+
# * `unlocked` - The retention rule is unlocked and it can be modified
|
229
|
+
# or deleted by any user with the required permissions.
|
230
|
+
#
|
231
|
+
# * `null` - The retention rule has never been locked. Once a
|
232
|
+
# retention rule has been locked, it can transition between the
|
233
|
+
# `locked` and `unlocked` states only; it can never transition back
|
234
|
+
# to `null`.
|
235
|
+
# @return [String]
|
236
|
+
#
|
237
|
+
# @!attribute [rw] lock_end_time
|
238
|
+
# The date and time at which the unlock delay is set to expire. Only
|
239
|
+
# returned for retention rules that have been unlocked and that are
|
240
|
+
# still within the unlock delay period.
|
241
|
+
# @return [Time]
|
242
|
+
#
|
202
243
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/GetRuleResponse AWS API Documentation
|
203
244
|
#
|
204
245
|
class GetRuleResponse < Struct.new(
|
@@ -207,7 +248,10 @@ module Aws::RecycleBin
|
|
207
248
|
:resource_type,
|
208
249
|
:retention_period,
|
209
250
|
:resource_tags,
|
210
|
-
:status
|
251
|
+
:status,
|
252
|
+
:lock_configuration,
|
253
|
+
:lock_state,
|
254
|
+
:lock_end_time)
|
211
255
|
SENSITIVE = []
|
212
256
|
include Aws::Structure
|
213
257
|
end
|
@@ -226,21 +270,6 @@ module Aws::RecycleBin
|
|
226
270
|
include Aws::Structure
|
227
271
|
end
|
228
272
|
|
229
|
-
# @note When making an API call, you may pass ListRulesRequest
|
230
|
-
# data as a hash:
|
231
|
-
#
|
232
|
-
# {
|
233
|
-
# max_results: 1,
|
234
|
-
# next_token: "NextToken",
|
235
|
-
# resource_type: "EBS_SNAPSHOT", # required, accepts EBS_SNAPSHOT, EC2_IMAGE
|
236
|
-
# resource_tags: [
|
237
|
-
# {
|
238
|
-
# resource_tag_key: "ResourceTagKey", # required
|
239
|
-
# resource_tag_value: "ResourceTagValue",
|
240
|
-
# },
|
241
|
-
# ],
|
242
|
-
# }
|
243
|
-
#
|
244
273
|
# @!attribute [rw] max_results
|
245
274
|
# The maximum number of results to return with a single call. To
|
246
275
|
# retrieve the remaining results, make another call with the returned
|
@@ -265,13 +294,19 @@ module Aws::RecycleBin
|
|
265
294
|
# are retained by the retention rule.
|
266
295
|
# @return [Array<Types::ResourceTag>]
|
267
296
|
#
|
297
|
+
# @!attribute [rw] lock_state
|
298
|
+
# The lock state of the retention rules to list. Only retention rules
|
299
|
+
# with the specified lock state are returned.
|
300
|
+
# @return [String]
|
301
|
+
#
|
268
302
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ListRulesRequest AWS API Documentation
|
269
303
|
#
|
270
304
|
class ListRulesRequest < Struct.new(
|
271
305
|
:max_results,
|
272
306
|
:next_token,
|
273
307
|
:resource_type,
|
274
|
-
:resource_tags
|
308
|
+
:resource_tags,
|
309
|
+
:lock_state)
|
275
310
|
SENSITIVE = []
|
276
311
|
include Aws::Structure
|
277
312
|
end
|
@@ -294,13 +329,6 @@ module Aws::RecycleBin
|
|
294
329
|
include Aws::Structure
|
295
330
|
end
|
296
331
|
|
297
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
298
|
-
# data as a hash:
|
299
|
-
#
|
300
|
-
# {
|
301
|
-
# resource_arn: "RuleArn", # required
|
302
|
-
# }
|
303
|
-
#
|
304
332
|
# @!attribute [rw] resource_arn
|
305
333
|
# The Amazon Resource Name (ARN) of the retention rule.
|
306
334
|
# @return [String]
|
@@ -325,6 +353,103 @@ module Aws::RecycleBin
|
|
325
353
|
include Aws::Structure
|
326
354
|
end
|
327
355
|
|
356
|
+
# Information about a retention rule lock configuration.
|
357
|
+
#
|
358
|
+
# @!attribute [rw] unlock_delay
|
359
|
+
# Information about the retention rule unlock delay.
|
360
|
+
# @return [Types::UnlockDelay]
|
361
|
+
#
|
362
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/LockConfiguration AWS API Documentation
|
363
|
+
#
|
364
|
+
class LockConfiguration < Struct.new(
|
365
|
+
:unlock_delay)
|
366
|
+
SENSITIVE = []
|
367
|
+
include Aws::Structure
|
368
|
+
end
|
369
|
+
|
370
|
+
# @!attribute [rw] identifier
|
371
|
+
# The unique ID of the retention rule.
|
372
|
+
# @return [String]
|
373
|
+
#
|
374
|
+
# @!attribute [rw] lock_configuration
|
375
|
+
# Information about the retention rule lock configuration.
|
376
|
+
# @return [Types::LockConfiguration]
|
377
|
+
#
|
378
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/LockRuleRequest AWS API Documentation
|
379
|
+
#
|
380
|
+
class LockRuleRequest < Struct.new(
|
381
|
+
:identifier,
|
382
|
+
:lock_configuration)
|
383
|
+
SENSITIVE = []
|
384
|
+
include Aws::Structure
|
385
|
+
end
|
386
|
+
|
387
|
+
# @!attribute [rw] identifier
|
388
|
+
# The unique ID of the retention rule.
|
389
|
+
# @return [String]
|
390
|
+
#
|
391
|
+
# @!attribute [rw] description
|
392
|
+
# The retention rule description.
|
393
|
+
# @return [String]
|
394
|
+
#
|
395
|
+
# @!attribute [rw] resource_type
|
396
|
+
# The resource type retained by the retention rule.
|
397
|
+
# @return [String]
|
398
|
+
#
|
399
|
+
# @!attribute [rw] retention_period
|
400
|
+
# Information about the retention period for which the retention rule
|
401
|
+
# is to retain resources.
|
402
|
+
# @return [Types::RetentionPeriod]
|
403
|
+
#
|
404
|
+
# @!attribute [rw] resource_tags
|
405
|
+
# Information about the resource tags used to identify resources that
|
406
|
+
# are retained by the retention rule.
|
407
|
+
# @return [Array<Types::ResourceTag>]
|
408
|
+
#
|
409
|
+
# @!attribute [rw] status
|
410
|
+
# The state of the retention rule. Only retention rules that are in
|
411
|
+
# the `available` state retain resources.
|
412
|
+
# @return [String]
|
413
|
+
#
|
414
|
+
# @!attribute [rw] lock_configuration
|
415
|
+
# Information about the retention rule lock configuration.
|
416
|
+
# @return [Types::LockConfiguration]
|
417
|
+
#
|
418
|
+
# @!attribute [rw] lock_state
|
419
|
+
# The lock state for the retention rule.
|
420
|
+
#
|
421
|
+
# * `locked` - The retention rule is locked and can't be modified or
|
422
|
+
# deleted.
|
423
|
+
#
|
424
|
+
# * `pending_unlock` - The retention rule has been unlocked but it is
|
425
|
+
# still within the unlock delay period. The retention rule can be
|
426
|
+
# modified or deleted only after the unlock delay period has
|
427
|
+
# expired.
|
428
|
+
#
|
429
|
+
# * `unlocked` - The retention rule is unlocked and it can be modified
|
430
|
+
# or deleted by any user with the required permissions.
|
431
|
+
#
|
432
|
+
# * `null` - The retention rule has never been locked. Once a
|
433
|
+
# retention rule has been locked, it can transition between the
|
434
|
+
# `locked` and `unlocked` states only; it can never transition back
|
435
|
+
# to `null`.
|
436
|
+
# @return [String]
|
437
|
+
#
|
438
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/LockRuleResponse AWS API Documentation
|
439
|
+
#
|
440
|
+
class LockRuleResponse < Struct.new(
|
441
|
+
:identifier,
|
442
|
+
:description,
|
443
|
+
:resource_type,
|
444
|
+
:retention_period,
|
445
|
+
:resource_tags,
|
446
|
+
:status,
|
447
|
+
:lock_configuration,
|
448
|
+
:lock_state)
|
449
|
+
SENSITIVE = []
|
450
|
+
include Aws::Structure
|
451
|
+
end
|
452
|
+
|
328
453
|
# The specified resource was not found.
|
329
454
|
#
|
330
455
|
# @!attribute [rw] message
|
@@ -346,14 +471,6 @@ module Aws::RecycleBin
|
|
346
471
|
# Information about the resource tags used to identify resources that
|
347
472
|
# are retained by the retention rule.
|
348
473
|
#
|
349
|
-
# @note When making an API call, you may pass ResourceTag
|
350
|
-
# data as a hash:
|
351
|
-
#
|
352
|
-
# {
|
353
|
-
# resource_tag_key: "ResourceTagKey", # required
|
354
|
-
# resource_tag_value: "ResourceTagValue",
|
355
|
-
# }
|
356
|
-
#
|
357
474
|
# @!attribute [rw] resource_tag_key
|
358
475
|
# The tag key.
|
359
476
|
# @return [String]
|
@@ -374,14 +491,6 @@ module Aws::RecycleBin
|
|
374
491
|
# Information about the retention period for which the retention rule is
|
375
492
|
# to retain resources.
|
376
493
|
#
|
377
|
-
# @note When making an API call, you may pass RetentionPeriod
|
378
|
-
# data as a hash:
|
379
|
-
#
|
380
|
-
# {
|
381
|
-
# retention_period_value: 1, # required
|
382
|
-
# retention_period_unit: "DAYS", # required, accepts DAYS
|
383
|
-
# }
|
384
|
-
#
|
385
494
|
# @!attribute [rw] retention_period_value
|
386
495
|
# The period value for which the retention rule is to retain
|
387
496
|
# resources. The period is measured using the unit specified for
|
@@ -417,12 +526,33 @@ module Aws::RecycleBin
|
|
417
526
|
# is to retain resources.
|
418
527
|
# @return [Types::RetentionPeriod]
|
419
528
|
#
|
529
|
+
# @!attribute [rw] lock_state
|
530
|
+
# The lock state for the retention rule.
|
531
|
+
#
|
532
|
+
# * `locked` - The retention rule is locked and can't be modified or
|
533
|
+
# deleted.
|
534
|
+
#
|
535
|
+
# * `pending_unlock` - The retention rule has been unlocked but it is
|
536
|
+
# still within the unlock delay period. The retention rule can be
|
537
|
+
# modified or deleted only after the unlock delay period has
|
538
|
+
# expired.
|
539
|
+
#
|
540
|
+
# * `unlocked` - The retention rule is unlocked and it can be modified
|
541
|
+
# or deleted by any user with the required permissions.
|
542
|
+
#
|
543
|
+
# * `null` - The retention rule has never been locked. Once a
|
544
|
+
# retention rule has been locked, it can transition between the
|
545
|
+
# `locked` and `unlocked` states only; it can never transition back
|
546
|
+
# to `null`.
|
547
|
+
# @return [String]
|
548
|
+
#
|
420
549
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/RuleSummary AWS API Documentation
|
421
550
|
#
|
422
551
|
class RuleSummary < Struct.new(
|
423
552
|
:identifier,
|
424
553
|
:description,
|
425
|
-
:retention_period
|
554
|
+
:retention_period,
|
555
|
+
:lock_state)
|
426
556
|
SENSITIVE = []
|
427
557
|
include Aws::Structure
|
428
558
|
end
|
@@ -448,14 +578,6 @@ module Aws::RecycleBin
|
|
448
578
|
|
449
579
|
# Information about the tags to assign to the retention rule.
|
450
580
|
#
|
451
|
-
# @note When making an API call, you may pass Tag
|
452
|
-
# data as a hash:
|
453
|
-
#
|
454
|
-
# {
|
455
|
-
# key: "TagKey", # required
|
456
|
-
# value: "TagValue", # required
|
457
|
-
# }
|
458
|
-
#
|
459
581
|
# @!attribute [rw] key
|
460
582
|
# The tag key.
|
461
583
|
# @return [String]
|
@@ -473,19 +595,6 @@ module Aws::RecycleBin
|
|
473
595
|
include Aws::Structure
|
474
596
|
end
|
475
597
|
|
476
|
-
# @note When making an API call, you may pass TagResourceRequest
|
477
|
-
# data as a hash:
|
478
|
-
#
|
479
|
-
# {
|
480
|
-
# resource_arn: "RuleArn", # required
|
481
|
-
# tags: [ # required
|
482
|
-
# {
|
483
|
-
# key: "TagKey", # required
|
484
|
-
# value: "TagValue", # required
|
485
|
-
# },
|
486
|
-
# ],
|
487
|
-
# }
|
488
|
-
#
|
489
598
|
# @!attribute [rw] resource_arn
|
490
599
|
# The Amazon Resource Name (ARN) of the retention rule.
|
491
600
|
# @return [String]
|
@@ -507,14 +616,116 @@ module Aws::RecycleBin
|
|
507
616
|
#
|
508
617
|
class TagResourceResponse < Aws::EmptyStructure; end
|
509
618
|
|
510
|
-
#
|
511
|
-
#
|
619
|
+
# Information about the retention rule unlock delay. The unlock delay is
|
620
|
+
# the period after which a retention rule can be modified or edited
|
621
|
+
# after it has been unlocked by a user with the required permissions.
|
622
|
+
# The retention rule can't be modified or deleted during the unlock
|
623
|
+
# delay.
|
624
|
+
#
|
625
|
+
# @!attribute [rw] unlock_delay_value
|
626
|
+
# The unlock delay period, measured in the unit specified for <b>
|
627
|
+
# UnlockDelayUnit</b>.
|
628
|
+
# @return [Integer]
|
629
|
+
#
|
630
|
+
# @!attribute [rw] unlock_delay_unit
|
631
|
+
# The unit of time in which to measure the unlock delay. Currently,
|
632
|
+
# the unlock delay can be measure only in days.
|
633
|
+
# @return [String]
|
512
634
|
#
|
513
|
-
#
|
514
|
-
# resource_arn: "RuleArn", # required
|
515
|
-
# tag_keys: ["TagKey"], # required
|
516
|
-
# }
|
635
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UnlockDelay AWS API Documentation
|
517
636
|
#
|
637
|
+
class UnlockDelay < Struct.new(
|
638
|
+
:unlock_delay_value,
|
639
|
+
:unlock_delay_unit)
|
640
|
+
SENSITIVE = []
|
641
|
+
include Aws::Structure
|
642
|
+
end
|
643
|
+
|
644
|
+
# @!attribute [rw] identifier
|
645
|
+
# The unique ID of the retention rule.
|
646
|
+
# @return [String]
|
647
|
+
#
|
648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UnlockRuleRequest AWS API Documentation
|
649
|
+
#
|
650
|
+
class UnlockRuleRequest < Struct.new(
|
651
|
+
:identifier)
|
652
|
+
SENSITIVE = []
|
653
|
+
include Aws::Structure
|
654
|
+
end
|
655
|
+
|
656
|
+
# @!attribute [rw] identifier
|
657
|
+
# The unique ID of the retention rule.
|
658
|
+
# @return [String]
|
659
|
+
#
|
660
|
+
# @!attribute [rw] description
|
661
|
+
# The retention rule description.
|
662
|
+
# @return [String]
|
663
|
+
#
|
664
|
+
# @!attribute [rw] resource_type
|
665
|
+
# The resource type retained by the retention rule.
|
666
|
+
# @return [String]
|
667
|
+
#
|
668
|
+
# @!attribute [rw] retention_period
|
669
|
+
# Information about the retention period for which the retention rule
|
670
|
+
# is to retain resources.
|
671
|
+
# @return [Types::RetentionPeriod]
|
672
|
+
#
|
673
|
+
# @!attribute [rw] resource_tags
|
674
|
+
# Information about the resource tags used to identify resources that
|
675
|
+
# are retained by the retention rule.
|
676
|
+
# @return [Array<Types::ResourceTag>]
|
677
|
+
#
|
678
|
+
# @!attribute [rw] status
|
679
|
+
# The state of the retention rule. Only retention rules that are in
|
680
|
+
# the `available` state retain resources.
|
681
|
+
# @return [String]
|
682
|
+
#
|
683
|
+
# @!attribute [rw] lock_configuration
|
684
|
+
# Information about the retention rule lock configuration.
|
685
|
+
# @return [Types::LockConfiguration]
|
686
|
+
#
|
687
|
+
# @!attribute [rw] lock_state
|
688
|
+
# The lock state for the retention rule.
|
689
|
+
#
|
690
|
+
# * `locked` - The retention rule is locked and can't be modified or
|
691
|
+
# deleted.
|
692
|
+
#
|
693
|
+
# * `pending_unlock` - The retention rule has been unlocked but it is
|
694
|
+
# still within the unlock delay period. The retention rule can be
|
695
|
+
# modified or deleted only after the unlock delay period has
|
696
|
+
# expired.
|
697
|
+
#
|
698
|
+
# * `unlocked` - The retention rule is unlocked and it can be modified
|
699
|
+
# or deleted by any user with the required permissions.
|
700
|
+
#
|
701
|
+
# * `null` - The retention rule has never been locked. Once a
|
702
|
+
# retention rule has been locked, it can transition between the
|
703
|
+
# `locked` and `unlocked` states only; it can never transition back
|
704
|
+
# to `null`.
|
705
|
+
# @return [String]
|
706
|
+
#
|
707
|
+
# @!attribute [rw] lock_end_time
|
708
|
+
# The date and time at which the unlock delay is set to expire. Only
|
709
|
+
# returned for retention rules that have been unlocked and that are
|
710
|
+
# still within the unlock delay period.
|
711
|
+
# @return [Time]
|
712
|
+
#
|
713
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UnlockRuleResponse AWS API Documentation
|
714
|
+
#
|
715
|
+
class UnlockRuleResponse < Struct.new(
|
716
|
+
:identifier,
|
717
|
+
:description,
|
718
|
+
:resource_type,
|
719
|
+
:retention_period,
|
720
|
+
:resource_tags,
|
721
|
+
:status,
|
722
|
+
:lock_configuration,
|
723
|
+
:lock_state,
|
724
|
+
:lock_end_time)
|
725
|
+
SENSITIVE = []
|
726
|
+
include Aws::Structure
|
727
|
+
end
|
728
|
+
|
518
729
|
# @!attribute [rw] resource_arn
|
519
730
|
# The Amazon Resource Name (ARN) of the retention rule.
|
520
731
|
# @return [String]
|
@@ -537,25 +748,6 @@ module Aws::RecycleBin
|
|
537
748
|
#
|
538
749
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
539
750
|
|
540
|
-
# @note When making an API call, you may pass UpdateRuleRequest
|
541
|
-
# data as a hash:
|
542
|
-
#
|
543
|
-
# {
|
544
|
-
# identifier: "RuleIdentifier", # required
|
545
|
-
# retention_period: {
|
546
|
-
# retention_period_value: 1, # required
|
547
|
-
# retention_period_unit: "DAYS", # required, accepts DAYS
|
548
|
-
# },
|
549
|
-
# description: "Description",
|
550
|
-
# resource_type: "EBS_SNAPSHOT", # accepts EBS_SNAPSHOT, EC2_IMAGE
|
551
|
-
# resource_tags: [
|
552
|
-
# {
|
553
|
-
# resource_tag_key: "ResourceTagKey", # required
|
554
|
-
# resource_tag_value: "ResourceTagValue",
|
555
|
-
# },
|
556
|
-
# ],
|
557
|
-
# }
|
558
|
-
#
|
559
751
|
# @!attribute [rw] identifier
|
560
752
|
# The unique ID of the retention rule.
|
561
753
|
# @return [String]
|
@@ -570,10 +762,10 @@ module Aws::RecycleBin
|
|
570
762
|
# @return [String]
|
571
763
|
#
|
572
764
|
# @!attribute [rw] resource_type
|
573
|
-
#
|
574
|
-
#
|
575
|
-
#
|
576
|
-
#
|
765
|
+
# <note markdown="1"> This parameter is currently not supported. You can't update a
|
766
|
+
# retention rule's resource type after creation.
|
767
|
+
#
|
768
|
+
# </note>
|
577
769
|
# @return [String]
|
578
770
|
#
|
579
771
|
# @!attribute [rw] resource_tags
|
@@ -634,6 +826,32 @@ module Aws::RecycleBin
|
|
634
826
|
# the `available` state retain resources.
|
635
827
|
# @return [String]
|
636
828
|
#
|
829
|
+
# @!attribute [rw] lock_state
|
830
|
+
# The lock state for the retention rule.
|
831
|
+
#
|
832
|
+
# * `locked` - The retention rule is locked and can't be modified or
|
833
|
+
# deleted.
|
834
|
+
#
|
835
|
+
# * `pending_unlock` - The retention rule has been unlocked but it is
|
836
|
+
# still within the unlock delay period. The retention rule can be
|
837
|
+
# modified or deleted only after the unlock delay period has
|
838
|
+
# expired.
|
839
|
+
#
|
840
|
+
# * `unlocked` - The retention rule is unlocked and it can be modified
|
841
|
+
# or deleted by any user with the required permissions.
|
842
|
+
#
|
843
|
+
# * `null` - The retention rule has never been locked. Once a
|
844
|
+
# retention rule has been locked, it can transition between the
|
845
|
+
# `locked` and `unlocked` states only; it can never transition back
|
846
|
+
# to `null`.
|
847
|
+
# @return [String]
|
848
|
+
#
|
849
|
+
# @!attribute [rw] lock_end_time
|
850
|
+
# The date and time at which the unlock delay is set to expire. Only
|
851
|
+
# returned for retention rules that have been unlocked and that are
|
852
|
+
# still within the unlock delay period.
|
853
|
+
# @return [Time]
|
854
|
+
#
|
637
855
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UpdateRuleResponse AWS API Documentation
|
638
856
|
#
|
639
857
|
class UpdateRuleResponse < Struct.new(
|
@@ -642,7 +860,9 @@ module Aws::RecycleBin
|
|
642
860
|
:description,
|
643
861
|
:resource_type,
|
644
862
|
:resource_tags,
|
645
|
-
:status
|
863
|
+
:status,
|
864
|
+
:lock_state,
|
865
|
+
:lock_end_time)
|
646
866
|
SENSITIVE = []
|
647
867
|
include Aws::Structure
|
648
868
|
end
|
data/lib/aws-sdk-recyclebin.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-recyclebin
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.8.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:
|
11
|
+
date: 2023-01-18 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|