aws-sdk-recyclebin 1.6.0 → 1.8.0

data/lib/aws-sdk-recyclebin/types.rb

@@ -10,30 +10,24 @@
 module Aws::RecycleBin
   module Types
 
-    # @note When making an API call, you may pass CreateRuleRequest
-    #   data as a hash:
-    #
-    #       {
-    #         retention_period: { # required
-    #           retention_period_value: 1, # required
-    #           retention_period_unit: "DAYS", # required, accepts DAYS
-    #         },
-    #         description: "Description",
-    #         tags: [
-    #           {
-    #             key: "TagKey", # required
-    #             value: "TagValue", # required
-    #           },
-    #         ],
-    #         resource_type: "EBS_SNAPSHOT", # required, accepts EBS_SNAPSHOT, EC2_IMAGE
-    #         resource_tags: [
-    #           {
-    #             resource_tag_key: "ResourceTagKey", # required
-    #             resource_tag_value: "ResourceTagValue",
-    #           },
-    #         ],
-    #       }
+    # The specified retention rule lock request can't be completed.
     #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @!attribute [rw] reason
+    #   The reason for the exception.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ConflictException AWS API Documentation
+    #
+    class ConflictException < Struct.new(
+      :message,
+      :reason)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] retention_period
     #   Information about the retention period for which the retention rule
     #   is to retain resources.
@@ -73,6 +67,10 @@ module Aws::RecycleBin
     #   the resources are not tagged.
     #   @return [Array<Types::ResourceTag>]
     #
+    # @!attribute [rw] lock_configuration
+    #   Information about the retention rule lock configuration.
+    #   @return [Types::LockConfiguration]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/CreateRuleRequest AWS API Documentation
     #
     class CreateRuleRequest < Struct.new(
@@ -80,7 +78,8 @@ module Aws::RecycleBin
       :description,
       :tags,
       :resource_type,
-      :resource_tags)
+      :resource_tags,
+      :lock_configuration)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -116,6 +115,30 @@ module Aws::RecycleBin
     #   the `available` state retain resources.
     #   @return [String]
     #
+    # @!attribute [rw] lock_configuration
+    #   Information about the retention rule lock configuration.
+    #   @return [Types::LockConfiguration]
+    #
+    # @!attribute [rw] lock_state
+    #   The lock state for the retention rule.
+    #
+    #   * `locked` - The retention rule is locked and can't be modified or
+    #     deleted.
+    #
+    #   * `pending_unlock` - The retention rule has been unlocked but it is
+    #     still within the unlock delay period. The retention rule can be
+    #     modified or deleted only after the unlock delay period has
+    #     expired.
+    #
+    #   * `unlocked` - The retention rule is unlocked and it can be modified
+    #     or deleted by any user with the required permissions.
+    #
+    #   * `null` - The retention rule has never been locked. Once a
+    #     retention rule has been locked, it can transition between the
+    #     `locked` and `unlocked` states only; it can never transition back
+    #     to `null`.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/CreateRuleResponse AWS API Documentation
     #
     class CreateRuleResponse < Struct.new(
@@ -125,18 +148,13 @@ module Aws::RecycleBin
       :tags,
       :resource_type,
       :resource_tags,
-      :status)
+      :status,
+      :lock_configuration,
+      :lock_state)
       SENSITIVE = []
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass DeleteRuleRequest
-    #   data as a hash:
-    #
-    #       {
-    #         identifier: "RuleIdentifier", # required
-    #       }
-    #
     # @!attribute [rw] identifier
     #   The unique ID of the retention rule.
     #   @return [String]
@@ -153,13 +171,6 @@ module Aws::RecycleBin
     #
     class DeleteRuleResponse < Aws::EmptyStructure; end
 
-    # @note When making an API call, you may pass GetRuleRequest
-    #   data as a hash:
-    #
-    #       {
-    #         identifier: "RuleIdentifier", # required
-    #       }
-    #
     # @!attribute [rw] identifier
     #   The unique ID of the retention rule.
     #   @return [String]
