aws-sdk-augmentedairuntime 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3054112fbe9e4c8bbd67947aace99308b9214bc
+  data.tar.gz: 878540e4aa20c061331a2adff0498d48db3a70b7
+SHA512:
+  metadata.gz: a7768447112da30582c2b1bef2b5a22a179adace572ed6a370dd9364da8c06872bf1f559add6d542359a82dfddbfadf0032001bdeb5a60c430399b4aac4b63a6
+  data.tar.gz: c451756432d1e8a8b96ae33870ebfdefbccbcfadec14b7b3cda7d3abf4b0d13f850580fdf44131049860b9d4559ed8b0cb162635b0c5dac5aa49ebd11a7f61cc

data/lib/aws-sdk-augmentedairuntime.rb

@@ -0,0 +1,47 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'aws-sdk-core'
+require 'aws-sigv4'
+
+require_relative 'aws-sdk-augmentedairuntime/types'
+require_relative 'aws-sdk-augmentedairuntime/client_api'
+require_relative 'aws-sdk-augmentedairuntime/client'
+require_relative 'aws-sdk-augmentedairuntime/errors'
+require_relative 'aws-sdk-augmentedairuntime/resource'
+require_relative 'aws-sdk-augmentedairuntime/customizations'
+
+# This module provides support for Amazon Augmented AI Runtime. This module is available in the
+# `aws-sdk-augmentedairuntime` 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.
+#
+# See {Client} for more information.
+#
+# # Errors
+#
+# Errors returned from Amazon Augmented AI Runtime all
+# extend {Errors::ServiceError}.
+#
+#     begin
+#       # do stuff
+#     rescue Aws::AugmentedAIRuntime::Errors::ServiceError
+#       # rescues all service API errors
+#     end
+#
+# See {Errors} for more information.
+#
+# @service
+module Aws::AugmentedAIRuntime
+
+  GEM_VERSION = '1.0.0'
+
+end

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

