aws-sdk-dlm 1.23.0 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b6ee7261df9e02eb056915c5898dbd7d7d332cf8
-  data.tar.gz: 8a86530aff086100469a5bcd70c274047a3b347a
+SHA256:
+  metadata.gz: f590ce7753d25c0bdabfc772e8ed8b4f8580dc9d391865f1c2d50966e35dcf0f
+  data.tar.gz: 7477fdb666252fd245633fd75890c0d80c475274d7c0c3d04d7201b65c86ce3d
 SHA512:
-  metadata.gz: 7015c803a668edf985eafe670dfdc4891259d3d01e1894db5af2822865ce8c29716fd2542f9f3d0a09af75b3d64bb5168903381849f947d22355830293641ab5
-  data.tar.gz: a1c1bc9e4b8348b1aea0c8bc2993be98eb045d3d6480cd94aef466510e06dd8232b7c5bc1f711f0c8c3afca1502b431282c7aedc39227939da8f8ac9e0761445
+  metadata.gz: 7ee8068ff066adcbe89b01c0f7c2424031add2f8662d43c9bed60e5977d46b0f3032e892ef79806704d93838f5cb0473e770d486a72d874b5a30da33906faae9
+  data.tar.gz: 468844a643d782f07ce04caeda6c423c20119f9d6e7df72dc543dc78155d3fda5362ef443bc038ebac156bee9aba0eb76542c11bb1eb514bfc5a33d00fb3ed60

data/lib/aws-sdk-dlm.rb

@@ -24,17 +24,20 @@ require_relative 'aws-sdk-dlm/customizations'
 # methods each accept a hash of request parameters and return a response
 # structure.
 #
+#     dlm = Aws::DLM::Client.new
+#     resp = dlm.create_lifecycle_policy(params)
+#
 # See {Client} for more information.
 #
 # # Errors
 #
-# Errors returned from Amazon Data Lifecycle Manager all
-# extend {Errors::ServiceError}.
+# Errors returned from Amazon Data Lifecycle Manager are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
 #
 #     begin
 #       # do stuff
 #     rescue Aws::DLM::Errors::ServiceError
-#       # rescues all service API errors
+#       # rescues all Amazon Data Lifecycle Manager API errors
 #     end
 #
 # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-dlm/customizations'
 # @service
 module Aws::DLM
 
-  GEM_VERSION = '1.23.0'
+  GEM_VERSION = '1.28.0'
 
 end

data/lib/aws-sdk-dlm/client.rb

@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 Aws::Plugins::GlobalConfiguration.add_identifier(:dlm)
 
 module Aws::DLM
+  # An API client for DLM.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #     client = Aws::DLM::Client.new(
+  #       region: region_name,
+  #       credentials: credentials,
+  #       # ...
+  #     )
+  #
+  # For details on configuring region and credentials see
+  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
+  #
+  # See {#initialize} for a full list of supported configuration options.
   class Client < Seahorse::Client::Base
 
     include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::DLM
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
     #     used to determine the service `:endpoint`. When not passed,
-    #     a default `:region` is search for in the following locations:
+    #     a default `:region` is searched for in the following locations:
     #
     #     * `Aws.config[:region]`
     #     * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::DLM
     #     When set to `true`, a thread polling for endpoints will be running in
     #     the background every 60 secs (default). Defaults to `false`.
     #
+    #   @option options [Boolean] :adaptive_retry_wait_to_fill (true)
+    #     Used only in `adaptive` retry mode.  When true, the request will sleep
+    #     until there is sufficent client side capacity to retry the request.
+    #     When false, the request will raise a `RetryCapacityNotAvailableError` and will
+    #     not retry instead of sleeping.
+    #
     #   @option options [Boolean] :client_side_monitoring (false)
     #     When `true`, client-side metrics will be collected for all API requests from
     #     this client.
@@ -132,6 +150,10 @@ module Aws::DLM
     #     When `true`, an attempt is made to coerce request parameters into
     #     the required types.
     #
