aws-sdk-neptunegraph 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8374ee9fe2b9898775a118f2e18e387933104546da0339069ed361f763cfbfd
-  data.tar.gz: 07f7064f913e583be4da7147a2f8494ad084510430959bf03fe1700d44d17e36
+  metadata.gz: 6d92d892f5b9dfc5079992b0aad0658dabbe87b1b4df8ac9ef85d9a0b77dc6aa
+  data.tar.gz: d2877c397f9d8356b1fcea8fb9cbb3832b6253c0686c1fbc05957fdd4909b5cf
 SHA512:
-  metadata.gz: 7926bd6d982777b50207bdc6ece2e2db833ec3ae51043319b20f0e98abd739a7cfbe70de482cb1e6e44af5791a8bd760a5e4b36b32a15a0fd0864709468b17fa
-  data.tar.gz: 7bc7affa7e4d25db289211b4af5e85660de6d512f987790d83e64631121762094ec7eeeb4cfc27ef52bf46b0bf2108495ed2520a625df7aea9d546866888b9b2
+  metadata.gz: 505643a54e061aeda54f236192b1315c31d70746d468faf9cc9fdc9e392b0f21f6514f1ea740e8fd8e4892c3ec0902a0fb3fc162c50f4244f68445372914756d
+  data.tar.gz: 4addc61e4ac2976316e66063cba76db1570b335e8c52782728fe543b621c7cb2d98d1f98afa4e036da59919f85bb26466b186d016c7ed9be7d907a675d91dc42

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.2.0 (2024-01-26)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.1.0 (2023-12-21)
+------------------
+
+* Feature - Adds Waiters for successful creation and deletion of Graph, Graph Snapshot, Import Task and Private Endpoints for Neptune Analytics
+
 1.0.0 (2023-12-14)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.2.0

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

@@ -975,6 +975,12 @@ module Aws::NeptuneGraph
     #   resp.deletion_protection #=> Boolean
     #   resp.build_number #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * graph_available
+    #   * graph_deleted
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GetGraph AWS API Documentation
     #
     # @overload get_graph(params = {})
@@ -1015,6 +1021,12 @@ module Aws::NeptuneGraph
     #   resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "FAILED"
     #   resp.kms_key_identifier #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * graph_snapshot_available
+    #   * graph_snapshot_deleted
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GetGraphSnapshot AWS API Documentation
     #
     # @overload get_graph_snapshot(params = {})
@@ -1071,6 +1083,12 @@ module Aws::NeptuneGraph
     #   resp.attempt_number #=> Integer
     #   resp.status_reason #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * import_task_cancelled
+    #   * import_task_successful
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GetImportTask AWS API Documentation
     #
     # @overload get_import_task(params = {})
@@ -1110,6 +1128,12 @@ module Aws::NeptuneGraph
     #   resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "FAILED"
     #   resp.vpc_endpoint_id #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * private_graph_endpoint_available
+    #   * private_graph_endpoint_deleted
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/neptune-graph-2023-11-29/GetPrivateGraphEndpoint AWS API Documentation
     #
     # @overload get_private_graph_endpoint(params = {})
