aws-sdk-recyclebin 1.5.0 → 1.7.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.
@@ -10,6 +10,24 @@
10
10
  module Aws::RecycleBin
11
11
  module Types
12
12
 
13
+ # The specified retention rule lock request can't be completed.
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
+
13
31
  # @note When making an API call, you may pass CreateRuleRequest
14
32
  # data as a hash:
15
33
  #
@@ -32,6 +50,12 @@ module Aws::RecycleBin
32
50
  # resource_tag_value: "ResourceTagValue",
33
51
  # },
34
52
  # ],
53
+ # lock_configuration: {
54
+ # unlock_delay: { # required
55
+ # unlock_delay_value: 1, # required
56
+ # unlock_delay_unit: "DAYS", # required, accepts DAYS
57
+ # },
58
+ # },
35
59
  # }
36
60
  #
37
61
  # @!attribute [rw] retention_period
@@ -73,6 +97,10 @@ module Aws::RecycleBin
73
97
  # the resources are not tagged.
74
98
  # @return [Array<Types::ResourceTag>]
75
99
  #
100
+ # @!attribute [rw] lock_configuration
101
+ # Information about the retention rule lock configuration.
102
+ # @return [Types::LockConfiguration]
103
+ #
76
104
  # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/CreateRuleRequest AWS API Documentation
77
105
  #
78
106
  class CreateRuleRequest < Struct.new(
@@ -80,7 +108,8 @@ module Aws::RecycleBin
80
108
  :description,
81
109
  :tags,
82
110
  :resource_type,
83
- :resource_tags)
111
+ :resource_tags,
112
+ :lock_configuration)
84
113
  SENSITIVE = []
85
114
  include Aws::Structure
86
115
  end
@@ -116,6 +145,30 @@ module Aws::RecycleBin
116
145
  # the `available` state retain resources.
117
146
  # @return [String]
118
147
  #
148
+ # @!attribute [rw] lock_configuration
149
+ # Information about the retention rule lock configuration.
150
+ # @return [Types::LockConfiguration]
151
+ #
152
+ # @!attribute [rw] lock_state
153
+ # The lock state for the retention rule.
154
+ #
155
+ # * `locked` - The retention rule is locked and can't be modified or
156
+ # deleted.
157
+ #
158
+ # * `pending_unlock` - The retention rule has been unlocked but it is
159
+ # still within the unlock delay period. The retention rule can be
160
+ # modified or deleted only after the unlock delay period has
161
+ # expired.
162
+ #
163
+ # * `unlocked` - The retention rule is unlocked and it can be modified
164
+ # or deleted by any user with the required permissions.
165
+ #
166
+ # * `null` - The retention rule has never been locked. Once a
167
+ # retention rule has been locked, it can transition between the
168
+ # `locked` and `unlocked` states only; it can never transition back
169
+ # to `null`.
170
+ # @return [String]
171
+ #
119
172
  # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/CreateRuleResponse AWS API Documentation
120
173
  #
121
174
  class CreateRuleResponse < Struct.new(
@@ -125,7 +178,9 @@ module Aws::RecycleBin
125
178
  :tags,
126
179
  :resource_type,
127
180
  :resource_tags,
128
- :status)
181
+ :status,
182
+ :lock_configuration,
183
+ :lock_state)
129
184
  SENSITIVE = []
130
185
  include Aws::Structure
131
186
  end
@@ -199,6 +254,36 @@ module Aws::RecycleBin
199
254
  # the `available` state retain resources.
200
255
  # @return [String]
201
256
  #
257
+ # @!attribute [rw] lock_configuration
258
+ # Information about the retention rule lock configuration.
259
+ # @return [Types::LockConfiguration]
260
+ #
261
+ # @!attribute [rw] lock_state
262
+ # The lock state for the retention rule.
263
+ #
264
+ # * `locked` - The retention rule is locked and can't be modified or
265
+ # deleted.
266
+ #
267
+ # * `pending_unlock` - The retention rule has been unlocked but it is
268
+ # still within the unlock delay period. The retention rule can be
269
+ # modified or deleted only after the unlock delay period has
270
+ # expired.
271
+ #
272
+ # * `unlocked` - The retention rule is unlocked and it can be modified
273
+ # or deleted by any user with the required permissions.
274
+ #
275
+ # * `null` - The retention rule has never been locked. Once a
276
+ # retention rule has been locked, it can transition between the
277
+ # `locked` and `unlocked` states only; it can never transition back
278
+ # to `null`.
279
+ # @return [String]
280
+ #
281
+ # @!attribute [rw] lock_end_time
282
+ # The date and time at which the unlock delay is set to expire. Only
283
+ # returned for retention rules that have been unlocked and that are
284
+ # still within the unlock delay period.
285
+ # @return [Time]
286
+ #
202
287
  # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/GetRuleResponse AWS API Documentation