+    #   @option options [Boolean] :correct_clock_skew (true)
+    #     Used only in `standard` and adaptive retry modes. Specifies whether to apply
+    #     a clock skew correction and retry requests with skewed client clocks.
+    #
     #   @option options [Boolean] :disable_host_prefix_injection (false)
     #     Set to true to disable SDK automatically adding host prefix
     #     to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::DLM
     #   @option options [String] :endpoint
     #     The client endpoint is normally constructed from the `:region`
     #     option. You should only configure an `:endpoint` when connecting
-    #     to test endpoints. This should be avalid HTTP(S) URI.
+    #     to test endpoints. This should be a valid HTTP(S) URI.
     #
     #   @option options [Integer] :endpoint_cache_max_entries (1000)
     #     Used for the maximum size limit of the LRU cache storing endpoints data
@@ -166,15 +188,29 @@ module Aws::DLM
     #     The Logger instance to send log messages to.  If this option
     #     is not set, logging will be disabled.
     #
+    #   @option options [Integer] :max_attempts (3)
+    #     An integer representing the maximum number attempts that will be made for
+    #     a single request, including the initial attempt.  For example,
+    #     setting this value to 5 will result in a request being retried up to
+    #     4 times. Used in `standard` and `adaptive` retry modes.
+    #
     #   @option options [String] :profile ("default")
     #     Used when loading credentials from the shared credentials file
     #     at HOME/.aws/credentials.  When not specified, 'default' is used.
     #
+    #   @option options [Proc] :retry_backoff
+    #     A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
+    #     This option is only used in the `legacy` retry mode.
+    #
     #   @option options [Float] :retry_base_delay (0.3)
-    #     The base delay in seconds used by the default backoff function.
+    #     The base delay in seconds used by the default backoff function. This option
+    #     is only used in the `legacy` retry mode.
     #
     #   @option options [Symbol] :retry_jitter (:none)
-    #     A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
+    #     A delay randomiser function used by the default backoff function.
+    #     Some predefined functions can be referenced by name - :none, :equal, :full,
+    #     otherwise a Proc that takes and returns a number. This option is only used
+    #     in the `legacy` retry mode.
     #
     #     @see https://www.awsarchitectureblog.com/2015/03/backoff.html
     #
@@ -182,11 +218,30 @@ module Aws::DLM
     #     The maximum number of times to retry failed requests.  Only
     #     ~ 500 level server errors and certain ~ 400 level client errors
     #     are retried.  Generally, these are throttling errors, data
-    #     checksum errors, networking errors, timeout errors and auth
-    #     errors from expired credentials.
+    #     checksum errors, networking errors, timeout errors, auth errors,
+    #     endpoint discovery, and errors from expired credentials.
+    #     This option is only used in the `legacy` retry mode.
     #
     #   @option options [Integer] :retry_max_delay (0)
-    #     The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
+    #     The maximum number of seconds to delay between retries (0 for no limit)
+    #     used by the default backoff function. This option is only used in the
+    #     `legacy` retry mode.
+    #
+    #   @option options [String] :retry_mode ("legacy")
+    #     Specifies which retry algorithm to use. Values are:
+    #
+    #     * `legacy` - The pre-existing retry behavior.  This is default value if
+    #       no retry mode is provided.
+    #
+    #     * `standard` - A standardized set of retry rules across the AWS SDKs.
+    #       This includes support for retry quotas, which limit the number of
+    #       unsuccessful retries a client can make.
+    #
+    #     * `adaptive` - An experimental retry mode that includes all the
+    #       functionality of `standard` mode along with automatic client side
+    #       throttling.  This is a provisional mode that may change behavior
+    #       in the future.
+    #
     #
     #   @option options [String] :secret_access_key
     #
@@ -209,16 +264,15 @@ module Aws::DLM
     #     requests through.  Formatted like 'http://proxy.com:123'.
     #
     #   @option options [Float] :http_open_timeout (15) The number of
-    #     seconds to wait when opening a HTTP session before rasing a
+    #     seconds to wait when opening a HTTP session before raising a
     #     `Timeout::Error`.
     #
     #   @option options [Integer] :http_read_timeout (60) The default
     #     number of seconds to wait for response data.  This value can
-    #     safely be set
-    #     per-request on the session yeidled by {#session_for}.
+    #     safely be set per-request on the session.
     #
     #   @option options [Float] :http_idle_timeout (5) The number of
