aws-sdk-recyclebin 1.0.0

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

@@ -0,0 +1,652 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+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
+    #         resource_tags: [
+    #           {
+    #             resource_tag_key: "ResourceTagKey", # required
+    #             resource_tag_value: "ResourceTagValue",
+    #           },
+    #         ],
+    #       }
+    #
+    # @!attribute [rw] retention_period
+    #   Information about the retention period for which the retention rule
+    #   is to retain resources.
+    #   @return [Types::RetentionPeriod]
+    #
+    # @!attribute [rw] description
+    #   A brief description for the retention rule.
+    #   @return [String]
+    #
+    # @!attribute [rw] tags
+    #   Information about the tags to assign to the retention rule.
+    #   @return [Array<Types::Tag>]
+    #
+    # @!attribute [rw] resource_type
+    #   The resource type to be retained by the retention rule. Currently,
+    #   only Amazon EBS snapshots are supported.
+    #   @return [String]
+    #
+    # @!attribute [rw] resource_tags
+    #   Information about the resource tags to use to identify resources
+    #   that are to be retained by the retention rule. The retention rule
+    #   retains only deleted snapshots that have one or more of the
+    #   specified tag key and value pairs. If a snapshot is deleted, but it
+    #   does not have any of the specified tag key and value pairs, it is
+    #   immediately deleted without being retained by the retention rule.
+    #
+    #   You can add the same tag key and value pair to a maximum or five
+    #   retention rules.
+    #   @return [Array<Types::ResourceTag>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/CreateRuleRequest AWS API Documentation
+    #
+    class CreateRuleRequest < Struct.new(
+      :retention_period,
+      :description,
+      :tags,
+      :resource_type,
+      :resource_tags)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] identifier
+    #   The unique identifier of the retention rule.
+    #   @return [String]
+    #
+    # @!attribute [rw] retention_period
+    #   Information about the retention period for which a retention rule is
+    #   to retain resources.
+    #   @return [Types::RetentionPeriod]
+    #
+    # @!attribute [rw] description
+    #   The retention rule description.
+    #   @return [String]
+    #
+    # @!attribute [rw] tags
+    #   The tags assigned to the retention rule.
+    #   @return [Array<Types::Tag>]
+    #
+    # @!attribute [rw] resource_type
+    #   The resource type retained by the retention rule.
+    #   @return [String]
+    #
+    # @!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 snapshots.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/CreateRuleResponse AWS API Documentation
+    #
+    class CreateRuleResponse < Struct.new(
+      :identifier,
+      :retention_period,
+      :description,
+      :tags,
+      :resource_type,
+      :resource_tags,
+      :status)
+      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 to delete.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/DeleteRuleRequest AWS API Documentation
+    #
+    class DeleteRuleRequest < Struct.new(
+      :identifier)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/DeleteRuleResponse AWS API Documentation
+    #
+    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]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/GetRuleRequest AWS API Documentation
+    #
+    class GetRuleRequest < Struct.new(
+      :identifier)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] identifier
+    #   The unique ID of the retention rule.
+    #   @return [String]
+    #
+    # @!attribute [rw] description
+    #   The description assigned to the retention rule.
+    #   @return [String]
+    #
+    # @!attribute [rw] resource_type
+    #   The resource type retained by the retention rule. Currently, only
+    #   Amazon EBS snapshots are supported.
+    #   @return [String]
+    #
+    # @!attribute [rw] retention_period
+    #   Information about the period for which the retention rule retains
+    #   resources.
+    #   @return [Types::RetentionPeriod]
+    #
+    # @!attribute [rw] resource_tags
+    #   The resource tags used to identify resources that are to be 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 snapshots.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/GetRuleResponse AWS API Documentation
+    #
+    class GetRuleResponse < Struct.new(
+      :identifier,
+      :description,
+      :resource_type,
+      :retention_period,
+      :resource_tags,
+      :status)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The service could not respond to the request due to an internal
+    # problem.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/InternalServerException AWS API Documentation
+    #
+    class InternalServerException < Struct.new(
+      :message)
+      SENSITIVE = []
+      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
+    #         resource_tags: [
+    #           {
+    #             resource_tag_key: "ResourceTagKey", # required
+    #             resource_tag_value: "ResourceTagValue",
+    #           },
+    #         ],
+    #       }
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return for the request in a single
+    #   page. The remaining results can be seen by sending another request
+    #   with the returned `nextToken` value. This value can be between 5 and
+    #   500. If `maxResults` is given a larger value than 500, you receive
+    #   an error.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   The token to use to retrieve the next page of results.
+    #   @return [String]
+    #
+    # @!attribute [rw] resource_type
+    #   The resource type retained by the retention rule. Only retention
+    #   rules that retain the specified resource type are listed.
+    #   @return [String]
+    #
+    # @!attribute [rw] resource_tags
+    #   The tags used to identify resources that are to be retained by the
+    #   retention rule.
+    #   @return [Array<Types::ResourceTag>]
+    #
+    # @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)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] rules
+    #   Information about the retention rules.
+    #   @return [Array<Types::RuleSummary>]
+    #
+    # @!attribute [rw] next_token
+    #   The token to use to retrieve the next page of results. This value is
+    #   `null` when there are no more results to return.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ListRulesResponse AWS API Documentation
+    #
+    class ListRulesResponse < Struct.new(
+      :rules,
+      :next_token)
+      SENSITIVE = []
+      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 resource for which to list the
+    #   tags.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ListTagsForResourceRequest AWS API Documentation
+    #
+    class ListTagsForResourceRequest < Struct.new(
+      :resource_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] tags
+    #   Information about the tags assigned to the resource.
+    #   @return [Array<Types::Tag>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ListTagsForResourceResponse AWS API Documentation
+    #
+    class ListTagsForResourceResponse < Struct.new(
+      :tags)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The specified resource was not found.
+    #
+    # @!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/ResourceNotFoundException AWS API Documentation
+    #
+    class ResourceNotFoundException < Struct.new(
+      :message,
+      :reason)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Information about a resource tag used to identify resources that are
+    # to be retained by a Recycle Bin 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]
+    #
+    # @!attribute [rw] resource_tag_value
+    #   The tag value.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/ResourceTag AWS API Documentation
+    #
+    class ResourceTag < Struct.new(
+      :resource_tag_key,
+      :resource_tag_value)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Information about the retention period for which a 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
+    #   **RetentionPeriodUnit**.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] retention_period_unit
+    #   The unit of time in which the retention period is measured.
+    #   Currently, only `DAYS` is supported.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/RetentionPeriod AWS API Documentation
+    #
+    class RetentionPeriod < Struct.new(
+      :retention_period_value,
+      :retention_period_unit)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Information about a Recycle Bin retention rule.
+    #
+    # @!attribute [rw] identifier
+    #   The unique ID of the retention rule.
+    #   @return [String]
+    #
+    # @!attribute [rw] description
+    #   The description for the retention rule.
+    #   @return [String]
+    #
+    # @!attribute [rw] retention_period
+    #   Information about the retention period for which the retention rule
+    #   retains resources
+    #   @return [Types::RetentionPeriod]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/RuleSummary AWS API Documentation
+    #
+    class RuleSummary < Struct.new(
+      :identifier,
+      :description,
+      :retention_period)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The request would cause a service quota for the number of tags per
+    # resource to be exceeded.
+    #
+    # @!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/ServiceQuotaExceededException AWS API Documentation
+    #
+    class ServiceQuotaExceededException < Struct.new(
+      :message,
+      :reason)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Information about the tags assigned to a Recycle Bin 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]
+    #
+    # @!attribute [rw] value
+    #   The tag value.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/Tag AWS API Documentation
+    #
+    class Tag < Struct.new(
+      :key,
+      :value)
+      SENSITIVE = []
+      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 resource to which to assign
+    #   the tags.
+    #   @return [String]
+    #
+    # @!attribute [rw] tags
+    #   Information about the tags to assign to the resource.
+    #   @return [Array<Types::Tag>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/TagResourceRequest AWS API Documentation
+    #
+    class TagResourceRequest < Struct.new(
+      :resource_arn,
+      :tags)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/TagResourceResponse AWS API Documentation
+    #
+    class TagResourceResponse < Aws::EmptyStructure; end
+
+    # @note When making an API call, you may pass UntagResourceRequest
+    #   data as a hash:
+    #
+    #       {
+    #         resource_arn: "RuleArn", # required
+    #         tag_keys: ["TagKey"], # required
+    #       }
+    #
+    # @!attribute [rw] resource_arn
+    #   The Amazon Resource Name (ARN) of the resource from which to
+    #   unassign the tags.
+    #   @return [String]
+    #
+    # @!attribute [rw] tag_keys
+    #   Information about the tags to unassign from the resource.
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UntagResourceRequest AWS API Documentation
+    #
+    class UntagResourceRequest < Struct.new(
+      :resource_arn,
+      :tag_keys)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UntagResourceResponse AWS API Documentation
+    #
+    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
+    #         resource_tags: [
+    #           {
+    #             resource_tag_key: "ResourceTagKey", # required
+    #             resource_tag_value: "ResourceTagValue",
+    #           },
+    #         ],
+    #       }
+    #
+    # @!attribute [rw] identifier
+    #   The unique ID of the retention rule to update.
+    #   @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] description
+    #   The retention rule description.
+    #   @return [String]
+    #
+    # @!attribute [rw] resource_type
+    #   The resource type to be retained by the retention rule. Currently,
+    #   only Amazon EBS snapshots are supported.
+    #   @return [String]
+    #
+    # @!attribute [rw] resource_tags
+    #   Information about the resource tags to use to identify resources
+    #   that are to be retained by the retention rule. The retention rule
+    #   retains only deleted snapshots that have one or more of the
+    #   specified tag key and value pairs. If a snapshot is deleted, but it
+    #   does not have any of the specified tag key and value pairs, it is
+    #   immediately deleted without being retained by the retention rule.
+    #
+    #   You can add the same tag key and value pair to a maximum or five
+    #   retention rules.
+    #   @return [Array<Types::ResourceTag>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UpdateRuleRequest AWS API Documentation
+    #
+    class UpdateRuleRequest < Struct.new(
+      :identifier,
+      :retention_period,
+      :description,
+      :resource_type,
+      :resource_tags)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] identifier
+    #   The unique ID of the retention rule.
+    #   @return [String]
+    #
+    # @!attribute [rw] retention_period
+    #   Information about the retention period for which a retention rule is
+    #   to retain resources.
+    #   @return [Types::RetentionPeriod]
+    #
+    # @!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] 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 snapshots.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rbin-2021-06-15/UpdateRuleResponse AWS API Documentation
+    #
+    class UpdateRuleResponse < Struct.new(
+      :identifier,
+      :retention_period,
+      :description,
+      :resource_type,
+      :resource_tags,
+      :status)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # One or more of the parameters in the request is not valid.
+    #
+    # @!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/ValidationException AWS API Documentation
+    #
+    class ValidationException < Struct.new(
+      :message,
+      :reason)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+  end
+end