@@ -0,0 +1,485 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'seahorse/client/plugins/content_length.rb'
+require 'aws-sdk-core/plugins/credentials_configuration.rb'
+require 'aws-sdk-core/plugins/logging.rb'
+require 'aws-sdk-core/plugins/param_converter.rb'
+require 'aws-sdk-core/plugins/param_validator.rb'
+require 'aws-sdk-core/plugins/user_agent.rb'
+require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
+require 'aws-sdk-core/plugins/retry_errors.rb'
+require 'aws-sdk-core/plugins/global_configuration.rb'
+require 'aws-sdk-core/plugins/regional_endpoint.rb'
+require 'aws-sdk-core/plugins/endpoint_discovery.rb'
+require 'aws-sdk-core/plugins/endpoint_pattern.rb'
+require 'aws-sdk-core/plugins/response_paging.rb'
+require 'aws-sdk-core/plugins/stub_responses.rb'
+require 'aws-sdk-core/plugins/idempotency_token.rb'
+require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
+require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
+require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
+require 'aws-sdk-core/plugins/transfer_encoding.rb'
+require 'aws-sdk-core/plugins/signature_v4.rb'
+require 'aws-sdk-core/plugins/protocols/rest_json.rb'
+
+Aws::Plugins::GlobalConfiguration.add_identifier(:augmentedairuntime)
+
+module Aws::AugmentedAIRuntime
+  class Client < Seahorse::Client::Base
+
+    include Aws::ClientStubs
+
+    @identifier = :augmentedairuntime
+
+    set_api(ClientApi::API)
+
+    add_plugin(Seahorse::Client::Plugins::ContentLength)
+    add_plugin(Aws::Plugins::CredentialsConfiguration)
+    add_plugin(Aws::Plugins::Logging)
+    add_plugin(Aws::Plugins::ParamConverter)
+    add_plugin(Aws::Plugins::ParamValidator)
+    add_plugin(Aws::Plugins::UserAgent)
+    add_plugin(Aws::Plugins::HelpfulSocketErrors)
+    add_plugin(Aws::Plugins::RetryErrors)
+    add_plugin(Aws::Plugins::GlobalConfiguration)
+    add_plugin(Aws::Plugins::RegionalEndpoint)
+    add_plugin(Aws::Plugins::EndpointDiscovery)
+    add_plugin(Aws::Plugins::EndpointPattern)
+    add_plugin(Aws::Plugins::ResponsePaging)
+    add_plugin(Aws::Plugins::StubResponses)
+    add_plugin(Aws::Plugins::IdempotencyToken)
+    add_plugin(Aws::Plugins::JsonvalueConverter)
+    add_plugin(Aws::Plugins::ClientMetricsPlugin)
+    add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
+    add_plugin(Aws::Plugins::TransferEncoding)
+    add_plugin(Aws::Plugins::SignatureV4)
+    add_plugin(Aws::Plugins::Protocols::RestJson)
+
+    # @overload initialize(options)
+    #   @param [Hash] options
+    #   @option options [required, Aws::CredentialProvider] :credentials
+    #     Your AWS credentials. This can be an instance of any one of the
+    #     following classes:
+    #
+    #     * `Aws::Credentials` - Used for configuring static, non-refreshing
+    #       credentials.
+    #
+    #     * `Aws::InstanceProfileCredentials` - Used for loading credentials
+    #       from an EC2 IMDS on an EC2 instance.
+    #
+    #     * `Aws::SharedCredentials` - Used for loading credentials from a
+    #       shared file, such as `~/.aws/config`.
+    #
+    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #
+    #     When `:credentials` are not configured directly, the following
+    #     locations will be searched for credentials:
+    #
+    #     * `Aws.config[:credentials]`
+    #     * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
+    #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
+    #     * `~/.aws/credentials`
+    #     * `~/.aws/config`
+    #     * EC2 IMDS instance profile - When used by default, the timeouts are
+    #       very aggressive. Construct and pass an instance of
+    #       `Aws::InstanceProfileCredentails` to enable retries and extended
+    #       timeouts.
+    #
+    #   @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:
+    #
+    #     * `Aws.config[:region]`
+    #     * `ENV['AWS_REGION']`
+    #     * `ENV['AMAZON_REGION']`
+    #     * `ENV['AWS_DEFAULT_REGION']`
+    #     * `~/.aws/credentials`
+    #     * `~/.aws/config`
+    #
+    #   @option options [String] :access_key_id
+    #
+    #   @option options [Boolean] :active_endpoint_cache (false)
+    #     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] :client_side_monitoring (false)
+    #     When `true`, client-side metrics will be collected for all API requests from
+    #     this client.
+    #
+    #   @option options [String] :client_side_monitoring_client_id ("")
+    #     Allows you to provide an identifier for this client which will be attached to
+    #     all generated client side metrics. Defaults to an empty string.
+    #
+    #   @option options [String] :client_side_monitoring_host ("127.0.0.1")
+    #     Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
+    #     side monitoring agent is running on, where client metrics will be published via UDP.
+    #
+    #   @option options [Integer] :client_side_monitoring_port (31000)
+    #     Required for publishing client metrics. The port that the client side monitoring
+    #     agent is running on, where client metrics will be published via UDP.
+    #
+    #   @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
+    #     Allows you to provide a custom client-side monitoring publisher class. By default,
+    #     will use the Client Side Monitoring Agent Publisher.
+    #
+    #   @option options [Boolean] :convert_params (true)
+    #     When `true`, an attempt is made to coerce request parameters into
+    #     the required types.
+    #
+    #   @option options [Boolean] :disable_host_prefix_injection (false)
+    #     Set to true to disable SDK automatically adding host prefix
+    #     to default service endpoint when available.
+    #
+    #   @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.
+    #
+    #   @option options [Integer] :endpoint_cache_max_entries (1000)
+    #     Used for the maximum size limit of the LRU cache storing endpoints data
+    #     for endpoint discovery enabled operations. Defaults to 1000.
+    #
+    #   @option options [Integer] :endpoint_cache_max_threads (10)
+    #     Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
+    #
+    #   @option options [Integer] :endpoint_cache_poll_interval (60)
+    #     When :endpoint_discovery and :active_endpoint_cache is enabled,
+    #     Use this option to config the time interval in seconds for making
+    #     requests fetching endpoints information. Defaults to 60 sec.
+    #
+    #   @option options [Boolean] :endpoint_discovery (false)
+    #     When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+    #
+    #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
+    #     The log formatter.
+    #
+    #   @option options [Symbol] :log_level (:info)
+    #     The log level to send messages to the `:logger` at.
+    #
+    #   @option options [Logger] :logger
+    #     The Logger instance to send log messages to.  If this option
+    #     is not set, logging will be disabled.
+    #
+    #   @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 [Float] :retry_base_delay (0.3)
+    #     The base delay in seconds used by the default backoff function.
+    #
+    #   @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.
+    #
+    #     @see https://www.awsarchitectureblog.com/2015/03/backoff.html
+    #
+    #   @option options [Integer] :retry_limit (3)
+    #     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.
+    #
+    #   @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.
+    #
+    #   @option options [String] :secret_access_key
+    #
+    #   @option options [String] :session_token
+    #
+    #   @option options [Boolean] :stub_responses (false)
+    #     Causes the client to return stubbed responses. By default
+    #     fake responses are generated and returned. You can specify
+    #     the response data to return or errors to raise by calling
+    #     {ClientStubs#stub_responses}. See {ClientStubs} for more information.
+    #
+    #     ** Please note ** When response stubbing is enabled, no HTTP
+    #     requests are made, and retries are disabled.
+    #
+    #   @option options [Boolean] :validate_params (true)
+    #     When `true`, request parameters are validated before
+    #     sending the request.
+    #
+    #   @option options [URI::HTTP,String] :http_proxy A proxy to send
+    #     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
+    #     `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}.
+    #
+    #   @option options [Float] :http_idle_timeout (5) The number of
+    #     seconds a connection is allowed to sit idble before it is
+    #     considered stale.  Stale connections are closed and removed
+    #     from the pool before making a request.
+    #
+    #   @option options [Float] :http_continue_timeout (1) The number of
+    #     seconds to wait for a 100-continue response before sending the
+    #     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}.
+    #
+    #   @option options [Boolean] :http_wire_trace (false) When `true`,
+    #     HTTP debug output will be sent to the `:logger`.
+    #
+    #   @option options [Boolean] :ssl_verify_peer (true) When `true`,
+    #     SSL peer certificates are verified when establishing a
+    #     connection.
+    #
+    #   @option options [String] :ssl_ca_bundle Full path to the SSL
+    #     certificate authority bundle file that should be used when
+    #     verifying peer certificates.  If you do not pass
+    #     `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
+    #     will be used if available.
+    #
+    #   @option options [String] :ssl_ca_directory Full path of the
+    #     directory that contains the unbundled SSL certificate
+    #     authority files for verifying peer certificates.  If you do
+    #     not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
+    #     system default will be used if available.
+    #
+    def initialize(*args)
+      super
+    end
+
+    # @!group API Operations
+
+    # Deletes the specified human loop for a flow definition.
+    #
+    # @option params [required, String] :human_loop_name
+    #   The name of the human loop you want to delete.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_human_loop({
+    #     human_loop_name: "HumanLoopName", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/DeleteHumanLoop AWS API Documentation
+    #
+    # @overload delete_human_loop(params = {})
+    # @param [Hash] params ({})
+    def delete_human_loop(params = {}, options = {})
+      req = build_request(:delete_human_loop, params)
+      req.send_request(options)
+    end
+
+    # Returns information about the specified human loop.
+    #
+    # @option params [required, String] :human_loop_name
+    #   The name of the human loop.
+    #
+    # @return [Types::DescribeHumanLoopResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeHumanLoopResponse#creation_timestamp #creation_timestamp} => Time
+    #   * {Types::DescribeHumanLoopResponse#failure_reason #failure_reason} => String
+    #   * {Types::DescribeHumanLoopResponse#failure_code #failure_code} => String
+    #   * {Types::DescribeHumanLoopResponse#human_loop_status #human_loop_status} => String
+    #   * {Types::DescribeHumanLoopResponse#human_loop_name #human_loop_name} => String
+    #   * {Types::DescribeHumanLoopResponse#human_loop_arn #human_loop_arn} => String
+    #   * {Types::DescribeHumanLoopResponse#flow_definition_arn #flow_definition_arn} => String
+    #   * {Types::DescribeHumanLoopResponse#human_loop_input #human_loop_input} => Types::HumanLoopInputContent
+    #   * {Types::DescribeHumanLoopResponse#human_loop_output #human_loop_output} => Types::HumanLoopOutputContent
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_human_loop({
+    #     human_loop_name: "HumanLoopName", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.creation_timestamp #=> Time
+    #   resp.failure_reason #=> String
+    #   resp.failure_code #=> String
+    #   resp.human_loop_status #=> String, one of "InProgress", "Failed", "Completed", "Stopped", "Stopping"
+    #   resp.human_loop_name #=> String
+    #   resp.human_loop_arn #=> String
+    #   resp.flow_definition_arn #=> String
+    #   resp.human_loop_input.input_content #=> String
+    #   resp.human_loop_output.output_s3_uri #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/DescribeHumanLoop AWS API Documentation
+    #
+    # @overload describe_human_loop(params = {})
+    # @param [Hash] params ({})
+    def describe_human_loop(params = {}, options = {})
+      req = build_request(:describe_human_loop, params)
+      req.send_request(options)
+    end
+
+    # Returns information about human loops, given the specified parameters.
+    #
+    # @option params [Time,DateTime,Date,Integer,String] :creation_time_after
+    #   (Optional) The timestamp of the date when you want the human loops to
+    #   begin. For example, `1551000000`.
+    #
+    # @option params [Time,DateTime,Date,Integer,String] :creation_time_before
+    #   (Optional) The timestamp of the date before which you want the human
+    #   loops to begin. For example, `1550000000`.
+    #
+    # @option params [String] :sort_order
+    #   An optional value that specifies whether you want the results sorted
+    #   in `Ascending` or `Descending` order.
+    #
+    # @option params [String] :next_token
+    #   A token to resume pagination.
+    #
+    # @option params [Integer] :max_results
+    #   The total number of items to return. If the total number of available
+    #   items is more than the value specified in `MaxResults`, then a
+    #   `NextToken` will be provided in the output that you can use to resume
+    #   pagination.
+    #
+    # @return [Types::ListHumanLoopsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListHumanLoopsResponse#human_loop_summaries #human_loop_summaries} => Array&lt;Types::HumanLoopSummary&gt;
+    #   * {Types::ListHumanLoopsResponse#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_human_loops({
+    #     creation_time_after: Time.now,
+    #     creation_time_before: Time.now,
+    #     sort_order: "Ascending", # accepts Ascending, Descending
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.human_loop_summaries #=> Array
+    #   resp.human_loop_summaries[0].human_loop_name #=> String
+    #   resp.human_loop_summaries[0].human_loop_status #=> String, one of "InProgress", "Failed", "Completed", "Stopped", "Stopping"
+    #   resp.human_loop_summaries[0].creation_time #=> Time
+    #   resp.human_loop_summaries[0].failure_reason #=> String
+    #   resp.human_loop_summaries[0].flow_definition_arn #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/ListHumanLoops AWS API Documentation
+    #
+    # @overload list_human_loops(params = {})
+    # @param [Hash] params ({})
+    def list_human_loops(params = {}, options = {})
+      req = build_request(:list_human_loops, params)
+      req.send_request(options)
+    end
+
+    # Starts a human loop, provided that at least one activation condition
+    # is met.
+    #
+    # @option params [required, String] :human_loop_name
+    #   The name of the human loop.
+    #
+    # @option params [required, String] :flow_definition_arn
+    #   The Amazon Resource Name (ARN) of the flow definition.
+    #
+    # @option params [required, Types::HumanLoopInputContent] :human_loop_input
+    #   An object containing information about the human loop.
+    #
+    # @option params [Types::HumanReviewDataAttributes] :data_attributes
+    #   Attributes of the data specified by the customer.
+    #
+    # @return [Types::StartHumanLoopResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::StartHumanLoopResponse#human_loop_arn #human_loop_arn} => String
+    #   * {Types::StartHumanLoopResponse#human_loop_activation_results #human_loop_activation_results} => Types::HumanLoopActivationResults
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.start_human_loop({
+    #     human_loop_name: "HumanLoopName", # required
+    #     flow_definition_arn: "FlowDefinitionArn", # required
+    #     human_loop_input: { # required
+    #       input_content: "InputContent", # required
+    #     },
+    #     data_attributes: {
+    #       content_classifiers: ["FreeOfPersonallyIdentifiableInformation"], # required, accepts FreeOfPersonallyIdentifiableInformation, FreeOfAdultContent
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.human_loop_arn #=> String
+    #   resp.human_loop_activation_results.human_loop_activation_reason.conditions_matched #=> Boolean
+    #   resp.human_loop_activation_results.human_loop_activation_conditions_evaluation_results #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/StartHumanLoop AWS API Documentation
+    #
+    # @overload start_human_loop(params = {})
+    # @param [Hash] params ({})
+    def start_human_loop(params = {}, options = {})
+      req = build_request(:start_human_loop, params)
+      req.send_request(options)
+    end
+
+    # Stops the specified human loop.
+    #
+    # @option params [required, String] :human_loop_name
+    #   The name of the human loop you want to stop.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.stop_human_loop({
+    #     human_loop_name: "HumanLoopName", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/StopHumanLoop AWS API Documentation
+    #
+    # @overload stop_human_loop(params = {})
+    # @param [Hash] params ({})
+    def stop_human_loop(params = {}, options = {})
+      req = build_request(:stop_human_loop, params)
+      req.send_request(options)
+    end
+
+    # @!endgroup
+
+    # @param params ({})
+    # @api private
+    def build_request(operation_name, params = {})
+      handlers = @handlers.for(operation_name)
+      context = Seahorse::Client::RequestContext.new(
+        operation_name: operation_name,
+        operation: config.api.operation(operation_name),
+        client: self,
+        params: params,
+        config: config)
+      context[:gem_name] = 'aws-sdk-augmentedairuntime'
+      context[:gem_version] = '1.0.0'
+      Seahorse::Client::Request.new(handlers, context)
+    end
+
+    # @api private
+    # @deprecated
+    def waiter_names
+      []
+    end
+
+    class << self
+
+      # @api private
+      attr_reader :identifier
+
+      # @api private
+      def errors_module
+        Errors
+      end
+
+    end
+  end
+end