203
288
  #
204
289
  class GetRuleResponse < Struct.new(
@@ -207,7 +292,10 @@ module Aws::RecycleBin
207
292
  :resource_type,
208
293
  :retention_period,
209
294
  :resource_tags,
210
- :status)
295
+ :status,
296
+ :lock_configuration,
297
+ :lock_state,
298
+ :lock_end_time)
211
299
  SENSITIVE = []
212
300
  include Aws::Structure
213
301
  end
@@ -239,6 +327,7 @@ module Aws::RecycleBin
239
327
  # resource_tag_value: "ResourceTagValue",
240
328
  # },
241
329
  # ],
330
+ # lock_state: "locked", # accepts locked, pending_unlock, unlocked
242
331
  # }
243
332
  #
244
333
  # @!attribute [rw] max_results
@@ -265,13 +354,19 @@ module Aws::RecycleBin
265
354
  # are retained by the retention rule.
266
355
  # @return [Array<Types::ResourceTag>]
267
356
  #
357
+ # @!attribute [rw] lock_state
358
+ # The lock state of the retention rules to list. Only retention rules
359
+ # with the specified lock state are returned.
360
+ # @return [String]
361
+ #
268
362
  # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ListRulesRequest AWS API Documentation
269
363
  #
270
364
  class ListRulesRequest < Struct.new(
271
365
  :max_results,
272
366
  :next_token,
273
367
  :resource_type,
274
- :resource_tags)
368
+ :resource_tags,
369
+ :lock_state)
275
370
  SENSITIVE = []
276
371
  include Aws::Structure
277
372
  end
@@ -325,6 +420,126 @@ module Aws::RecycleBin
325
420
  include Aws::Structure
326
421
  end
327
422
 