data/lib/aws-sdk-recyclebin.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+
+require 'aws-sdk-core'
+require 'aws-sigv4'
+
+require_relative 'aws-sdk-recyclebin/types'
+require_relative 'aws-sdk-recyclebin/client_api'
+require_relative 'aws-sdk-recyclebin/client'
+require_relative 'aws-sdk-recyclebin/errors'
+require_relative 'aws-sdk-recyclebin/resource'
+require_relative 'aws-sdk-recyclebin/customizations'
+
+# This module provides support for Amazon Recycle Bin. This module is available in the
+# `aws-sdk-recyclebin` gem.
+#
+# # Client
+#
+# The {Client} class provides one method for each API operation. Operation
+# methods each accept a hash of request parameters and return a response
+# structure.
+#
+#     recycle_bin = Aws::RecycleBin::Client.new
+#     resp = recycle_bin.create_rule(params)
+#
+# See {Client} for more information.
+#
+# # Errors
+#
+# Errors returned from Amazon Recycle Bin are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
+#
+#     begin
+#       # do stuff
+#     rescue Aws::RecycleBin::Errors::ServiceError
+#       # rescues all Amazon Recycle Bin API errors
+#     end
+#
+# See {Errors} for more information.
+#
+# @!group service
+module Aws::RecycleBin
+
+  GEM_VERSION = '1.0.0'
+
+end