-    #     seconds a connection is allowed to sit idble before it is
+    #     seconds a connection is allowed to sit idle before it is
     #     considered stale.  Stale connections are closed and removed
     #     from the pool before making a request.
     #
@@ -227,7 +281,7 @@ module Aws::DLM
     #     request body.  This option has no effect unless the request has
     #     "Expect" header set to "100-continue".  Defaults to `nil` which
     #     disables this behaviour.  This value can safely be set per
-    #     request on the session yeidled by {#session_for}.
+    #     request on the session.
     #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
@@ -310,9 +364,10 @@ module Aws::DLM
     #             },
     #           ],
     #           create_rule: {
-    #             interval: 1, # required
-    #             interval_unit: "HOURS", # required, accepts HOURS
+    #             interval: 1,
+    #             interval_unit: "HOURS", # accepts HOURS
     #             times: ["Time"],
+    #             cron_expression: "CronExpression",
     #           },
     #           retain_rule: {
     #             count: 1,
@@ -486,6 +541,7 @@ module Aws::DLM
     #   resp.policy.policy_details.schedules[0].create_rule.interval_unit #=> String, one of "HOURS"
     #   resp.policy.policy_details.schedules[0].create_rule.times #=> Array
     #   resp.policy.policy_details.schedules[0].create_rule.times[0] #=> String
+    #   resp.policy.policy_details.schedules[0].create_rule.cron_expression #=> String
     #   resp.policy.policy_details.schedules[0].retain_rule.count #=> Integer
     #   resp.policy.policy_details.schedules[0].retain_rule.interval #=> Integer
     #   resp.policy.policy_details.schedules[0].retain_rule.interval_unit #=> String, one of "DAYS", "WEEKS", "MONTHS", "YEARS"
@@ -652,9 +708,10 @@ module Aws::DLM
     #             },
     #           ],
     #           create_rule: {
-    #             interval: 1, # required
-    #             interval_unit: "HOURS", # required, accepts HOURS
+    #             interval: 1,
+    #             interval_unit: "HOURS", # accepts HOURS
     #             times: ["Time"],
+    #             cron_expression: "CronExpression",
     #           },
     #           retain_rule: {
     #             count: 1,
@@ -709,7 +766,7 @@ module Aws::DLM
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-dlm'
-      context[:gem_version] = '1.23.0'
+      context[:gem_version] = '1.28.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-dlm/client_api.rb

@@ -20,6 +20,7 @@ module Aws::DLM
     CreateLifecyclePolicyRequest = Shapes::StructureShape.new(name: 'CreateLifecyclePolicyRequest')
     CreateLifecyclePolicyResponse = Shapes::StructureShape.new(name: 'CreateLifecyclePolicyResponse')
     CreateRule = Shapes::StructureShape.new(name: 'CreateRule')
+    CronExpression = Shapes::StringShape.new(name: 'CronExpression')
     CrossRegionCopyRetainRule = Shapes::StructureShape.new(name: 'CrossRegionCopyRetainRule')
     CrossRegionCopyRule = Shapes::StructureShape.new(name: 'CrossRegionCopyRule')
     CrossRegionCopyRules = Shapes::ListShape.new(name: 'CrossRegionCopyRules')
@@ -100,9 +101,10 @@ module Aws::DLM
     CreateLifecyclePolicyResponse.add_member(:policy_id, Shapes::ShapeRef.new(shape: PolicyId, location_name: "PolicyId"))
     CreateLifecyclePolicyResponse.struct_class = Types::CreateLifecyclePolicyResponse
 
-    CreateRule.add_member(:interval, Shapes::ShapeRef.new(shape: Interval, required: true, location_name: "Interval"))
-    CreateRule.add_member(:interval_unit, Shapes::ShapeRef.new(shape: IntervalUnitValues, required: true, location_name: "IntervalUnit"))
+    CreateRule.add_member(:interval, Shapes::ShapeRef.new(shape: Interval, location_name: "Interval"))
+    CreateRule.add_member(:interval_unit, Shapes::ShapeRef.new(shape: IntervalUnitValues, location_name: "IntervalUnit"))
     CreateRule.add_member(:times, Shapes::ShapeRef.new(shape: TimesList, location_name: "Times"))
