aws-sdk-continuum 1.0.0

data/lib/aws-sdk-continuum/waiters.rb

@@ -0,0 +1,121 @@
+# 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/waiters'
+
+module Aws::Continuum
+  # Waiters are utility methods that poll for a particular state to occur
+  # on a client. Waiters can fail after a number of attempts at a polling
+  # interval defined for the service client.
+  #
+  # For a list of operations that can be waited for and the
+  # client methods called for each operation, see the table below or the
+  # {Client#wait_until} field documentation for the {Client}.
+  #
+  # # Invoking a Waiter
+  # To invoke a waiter, call #wait_until on a {Client}. The first parameter
+  # is the waiter name, which is specific to the service client and indicates
+  # which operation is being waited for. The second parameter is a hash of
+  # parameters that are passed to the client method called by the waiter,
+  # which varies according to the waiter name.
+  #
+  # # Wait Failures
+  # To catch errors in a waiter, use WaiterFailed,
+  # as shown in the following example.
+  #
+  #     rescue rescue Aws::Waiters::Errors::WaiterFailed => error
+  #       puts "failed waiting for instance running: #{error.message}
+  #     end
+  #
+  # # Configuring a Waiter
+  # Each waiter has a default polling interval and a maximum number of
+  # attempts it will make before returning control to your program.
+  # To set these values, use the `max_attempts` and `delay` parameters
+  # in your `#wait_until` call.
+  # The following example waits for up to 25 seconds, polling every five seconds.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.max_attempts = 5
+  #       w.delay = 5
+  #     end
+  #
+  # To disable wait failures, set the value of either of these parameters
+  # to `nil`.
+  #
+  # # Extending a Waiter
+  # To modify the behavior of waiters, you can register callbacks that are
+  # triggered before each polling attempt and before waiting.
+  #
+  # The following example implements an exponential backoff in a waiter
+  # by doubling the amount of time to wait on every attempt.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.interval = 0 # disable normal sleep
+  #       w.before_wait do |n, resp|
+  #         sleep(n ** 2)
+  #       end
+  #     end
+  #
+  # # Available 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 |
+  # | ------------------- | ---------------------- | -------- | ------------- |
+  # | code_scan_succeeded | {Client#get_code_scan} | 60       | 480           |
+  #
+  module Waiters
+
+    # Waits until the scan reaches SUCCEEDED, at which point the scan has finished and its findings are available from ListCodeFindings (filter on scanRunId). Triage of those findings and creation of issues continue asynchronously after the scan succeeds. Fails if the scan reaches FAILED. Scans run a build followed by analysis and can take from minutes to several hours. SDKs that use exponential backoff wait at least 60 seconds between polls and back off to at most 8 hours between polls, until the caller's maximum wait time elapses. SDKs and the AWS CLI that use a fixed delay poll every 60 seconds for up to 480 attempts (8 hours).
+    class CodeScanSucceeded
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (480)
+      # @option options [Integer] :delay (60)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 480,
+          delay: 60,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :get_code_scan,
+            acceptors: [
+              {
+                "matcher" => "path",
+                "argument" => "scan.status",
+                "state" => "success",
+                "expected" => "SUCCEEDED"
+              },
+              {
+                "matcher" => "path",
+                "argument" => "scan.status",
+                "state" => "failure",
+                "expected" => "FAILED"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#get_code_scan)
+      # @return (see Client#get_code_scan)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+  end
+end

data/lib/aws-sdk-continuum.rb

@@ -0,0 +1,62 @@
+# 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'
+
+Aws::Plugins::GlobalConfiguration.add_identifier(:continuum)
+
+# This module provides support for AWS Continuum. This module is available in the
+# `aws-sdk-continuum` 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.
+#
+#     continuum = Aws::Continuum::Client.new
+#     resp = continuum.associate_collector(params)
+#
+# See {Client} for more information.
+#
+# # Errors
+#
+# Errors returned from AWS Continuum are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
+#
+#     begin
+#       # do stuff
+#     rescue Aws::Continuum::Errors::ServiceError
+#       # rescues all AWS Continuum API errors
+#     end
+#
+# See {Errors} for more information.
+#
+# @!group service
+module Aws::Continuum
+  autoload :Types, 'aws-sdk-continuum/types'
+  autoload :ClientApi, 'aws-sdk-continuum/client_api'
+  module Plugins
+    autoload :Endpoints, 'aws-sdk-continuum/plugins/endpoints.rb'
+  end
+  autoload :Client, 'aws-sdk-continuum/client'
+  autoload :Errors, 'aws-sdk-continuum/errors'
+  autoload :Waiters, 'aws-sdk-continuum/waiters'
+  autoload :Resource, 'aws-sdk-continuum/resource'
+  autoload :EndpointParameters, 'aws-sdk-continuum/endpoint_parameters'
+  autoload :EndpointProvider, 'aws-sdk-continuum/endpoint_provider'
+  autoload :Endpoints, 'aws-sdk-continuum/endpoints'
+
+  GEM_VERSION = '1.0.0'
+
+end
+
+require_relative 'aws-sdk-continuum/customizations'