@@ -199,6 +210,36 @@ module Aws::RecycleBin
     #   the `available` state retain resources.
     #   @return [String]
     #
+    # @!attribute [rw] lock_configuration
+    #   Information about the retention rule lock configuration.
+    #   @return [Types::LockConfiguration]
+    #
+    # @!attribute [rw] lock_state
+    #   The lock state for the retention rule.
+    #
+    #   * `locked` - The retention rule is locked and can't be modified or
+    #     deleted.
+    #
+    #   * `pending_unlock` - The retention rule has been unlocked but it is
+    #     still within the unlock delay period. The retention rule can be
+    #     modified or deleted only after the unlock delay period has
+    #     expired.
+    #
+    #   * `unlocked` - The retention rule is unlocked and it can be modified
+    #     or deleted by any user with the required permissions.
+    #
+    #   * `null` - The retention rule has never been locked. Once a
+    #     retention rule has been locked, it can transition between the
+    #     `locked` and `unlocked` states only; it can never transition back
+    #     to `null`.
+    #   @return [String]
+    #
+    # @!attribute [rw] lock_end_time
+    #   The date and time at which the unlock delay is set to expire. Only
+    #   returned for retention rules that have been unlocked and that are
+    #   still within the unlock delay period.
+    #   @return [Time]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/GetRuleResponse AWS API Documentation
     #
     class GetRuleResponse < Struct.new(
@@ -207,7 +248,10 @@ module Aws::RecycleBin
       :resource_type,
       :retention_period,
       :resource_tags,
-      :status)
+      :status,
+      :lock_configuration,
+      :lock_state,
+      :lock_end_time)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -226,21 +270,6 @@ module Aws::RecycleBin
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass ListRulesRequest
-    #   data as a hash:
-    #
-    #       {
-    #         max_results: 1,
-    #         next_token: "NextToken",
-    #         resource_type: "EBS_SNAPSHOT", # required, accepts EBS_SNAPSHOT, EC2_IMAGE
-    #         resource_tags: [
-    #           {
-    #             resource_tag_key: "ResourceTagKey", # required
-    #             resource_tag_value: "ResourceTagValue",
-    #           },
-    #         ],
-    #       }
-    #
     # @!attribute [rw] max_results
     #   The maximum number of results to return with a single call. To
     #   retrieve the remaining results, make another call with the returned
@@ -265,13 +294,19 @@ module Aws::RecycleBin
     #   are retained by the retention rule.
     #   @return [Array<Types::ResourceTag>]
     #
+    # @!attribute [rw] lock_state
+    #   The lock state of the retention rules to list. Only retention rules
+    #   with the specified lock state are returned.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ListRulesRequest AWS API Documentation
     #
     class ListRulesRequest < Struct.new(
       :max_results,
       :next_token,
       :resource_type,
-      :resource_tags)
+      :resource_tags,
+      :lock_state)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -294,13 +329,6 @@ module Aws::RecycleBin
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass ListTagsForResourceRequest
-    #   data as a hash:
-    #
-    #       {
-    #         resource_arn: "RuleArn", # required
-    #       }
-    #
     # @!attribute [rw] resource_arn
     #   The Amazon Resource Name (ARN) of the retention rule.
     #   @return [String]
@@ -325,6 +353,103 @@ module Aws::RecycleBin
       include Aws::Structure
     end
 