423
+ # Information about a retention rule lock configuration.
424
+ #
425
+ # @note When making an API call, you may pass LockConfiguration
426
+ # data as a hash:
427
+ #
428
+ # {
429
+ # unlock_delay: { # required
430
+ # unlock_delay_value: 1, # required
431
+ # unlock_delay_unit: "DAYS", # required, accepts DAYS
432
+ # },
433
+ # }
434
+ #
435
+ # @!attribute [rw] unlock_delay
436
+ # Information about the retention rule unlock delay.
437
+ # @return [Types::UnlockDelay]
438
+ #
439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/LockConfiguration AWS API Documentation
440
+ #
441
+ class LockConfiguration < Struct.new(
442
+ :unlock_delay)
443
+ SENSITIVE = []
444
+ include Aws::Structure
445
+ end
446
+
447
+ # @note When making an API call, you may pass LockRuleRequest
448
+ # data as a hash:
449
+ #
450
+ # {
451
+ # identifier: "RuleIdentifier", # required
452
+ # lock_configuration: { # required
453
+ # unlock_delay: { # required
454
+ # unlock_delay_value: 1, # required
455
+ # unlock_delay_unit: "DAYS", # required, accepts DAYS
456
+ # },
457
+ # },
458
+ # }
459
+ #
460
+ # @!attribute [rw] identifier
461
+ # The unique ID of the retention rule.
462
+ # @return [String]
463
+ #
464
+ # @!attribute [rw] lock_configuration
465
+ # Information about the retention rule lock configuration.
466
+ # @return [Types::LockConfiguration]
467
+ #
468
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/LockRuleRequest AWS API Documentation
469
+ #
470
+ class LockRuleRequest < Struct.new(
471
+ :identifier,
472
+ :lock_configuration)
473
+ SENSITIVE = []
474
+ include Aws::Structure
475
+ end
476
+
477
+ # @!attribute [rw] identifier
478
+ # The unique ID of the retention rule.
479
+ # @return [String]
480
+ #
481
+ # @!attribute [rw] description
482
+ # The retention rule description.
483
+ # @return [String]
484
+ #
485
+ # @!attribute [rw] resource_type
486
+ # The resource type retained by the retention rule.
487
+ # @return [String]
488
+ #
489
+ # @!attribute [rw] retention_period
490
+ # Information about the retention period for which the retention rule
491
+ # is to retain resources.
492
+ # @return [Types::RetentionPeriod]
493
+ #
494
+ # @!attribute [rw] resource_tags
495
+ # Information about the resource tags used to identify resources that
496
+ # are retained by the retention rule.
497
+ # @return [Array<Types::ResourceTag>]
498
+ #
499
+ # @!attribute [rw] status
500
+ # The state of the retention rule. Only retention rules that are in
501
+ # the `available` state retain resources.
502
+ # @return [String]
503
+ #
504
+ # @!attribute [rw] lock_configuration
505
+ # Information about the retention rule lock configuration.
506
+ # @return [Types::LockConfiguration]
507
+ #
508
+ # @!attribute [rw] lock_state
509
+ # The lock state for the retention rule.
510
+ #
511
+ # * `locked` - The retention rule is locked and can't be modified or
512
+ # deleted.
513
+ #
514
+ # * `pending_unlock` - The retention rule has been unlocked but it is
515
+ # still within the unlock delay period. The retention rule can be
516
+ # modified or deleted only after the unlock delay period has
517
+ # expired.
518
+ #
519
+ # * `unlocked` - The retention rule is unlocked and it can be modified
520
+ # or deleted by any user with the required permissions.
521
+ #
522
+ # * `null` - The retention rule has never been locked. Once a
523
+ # retention rule has been locked, it can transition between the
524
+ # `locked` and `unlocked` states only; it can never transition back
525
+ # to `null`.
526
+ # @return [String]
527
+ #
528
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/LockRuleResponse AWS API Documentation
529
+ #
530
+ class LockRuleResponse < Struct.new(
531
+ :identifier,
532
+ :description,
533
+ :resource_type,
534
+ :retention_period,
535
+ :resource_tags,
536
+ :status,
537
+ :lock_configuration,
538
+ :lock_state)
539
+ SENSITIVE = []
540
+ include Aws::Structure
541
+ end
542
+
328
543
  # The specified resource was not found.
329
544
  #
330
545
  # @!attribute [rw] message
@@ -417,12 +632,33 @@ module Aws::RecycleBin
417
632
  # is to retain resources.
418
633
  # @return [Types::RetentionPeriod]
419
634
  #
635
+ # @!attribute [rw] lock_state
636
+ # The lock state for the retention rule.
637
+ #
638
+ # * `locked` - The retention rule is locked and can't be modified or
639
+ # deleted.
640
+ #
641
+ # * `pending_unlock` - The retention rule has been unlocked but it is
642
+ # still within the unlock delay period. The retention rule can be
643
+ # modified or deleted only after the unlock delay period has
644
+ # expired.
645
+ #
646
+ # * `unlocked` - The retention rule is unlocked and it can be modified
647
+ # or deleted by any user with the required permissions.
648
+ #
649
+ # * `null` - The retention rule has never been locked. Once a
650
+ # retention rule has been locked, it can transition between the
651
+ # `locked` and `unlocked` states only; it can never transition back
652
+ # to `null`.
653
+ # @return [String]
654
+ #
420
655
  # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/RuleSummary AWS API Documentation
421
656
  #
422
657
  class RuleSummary < Struct.new(
423
658
  :identifier,
424
659
  :description,
425
- :retention_period)
660
+ :retention_period,
661
+ :lock_state)
426
662
  SENSITIVE = []
427
663
  include Aws::Structure
428
664
  end
@@ -507,6 +743,131 @@ module Aws::RecycleBin
507
743
  #
508
744
  class TagResourceResponse < Aws::EmptyStructure; end
509
745
 