+    CreateRule.add_member(:cron_expression, Shapes::ShapeRef.new(shape: CronExpression, location_name: "CronExpression"))
     CreateRule.struct_class = Types::CreateRule
 
     CrossRegionCopyRetainRule.add_member(:interval, Shapes::ShapeRef.new(shape: Interval, location_name: "Interval"))

data/lib/aws-sdk-dlm/errors.rb

@@ -6,6 +6,32 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::DLM
+
+  # When DLM returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::DLM::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all DLM errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::DLM::Errors::ServiceError
+  #       # rescues all DLM API errors
+  #     end
+  #
+  #
+  # ## Request Context
+  # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
+  # information about the request that generated the error.
+  # See {Seahorse::Client::RequestContext} for more information.
+  #
+  # ## Error Classes
+  # * {InternalServerException}
+  # * {InvalidRequestException}
+  # * {LimitExceededException}
+  # * {ResourceNotFoundException}
+  #
+  # Additionally, error classes are dynamically generated for service errors based on the error code
+  # if they are not defined above.
   module Errors
 
     extend Aws::Errors::DynamicErrors
@@ -28,7 +54,6 @@ module Aws::DLM
       def code
         @code || @data[:code]
       end
-
     end
 
     class InvalidRequestException < ServiceError
@@ -59,7 +84,6 @@ module Aws::DLM
       def mutually_exclusive_parameters
         @data[:mutually_exclusive_parameters]
       end
-
     end
 
     class LimitExceededException < ServiceError
@@ -85,7 +109,6 @@ module Aws::DLM
       def resource_type
         @data[:resource_type]
       end
-
     end
 
     class ResourceNotFoundException < ServiceError
@@ -116,7 +139,6 @@ module Aws::DLM
       def resource_ids
         @data[:resource_ids]
       end
-
     end
 
   end

data/lib/aws-sdk-dlm/resource.rb

@@ -6,6 +6,7 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::DLM
+
   class Resource
 
     # @param options ({})

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

@@ -41,9 +41,10 @@ module Aws::DLM
     #                 },
     #               ],
     #               create_rule: {
-    #                 interval: 1, # required
-    #                 interval_unit: "HOURS", # required, accepts HOURS
+    #                 interval: 1,
+    #                 interval_unit: "HOURS", # accepts HOURS
     #                 times: ["Time"],
+    #                 cron_expression: "CronExpression",
     #               },
     #               retain_rule: {
     #                 count: 1,
@@ -125,18 +126,22 @@ module Aws::DLM
 
     # Specifies when to create snapshots of EBS volumes.
     #
+    # You must specify either a Cron expression or an interval, interval
+    # unit, and start time. You cannot specify both.
+    #
     # @note When making an API call, you may pass CreateRule
     #   data as a hash:
     #
     #       {
-    #         interval: 1, # required
-    #         interval_unit: "HOURS", # required, accepts HOURS
+    #         interval: 1,
+    #         interval_unit: "HOURS", # accepts HOURS
     #         times: ["Time"],
+    #         cron_expression: "CronExpression",
     #       }
     #
     # @!attribute [rw] interval
-    #   The interval between snapshots. The supported values are 2, 3, 4, 6,
-    #   8, 12, and 24.
+    #   The interval between snapshots. The supported values are 1, 2, 3, 4,
+    #   6, 8, 12, and 24.
     #   @return [Integer]
     #
     # @!attribute [rw] interval_unit
@@ -148,15 +153,27 @@ module Aws::DLM
     #   hh:mm.
     #
     #   The operation occurs within a one-hour window following the
-    #   specified time.
+    #   specified time. If you do not specify a time, Amazon DLM selects a
+    #   time within the next 24 hours.
     #   @return [Array<String>]
     #
+    # @!attribute [rw] cron_expression
+    #   The schedule, as a Cron expression. The schedule interval must be
+    #   between 1 hour and 1 year. For more information, see [Cron
+    #   expressions][1] in the *Amazon CloudWatch User Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/CreateRule AWS API Documentation
     #
     class CreateRule < Struct.new(
       :interval,
       :interval_unit,
-      :times)
+      :times,
+      :cron_expression)
       include Aws::Structure
     end
 