+    # Information about a retention rule lock configuration.
+    #
+    # @!attribute [rw] unlock_delay
+    #   Information about the retention rule unlock delay.
+    #   @return [Types::UnlockDelay]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/LockConfiguration AWS API Documentation
+    #
+    class LockConfiguration < Struct.new(
+      :unlock_delay)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] identifier
+    #   The unique ID of the retention rule.
+    #   @return [String]
+    #
+    # @!attribute [rw] lock_configuration
+    #   Information about the retention rule lock configuration.
+    #   @return [Types::LockConfiguration]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/LockRuleRequest AWS API Documentation
+    #
+    class LockRuleRequest < Struct.new(
+      :identifier,
+      :lock_configuration)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] identifier
+    #   The unique ID of the retention rule.
+    #   @return [String]
+    #
+    # @!attribute [rw] description
+    #   The retention rule description.
+    #   @return [String]
+    #
+    # @!attribute [rw] resource_type
+    #   The resource type retained by the retention rule.
+    #   @return [String]
+    #
+    # @!attribute [rw] retention_period
+    #   Information about the retention period for which the retention rule
+    #   is to retain resources.
+    #   @return [Types::RetentionPeriod]
+    #
+    # @!attribute [rw] resource_tags
+    #   Information about the resource tags used to identify resources that
+    #   are retained by the retention rule.
+    #   @return [Array<Types::ResourceTag>]
+    #
+    # @!attribute [rw] status
+    #   The state of the retention rule. Only retention rules that are in
+    #   the `available` state retain resources.
+    #   @return [String]
+    #
+    # @!attribute [rw] lock_configuration
+    #   Information about the retention rule lock configuration.
+    #   @return [Types::LockConfiguration]
+    #
+    # @!attribute [rw] lock_state
+    #   The lock state for the retention rule.
+    #
+    #   * `locked` - The retention rule is locked and can't be modified or
+    #     deleted.
+    #
+    #   * `pending_unlock` - The retention rule has been unlocked but it is
+    #     still within the unlock delay period. The retention rule can be
+    #     modified or deleted only after the unlock delay period has
+    #     expired.
+    #
+    #   * `unlocked` - The retention rule is unlocked and it can be modified
+    #     or deleted by any user with the required permissions.
+    #
+    #   * `null` - The retention rule has never been locked. Once a
+    #     retention rule has been locked, it can transition between the
+    #     `locked` and `unlocked` states only; it can never transition back
+    #     to `null`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/LockRuleResponse AWS API Documentation
+    #
+    class LockRuleResponse < Struct.new(
+      :identifier,
+      :description,
+      :resource_type,
+      :retention_period,
+      :resource_tags,
+      :status,
+      :lock_configuration,
+      :lock_state)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The specified resource was not found.
     #
     # @!attribute [rw] message
@@ -346,14 +471,6 @@ module Aws::RecycleBin
     # Information about the resource tags used to identify resources that
     # are retained by the retention rule.
     #
-    # @note When making an API call, you may pass ResourceTag
-    #   data as a hash:
-    #
-    #       {
-    #         resource_tag_key: "ResourceTagKey", # required
-    #         resource_tag_value: "ResourceTagValue",
-    #       }
-    #
     # @!attribute [rw] resource_tag_key
     #   The tag key.
     #   @return [String]
@@ -374,14 +491,6 @@ module Aws::RecycleBin
     # Information about the retention period for which the retention rule is
     # to retain resources.
     #
-    # @note When making an API call, you may pass RetentionPeriod
-    #   data as a hash:
-    #
-    #       {
-    #         retention_period_value: 1, # required
-    #         retention_period_unit: "DAYS", # required, accepts DAYS
-    #       }
-    #
     # @!attribute [rw] retention_period_value
     #   The period value for which the retention rule is to retain
     #   resources. The period is measured using the unit specified for
@@ -417,12 +526,33 @@ module Aws::RecycleBin
     #   is to retain resources.
     #   @return [Types::RetentionPeriod]
     #
+    # @!attribute [rw] lock_state
+    #   The lock state for the retention rule.
+    #
+    #   * `locked` - The retention rule is locked and can't be modified or
+    #     deleted.
+    #
+    #   * `pending_unlock` - The retention rule has been unlocked but it is
+    #     still within the unlock delay period. The retention rule can be
+    #     modified or deleted only after the unlock delay period has
+    #     expired.
+    #
+    #   * `unlocked` - The retention rule is unlocked and it can be modified
+    #     or deleted by any user with the required permissions.
+    #
+    #   * `null` - The retention rule has never been locked. Once a
+    #     retention rule has been locked, it can transition between the
+    #     `locked` and `unlocked` states only; it can never transition back
+    #     to `null`.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/RuleSummary AWS API Documentation
     #
     class RuleSummary < Struct.new(
       :identifier,
       :description,
-      :retention_period)
+      :retention_period,
+      :lock_state)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -448,14 +578,6 @@ module Aws::RecycleBin
 
     # Information about the tags to assign to the retention rule.
     #