746
+ # Information about the retention rule unlock delay. The unlock delay is
747
+ # the period after which a retention rule can be modified or edited
748
+ # after it has been unlocked by a user with the required permissions.
749
+ # The retention rule can't be modified or deleted during the unlock
750
+ # delay.
751
+ #
752
+ # @note When making an API call, you may pass UnlockDelay
753
+ # data as a hash:
754
+ #
755
+ # {
756
+ # unlock_delay_value: 1, # required
757
+ # unlock_delay_unit: "DAYS", # required, accepts DAYS
758
+ # }
759
+ #
760
+ # @!attribute [rw] unlock_delay_value
761
+ # The unlock delay period, measured in the unit specified for <b>
762
+ # UnlockDelayUnit</b>.
763
+ # @return [Integer]
764
+ #
765
+ # @!attribute [rw] unlock_delay_unit
766
+ # The unit of time in which to measure the unlock delay. Currently,
767
+ # the unlock delay can be measure only in days.
768
+ # @return [String]
769
+ #
770
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UnlockDelay AWS API Documentation
771
+ #
772
+ class UnlockDelay < Struct.new(
773
+ :unlock_delay_value,
774
+ :unlock_delay_unit)
775
+ SENSITIVE = []
776
+ include Aws::Structure
777
+ end
778
+
779
+ # @note When making an API call, you may pass UnlockRuleRequest
780
+ # data as a hash:
781
+ #
782
+ # {
783
+ # identifier: "RuleIdentifier", # required
784
+ # }
785
+ #
786
+ # @!attribute [rw] identifier
787
+ # The unique ID of the retention rule.
788
+ # @return [String]
789
+ #
790
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UnlockRuleRequest AWS API Documentation
791
+ #
792
+ class UnlockRuleRequest < Struct.new(
793
+ :identifier)
794
+ SENSITIVE = []
795
+ include Aws::Structure
796
+ end
797
+
798
+ # @!attribute [rw] identifier
799
+ # The unique ID of the retention rule.
800
+ # @return [String]
801
+ #
802
+ # @!attribute [rw] description
803
+ # The retention rule description.
804
+ # @return [String]
805
+ #
806
+ # @!attribute [rw] resource_type
807
+ # The resource type retained by the retention rule.
808
+ # @return [String]
809
+ #
810
+ # @!attribute [rw] retention_period
811
+ # Information about the retention period for which the retention rule
812
+ # is to retain resources.
813
+ # @return [Types::RetentionPeriod]
814
+ #
815
+ # @!attribute [rw] resource_tags
816
+ # Information about the resource tags used to identify resources that
817
+ # are retained by the retention rule.
818
+ # @return [Array<Types::ResourceTag>]
819
+ #
820
+ # @!attribute [rw] status
821
+ # The state of the retention rule. Only retention rules that are in
822
+ # the `available` state retain resources.
823
+ # @return [String]
824
+ #
825
+ # @!attribute [rw] lock_configuration
826
+ # Information about the retention rule lock configuration.
827
+ # @return [Types::LockConfiguration]
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
+ #
855
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UnlockRuleResponse AWS API Documentation
856
+ #
857
+ class UnlockRuleResponse < Struct.new(
858
+ :identifier,
859
+ :description,
860
+ :resource_type,
861
+ :retention_period,
862
+ :resource_tags,
863
+ :status,
864
+ :lock_configuration,
865
+ :lock_state,
866
+ :lock_end_time)
867
+ SENSITIVE = []
868
+ include Aws::Structure
869
+ end
870
+
510
871
  # @note When making an API call, you may pass UntagResourceRequest
511
872
  # data as a hash:
512
873
  #
@@ -570,10 +931,10 @@ module Aws::RecycleBin
570
931
  # @return [String]
571
932
  #
572
933
  # @!attribute [rw] resource_type
573
- # The resource type to be retained by the retention rule. Currently,
574
- # only Amazon EBS snapshots and EBS-backed AMIs are supported. To
575
- # retain snapshots, specify `EBS_SNAPSHOT`. To retain EBS-backed AMIs,
576
- # specify `EC2_IMAGE`.
934
+ # <note markdown="1"> This parameter is currently not supported. You can't update a
935
+ # retention rule's resource type after creation.
936
+ #
937
+ # </note>
577
938
  # @return [String]
578
939
  #