@@ -572,9 +589,9 @@ module Aws::DLM
       include Aws::Structure
     end
 
-    # Optional parameters that can be added to the policy. The set of valid
-    # parameters depends on the combination of `policyType` and
-    # `resourceType` values.
+    # Specifies optional parameters to add to a policy. The set of valid
+    # parameters depends on the combination of policy type and resource
+    # type.
     #
     # @note When making an API call, you may pass Parameters
     #   data as a hash:
@@ -584,10 +601,13 @@ module Aws::DLM
     #       }
     #
     # @!attribute [rw] exclude_boot_volume
-    #   When executing an EBS Snapshot Management – Instance policy, execute
-    #   all CreateSnapshots calls with the `excludeBootVolume` set to the
-    #   supplied field. Defaults to false. Only valid for EBS Snapshot
-    #   Management – Instance policies.
+    #   \[EBS Snapshot Management – Instance policies only\] Indicates
+    #   whether to exclude the root volume from snapshots created using
+    #   [CreateSnapshots][1]. The default is false.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSnapshots.html
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/Parameters AWS API Documentation
@@ -628,9 +648,10 @@ module Aws::DLM
     #               },
     #             ],
     #             create_rule: {
-    #               interval: 1, # required
-    #               interval_unit: "HOURS", # required, accepts HOURS
+    #               interval: 1,
+    #               interval_unit: "HOURS", # accepts HOURS
     #               times: ["Time"],
+    #               cron_expression: "CronExpression",
     #             },
     #             retain_rule: {
     #               count: 1,
@@ -663,13 +684,14 @@ module Aws::DLM
     #       }
     #
     # @!attribute [rw] policy_type
-    #   This field determines the valid target resource types and actions a
-    #   policy can manage. This field defaults to EBS\_SNAPSHOT\_MANAGEMENT
-    #   if not present.
+    #   The valid target resource types and actions a policy can manage. The
+    #   default is EBS\_SNAPSHOT\_MANAGEMENT.
     #   @return [String]
     #
     # @!attribute [rw] resource_types
-    #   The resource type.
+    #   The resource type. Use VOLUME to create snapshots of individual
+    #   volumes or use INSTANCE to create multi-volume snapshots from the
+    #   volumes for an instance.
     #   @return [Array<String>]
     #
     # @!attribute [rw] target_tags
@@ -681,7 +703,7 @@ module Aws::DLM
     #   @return [Array<Types::Schedule>]
     #
     # @!attribute [rw] parameters
-    #   A set of optional parameters that can be provided by the policy.
+    #   A set of optional parameters for the policy.
     #   @return [Types::Parameters]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/PolicyDetails AWS API Documentation
@@ -756,7 +778,7 @@ module Aws::DLM
       include Aws::Structure
     end
 
-    # Specifies a schedule.
+    # Specifies a backup schedule.
     #
     # @note When making an API call, you may pass Schedule
     #   data as a hash:
@@ -777,9 +799,10 @@ module Aws::DLM
     #           },
     #         ],
     #         create_rule: {
-    #           interval: 1, # required
-    #           interval_unit: "HOURS", # required, accepts HOURS
+    #           interval: 1,
+    #           interval_unit: "HOURS", # accepts HOURS
     #           times: ["Time"],
+    #           cron_expression: "CronExpression",
     #         },
     #         retain_rule: {
     #           count: 1,
@@ -976,9 +999,10 @@ module Aws::DLM
     #                 },
     #               ],
     #               create_rule: {
-    #                 interval: 1, # required
-    #                 interval_unit: "HOURS", # required, accepts HOURS
+    #                 interval: 1,
+    #                 interval_unit: "HOURS", # accepts HOURS
     #                 times: ["Time"],
+    #                 cron_expression: "CronExpression",
     #               },
     #               retain_rule: {
     #                 count: 1,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-dlm
 version: !ruby/object:Gem::Version
-  version: 1.23.0
+  version: 1.28.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-19 00:00:00.000000000 Z
+date: 2020-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - Amazon DLM