-    # @note When making an API call, you may pass Tag
-    #   data as a hash:
-    #
-    #       {
-    #         key: "TagKey", # required
-    #         value: "TagValue", # required
-    #       }
-    #
     # @!attribute [rw] key
     #   The tag key.
     #   @return [String]
@@ -473,19 +595,6 @@ module Aws::RecycleBin
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass TagResourceRequest
-    #   data as a hash:
-    #
-    #       {
-    #         resource_arn: "RuleArn", # required
-    #         tags: [ # required
-    #           {
-    #             key: "TagKey", # required
-    #             value: "TagValue", # required
-    #           },
-    #         ],
-    #       }
-    #
     # @!attribute [rw] resource_arn
     #   The Amazon Resource Name (ARN) of the retention rule.
     #   @return [String]
@@ -507,14 +616,116 @@ module Aws::RecycleBin
     #
     class TagResourceResponse < Aws::EmptyStructure; end
 
-    # @note When making an API call, you may pass UntagResourceRequest
-    #   data as a hash:
+    # Information about the retention rule unlock delay. The unlock delay is
+    # the period after which a retention rule can be modified or edited
+    # after it has been unlocked by a user with the required permissions.
+    # The retention rule can't be modified or deleted during the unlock
+    # delay.
+    #
+    # @!attribute [rw] unlock_delay_value
+    #   The unlock delay period, measured in the unit specified for <b>
+    #   UnlockDelayUnit</b>.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] unlock_delay_unit
+    #   The unit of time in which to measure the unlock delay. Currently,
+    #   the unlock delay can be measure only in days.
+    #   @return [String]
     #
-    #       {
-    #         resource_arn: "RuleArn", # required
-    #         tag_keys: ["TagKey"], # required
-    #       }
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UnlockDelay AWS API Documentation
     #
+    class UnlockDelay < Struct.new(
+      :unlock_delay_value,
+      :unlock_delay_unit)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] identifier
+    #   The unique ID of the retention rule.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UnlockRuleRequest AWS API Documentation
+    #
+    class UnlockRuleRequest < Struct.new(
+      :identifier)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] identifier
+    #   The unique ID of the retention rule.
+    #   @return [String]
+    #
+    # @!attribute [rw] description
+    #   The retention rule description.
+    #   @return [String]
+    #
+    # @!attribute [rw] resource_type
+    #   The resource type retained by the retention rule.
+    #   @return [String]
+    #
+    # @!attribute [rw] retention_period
+    #   Information about the retention period for which the retention rule
+    #   is to retain resources.
+    #   @return [Types::RetentionPeriod]
+    #
+    # @!attribute [rw] resource_tags
+    #   Information about the resource tags used to identify resources that
+    #   are retained by the retention rule.
+    #   @return [Array<Types::ResourceTag>]
+    #
+    # @!attribute [rw] status
+    #   The state of the retention rule. Only retention rules that are in
+    #   the `available` state retain resources.
+    #   @return [String]
+    #
+    # @!attribute [rw] lock_configuration
+    #   Information about the retention rule lock configuration.
+    #   @return [Types::LockConfiguration]
+    #
+    # @!attribute [rw] lock_state
+    #   The lock state for the retention rule.
+    #
+    #   * `locked` - The retention rule is locked and can't be modified or
+    #     deleted.
+    #
+    #   * `pending_unlock` - The retention rule has been unlocked but it is
+    #     still within the unlock delay period. The retention rule can be
+    #     modified or deleted only after the unlock delay period has
+    #     expired.
+    #
+    #   * `unlocked` - The retention rule is unlocked and it can be modified
+    #     or deleted by any user with the required permissions.
+    #
+    #   * `null` - The retention rule has never been locked. Once a
+    #     retention rule has been locked, it can transition between the
+    #     `locked` and `unlocked` states only; it can never transition back
+    #     to `null`.
+    #   @return [String]
+    #
+    # @!attribute [rw] lock_end_time
+    #   The date and time at which the unlock delay is set to expire. Only
+    #   returned for retention rules that have been unlocked and that are
+    #   still within the unlock delay period.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UnlockRuleResponse AWS API Documentation
+    #
+    class UnlockRuleResponse < Struct.new(
+      :identifier,
+      :description,
+      :resource_type,
+      :retention_period,
+      :resource_tags,
+      :status,
+      :lock_configuration,
+      :lock_state,
+      :lock_end_time)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] resource_arn
     #   The Amazon Resource Name (ARN) of the retention rule.
     #   @return [String]