@@ -1679,14 +1703,141 @@ module Aws::NeptuneGraph
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-neptunegraph'
-      context[:gem_version] = '1.0.0'
+      context[:gem_version] = '1.2.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
+    # Polls an API operation until a resource enters a desired state.
+    #
+    # ## Basic Usage
+    #
+    # A waiter will call an API operation until:
+    #
+    # * It is successful
+    # * It enters a terminal state
+    # * It makes the maximum number of attempts
+    #
+    # In between attempts, the waiter will sleep.
+    #
+    #     # polls in a loop, sleeping between attempts
+    #     client.wait_until(waiter_name, params)
+    #
+    # ## Configuration
+    #
+    # You can configure the maximum number of polling attempts, and the
+    # delay (in seconds) between each polling attempt. You can pass
+    # configuration as the final arguments hash.
+    #
+    #     # poll for ~25 seconds
+    #     client.wait_until(waiter_name, params, {
+    #       max_attempts: 5,
+    #       delay: 5,
+    #     })
+    #
+    # ## Callbacks
+    #
+    # You can be notified before each polling attempt and before each
+    # delay. If you throw `:success` or `:failure` from these callbacks,
+    # it will terminate the waiter.
+    #
+    #     started_at = Time.now
+    #     client.wait_until(waiter_name, params, {
+    #
+    #       # disable max attempts
+    #       max_attempts: nil,
+    #
+    #       # poll for 1 hour, instead of a number of attempts
+    #       before_wait: -> (attempts, response) do
+    #         throw :failure if Time.now - started_at > 3600
+    #       end
+    #     })
+    #
+    # ## Handling Errors
+    #
+    # When a waiter is unsuccessful, it will raise an error.
+    # All of the failure errors extend from
+    # {Aws::Waiters::Errors::WaiterFailed}.
+    #
+    #     begin
+    #       client.wait_until(...)
+    #     rescue Aws::Waiters::Errors::WaiterFailed
+    #       # resource did not enter the desired state in time
+    #     end
+    #
+    # ## Valid Waiters
+    #
+    # The following table lists the valid waiter names, the operations they call,
+    # and the default `:delay` and `:max_attempts` values.
+    #
+    # | waiter_name                      | params                              | :delay   | :max_attempts |
+    # | -------------------------------- | ----------------------------------- | -------- | ------------- |
+    # | graph_available                  | {Client#get_graph}                  | 60       | 480           |
+    # | graph_deleted                    | {Client#get_graph}                  | 60       | 60            |
+    # | graph_snapshot_available         | {Client#get_graph_snapshot}         | 60       | 120           |
+    # | graph_snapshot_deleted           | {Client#get_graph_snapshot}         | 60       | 60            |
+    # | import_task_cancelled            | {Client#get_import_task}            | 60       | 60            |
+    # | import_task_successful           | {Client#get_import_task}            | 60       | 480           |
+    # | private_graph_endpoint_available | {Client#get_private_graph_endpoint} | 10       | 180           |
+    # | private_graph_endpoint_deleted   | {Client#get_private_graph_endpoint} | 10       | 180           |
+    #
+    # @raise [Errors::FailureStateError] Raised when the waiter terminates
+    #   because the waiter has entered a state that it will not transition
+    #   out of, preventing success.
+    #
+    # @raise [Errors::TooManyAttemptsError] Raised when the configured
+    #   maximum number of attempts have been made, and the waiter is not
+    #   yet successful.
+    #
+    # @raise [Errors::UnexpectedError] Raised when an error is encounted
+    #   while polling for a resource that is not expected.
+    #
+    # @raise [Errors::NoSuchWaiterError] Raised when you request to wait
+    #   for an unknown state.
+    #
+    # @return [Boolean] Returns `true` if the waiter was successful.
+    # @param [Symbol] waiter_name
+    # @param [Hash] params ({})
+    # @param [Hash] options ({})
+    # @option options [Integer] :max_attempts
+    # @option options [Integer] :delay
+    # @option options [Proc] :before_attempt
+    # @option options [Proc] :before_wait
+    def wait_until(waiter_name, params = {}, options = {})
+      w = waiter(waiter_name, options)
+      yield(w.waiter) if block_given? # deprecated
+      w.wait(params)
+    end
+
     # @api private
     # @deprecated
     def waiter_names
-      []
+      waiters.keys
+    end
+
+    private
+
+    # @param [Symbol] waiter_name
+    # @param [Hash] options ({})
+    def waiter(waiter_name, options = {})
+      waiter_class = waiters[waiter_name]
+      if waiter_class
+        waiter_class.new(options.merge(client: self))
+      else
+        raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
+      end
+    end
+
+    def waiters
+      {
+        graph_available: Waiters::GraphAvailable,
+        graph_deleted: Waiters::GraphDeleted,
+        graph_snapshot_available: Waiters::GraphSnapshotAvailable,
+        graph_snapshot_deleted: Waiters::GraphSnapshotDeleted,
+        import_task_cancelled: Waiters::ImportTaskCancelled,
+        import_task_successful: Waiters::ImportTaskSuccessful,
+        private_graph_endpoint_available: Waiters::PrivateGraphEndpointAvailable,
+        private_graph_endpoint_deleted: Waiters::PrivateGraphEndpointDeleted
+      }
     end
 
     class << self

data/lib/aws-sdk-neptunegraph/plugins/endpoints.rb

@@ -14,6 +14,7 @@ module Aws::NeptuneGraph
       option(
         :endpoint_provider,
         doc_type: 'Aws::NeptuneGraph::EndpointProvider',
+        rbs_type: 'untyped',
         docstring: 'The endpoint provider used to resolve endpoints. Any '\
                    'object that responds to `#resolve_endpoint(parameters)` '\
                    'where `parameters` is a Struct similar to '\