579
940
  # @!attribute [rw] resource_tags
@@ -634,6 +995,32 @@ module Aws::RecycleBin
634
995
  # the `available` state retain resources.
635
996
  # @return [String]
636
997
  #
998
+ # @!attribute [rw] lock_state
999
+ # The lock state for the retention rule.
1000
+ #
1001
+ # * `locked` - The retention rule is locked and can't be modified or
1002
+ # deleted.
1003
+ #
1004
+ # * `pending_unlock` - The retention rule has been unlocked but it is
1005
+ # still within the unlock delay period. The retention rule can be
1006
+ # modified or deleted only after the unlock delay period has
1007
+ # expired.
1008
+ #
1009
+ # * `unlocked` - The retention rule is unlocked and it can be modified
1010
+ # or deleted by any user with the required permissions.
1011
+ #
1012
+ # * `null` - The retention rule has never been locked. Once a
1013
+ # retention rule has been locked, it can transition between the
1014
+ # `locked` and `unlocked` states only; it can never transition back
1015
+ # to `null`.
1016
+ # @return [String]
1017
+ #
1018
+ # @!attribute [rw] lock_end_time
1019
+ # The date and time at which the unlock delay is set to expire. Only
1020
+ # returned for retention rules that have been unlocked and that are
1021
+ # still within the unlock delay period.
1022
+ # @return [Time]
1023
+ #
637
1024
  # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UpdateRuleResponse AWS API Documentation
638
1025
  #
639
1026
  class UpdateRuleResponse < Struct.new(
@@ -642,7 +1029,9 @@ module Aws::RecycleBin
642
1029
  :description,
643
1030
  :resource_type,
644
1031
  :resource_tags,
645
- :status)
1032
+ :status,
1033
+ :lock_state,
1034
+ :lock_end_time)
646
1035
  SENSITIVE = []
647
1036
  include Aws::Structure
648
1037
  end
@@ -13,9 +13,13 @@ require 'aws-sigv4'
13
13
 
14
14
  require_relative 'aws-sdk-recyclebin/types'
15
15
  require_relative 'aws-sdk-recyclebin/client_api'
16
+ require_relative 'aws-sdk-recyclebin/plugins/endpoints.rb'
16
17
  require_relative 'aws-sdk-recyclebin/client'
17
18
  require_relative 'aws-sdk-recyclebin/errors'
18
19
  require_relative 'aws-sdk-recyclebin/resource'
20
+ require_relative 'aws-sdk-recyclebin/endpoint_parameters'
21
+ require_relative 'aws-sdk-recyclebin/endpoint_provider'
22
+ require_relative 'aws-sdk-recyclebin/endpoints'
19
23
  require_relative 'aws-sdk-recyclebin/customizations'
20
24
 
21
25
  # This module provides support for Amazon Recycle Bin. This module is available in the
@@ -48,6 +52,6 @@ require_relative 'aws-sdk-recyclebin/customizations'
48
52
  # @!group service
49
53
  module Aws::RecycleBin
50
54
 
51
- GEM_VERSION = '1.5.0'
55
+ GEM_VERSION = '1.7.0'
52
56
 
53
57
  end
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.5.0
4
+ version: 1.7.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: 2022-02-24 00:00:00.000000000 Z
11
+ date: 2022-11-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.127.0
22
+ version: 3.165.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.127.0
32
+ version: 3.165.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -59,7 +59,11 @@ files:
59
59
  - lib/aws-sdk-recyclebin/client.rb
60
60
  - lib/aws-sdk-recyclebin/client_api.rb
61
61
  - lib/aws-sdk-recyclebin/customizations.rb
62
+ - lib/aws-sdk-recyclebin/endpoint_parameters.rb
63
+ - lib/aws-sdk-recyclebin/endpoint_provider.rb
64
+ - lib/aws-sdk-recyclebin/endpoints.rb
62
65
  - lib/aws-sdk-recyclebin/errors.rb
66
+ - lib/aws-sdk-recyclebin/plugins/endpoints.rb
63
67
  - lib/aws-sdk-recyclebin/resource.rb
64
68
  - lib/aws-sdk-recyclebin/types.rb
65
69
  homepage: https://github.com/aws/aws-sdk-ruby