@@ -537,25 +748,6 @@ module Aws::RecycleBin
     #
     class UntagResourceResponse < Aws::EmptyStructure; end
 
-    # @note When making an API call, you may pass UpdateRuleRequest
-    #   data as a hash:
-    #
-    #       {
-    #         identifier: "RuleIdentifier", # required
-    #         retention_period: {
-    #           retention_period_value: 1, # required
-    #           retention_period_unit: "DAYS", # required, accepts DAYS
-    #         },
-    #         description: "Description",
-    #         resource_type: "EBS_SNAPSHOT", # accepts EBS_SNAPSHOT, EC2_IMAGE
-    #         resource_tags: [
-    #           {
-    #             resource_tag_key: "ResourceTagKey", # required
-    #             resource_tag_value: "ResourceTagValue",
-    #           },
-    #         ],
-    #       }
-    #
     # @!attribute [rw] identifier
     #   The unique ID of the retention rule.
     #   @return [String]
@@ -570,10 +762,10 @@ module Aws::RecycleBin
     #   @return [String]
     #
     # @!attribute [rw] resource_type
-    #   The resource type to be retained by the retention rule. Currently,
-    #   only Amazon EBS snapshots and EBS-backed AMIs are supported. To
-    #   retain snapshots, specify `EBS_SNAPSHOT`. To retain EBS-backed AMIs,
-    #   specify `EC2_IMAGE`.
+    #   <note markdown="1"> This parameter is currently not supported. You can't update a
+    #   retention rule's resource type after creation.
+    #
+    #    </note>
     #   @return [String]
     #
     # @!attribute [rw] resource_tags
@@ -634,6 +826,32 @@ module Aws::RecycleBin
     #   the `available` state retain resources.
     #   @return [String]
     #
+    # @!attribute [rw] lock_state
+    #   The lock state for the retention rule.
+    #
+    #   * `locked` - The retention rule is locked and can't be modified or
+    #     deleted.
+    #
+    #   * `pending_unlock` - The retention rule has been unlocked but it is
+    #     still within the unlock delay period. The retention rule can be
+    #     modified or deleted only after the unlock delay period has
+    #     expired.
+    #
+    #   * `unlocked` - The retention rule is unlocked and it can be modified
+    #     or deleted by any user with the required permissions.
+    #
+    #   * `null` - The retention rule has never been locked. Once a
+    #     retention rule has been locked, it can transition between the
+    #     `locked` and `unlocked` states only; it can never transition back
+    #     to `null`.
+    #   @return [String]
+    #
+    # @!attribute [rw] lock_end_time
+    #   The date and time at which the unlock delay is set to expire. Only
+    #   returned for retention rules that have been unlocked and that are
+    #   still within the unlock delay period.
+    #   @return [Time]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UpdateRuleResponse AWS API Documentation
     #
     class UpdateRuleResponse < Struct.new(
@@ -642,7 +860,9 @@ module Aws::RecycleBin
       :description,
       :resource_type,
       :resource_tags,
-      :status)
+      :status,
+      :lock_state,
+      :lock_end_time)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-recyclebin.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-recyclebin/customizations'
 # @!group service
 module Aws::RecycleBin
 
-  GEM_VERSION = '1.6.0'
+  GEM_VERSION = '1.8.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-recyclebin
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core