aws-sdk-apigatewaymanagementapi 1.8.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c99410827729e6288c19f52098cd68576580820e
-  data.tar.gz: 4c652a8cdf50169b0a70f2af148ee0435bb6542c
+SHA256:
+  metadata.gz: 3f60850c784b3d39c82e0f2a279dfa876afa749cb43a27744f9f84d1e1b95346
+  data.tar.gz: 3b41ddd7546c95c08c6e23f869660b93e8c387f07966f51a430d11a83d317c75
 SHA512:
-  metadata.gz: 257a369987e60a66bafe2e8a0ad185dcdd6ec3fb8ad3b21b8c08ff93c56e189c17e7933474a990f36e88656c3f4525fad111659a692be9ab38c4e84ae00511e1
-  data.tar.gz: b3ef73904bc1b84b73ec38d5ef0cb145316878945f9dffe919795143f0016b1ab38f870df44bd61f43effcbc4dab607e7f982750c7265abf4a9f3a17549279ff
+  metadata.gz: 91446891429ac8061872ce11a7485b85d72beb2645372d34568a3558ea675deedd933921e366de1c62927b04e6cdd9700908d0e3c89fac81067dd365ce3cbc3c
+  data.tar.gz: 2d451c87db4039d9e17c583e647b372149d568b8211013d3bfd1f5cb411c98754b06b63745910f0fd7dc81e66bb666648a15527a533fad1839893246b50480de

data/lib/aws-sdk-apigatewaymanagementapi.rb

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

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

@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 Aws::Plugins::GlobalConfiguration.add_identifier(:apigatewaymanagementapi)
 
 module Aws::ApiGatewayManagementApi
+  # An API client for ApiGatewayManagementApi.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #     client = Aws::ApiGatewayManagementApi::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::ApiGatewayManagementApi
     #   @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::ApiGatewayManagementApi
     #     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::ApiGatewayManagementApi
     #     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::ApiGatewayManagementApi
     #   @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
@@ -154,7 +176,7 @@ module Aws::ApiGatewayManagementApi
     #     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`.
+    #     When set to `true`, endpoint discovery will be enabled for operations when available.
     #
     #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
     #     The log formatter.
@@ -166,15 +188,29 @@ module Aws::ApiGatewayManagementApi
     #     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::ApiGatewayManagementApi
     #     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::ApiGatewayManagementApi
     #     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::ApiGatewayManagementApi
     #     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`.
@@ -254,6 +308,55 @@ module Aws::ApiGatewayManagementApi
 
     # @!group API Operations
 
+    # Delete the connection with the provided id.
+    #
+    # @option params [required, String] :connection_id
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_connection({
+    #     connection_id: "__string", # required
+    #   })
+    #
+    # @overload delete_connection(params = {})
+    # @param [Hash] params ({})
+    def delete_connection(params = {}, options = {})
+      req = build_request(:delete_connection, params)
+      req.send_request(options)
+    end
+
+    # Get information about the connection with the provided id.
+    #
+    # @option params [required, String] :connection_id
+    #
+    # @return [Types::GetConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetConnectionResponse#connected_at #connected_at} => Time
+    #   * {Types::GetConnectionResponse#identity #identity} => Types::Identity
+    #   * {Types::GetConnectionResponse#last_active_at #last_active_at} => Time
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_connection({
+    #     connection_id: "__string", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.connected_at #=> Time
+    #   resp.identity.source_ip #=> String
+    #   resp.identity.user_agent #=> String
+    #   resp.last_active_at #=> Time
+    #
+    # @overload get_connection(params = {})
+    # @param [Hash] params ({})
+    def get_connection(params = {}, options = {})
+      req = build_request(:get_connection, params)
+      req.send_request(options)
+    end
+
     # Sends the provided data to the specified connection.
     #
     # @option params [required, String, IO] :data
@@ -290,7 +393,7 @@ module Aws::ApiGatewayManagementApi
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-apigatewaymanagementapi'
-      context[:gem_version] = '1.8.0'
+      context[:gem_version] = '1.14.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -12,12 +12,38 @@ module Aws::ApiGatewayManagementApi
     include Seahorse::Model
 
     Data = Shapes::BlobShape.new(name: 'Data')
+    DeleteConnectionRequest = Shapes::StructureShape.new(name: 'DeleteConnectionRequest')
     ForbiddenException = Shapes::StructureShape.new(name: 'ForbiddenException')
+    GetConnectionRequest = Shapes::StructureShape.new(name: 'GetConnectionRequest')
+    GetConnectionResponse = Shapes::StructureShape.new(name: 'GetConnectionResponse')
     GoneException = Shapes::StructureShape.new(name: 'GoneException')
+    Identity = Shapes::StructureShape.new(name: 'Identity')
     LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
     PayloadTooLargeException = Shapes::StructureShape.new(name: 'PayloadTooLargeException')
     PostToConnectionRequest = Shapes::StructureShape.new(name: 'PostToConnectionRequest')
     __string = Shapes::StringShape.new(name: '__string')
+    __timestampIso8601 = Shapes::TimestampShape.new(name: '__timestampIso8601', timestampFormat: "iso8601")
+
+    DeleteConnectionRequest.add_member(:connection_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "connectionId"))
+    DeleteConnectionRequest.struct_class = Types::DeleteConnectionRequest
+
+    ForbiddenException.struct_class = Types::ForbiddenException
+
+    GetConnectionRequest.add_member(:connection_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "connectionId"))
+    GetConnectionRequest.struct_class = Types::GetConnectionRequest
+
+    GetConnectionResponse.add_member(:connected_at, Shapes::ShapeRef.new(shape: __timestampIso8601, location_name: "connectedAt"))
+    GetConnectionResponse.add_member(:identity, Shapes::ShapeRef.new(shape: Identity, location_name: "identity"))
+    GetConnectionResponse.add_member(:last_active_at, Shapes::ShapeRef.new(shape: __timestampIso8601, location_name: "lastActiveAt"))
+    GetConnectionResponse.struct_class = Types::GetConnectionResponse
+
+    GoneException.struct_class = Types::GoneException
+
+    Identity.add_member(:source_ip, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "sourceIp"))
+    Identity.add_member(:user_agent, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "userAgent"))
+    Identity.struct_class = Types::Identity
+
+    LimitExceededException.struct_class = Types::LimitExceededException
 
     PayloadTooLargeException.add_member(:message, Shapes::ShapeRef.new(shape: __string, location_name: "message"))
     PayloadTooLargeException.struct_class = Types::PayloadTooLargeException
@@ -46,6 +72,28 @@ module Aws::ApiGatewayManagementApi
         "uid" => "apigatewaymanagementapi-2018-11-29",
       }
 
+      api.add_operation(:delete_connection, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DeleteConnection"
+        o.http_method = "DELETE"
+        o.http_request_uri = "/@connections/{connectionId}"
+        o.input = Shapes::ShapeRef.new(shape: DeleteConnectionRequest)
+        o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
+        o.errors << Shapes::ShapeRef.new(shape: GoneException)
+        o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
+      end)
+
+      api.add_operation(:get_connection, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetConnection"
+        o.http_method = "GET"
+        o.http_request_uri = "/@connections/{connectionId}"
+        o.input = Shapes::ShapeRef.new(shape: GetConnectionRequest)
+        o.output = Shapes::ShapeRef.new(shape: GetConnectionResponse)
+        o.errors << Shapes::ShapeRef.new(shape: GoneException)
+        o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
+      end)
+
       api.add_operation(:post_to_connection, Seahorse::Model::Operation.new.tap do |o|
         o.name = "PostToConnection"
         o.http_method = "POST"

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

@@ -6,10 +6,56 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::ApiGatewayManagementApi
+
+  # When ApiGatewayManagementApi returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::ApiGatewayManagementApi::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all ApiGatewayManagementApi errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::ApiGatewayManagementApi::Errors::ServiceError
+  #       # rescues all ApiGatewayManagementApi 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
+  # * {ForbiddenException}
+  # * {GoneException}
+  # * {PayloadTooLargeException}
+  # * {LimitExceededException}
+  #
+  # 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
 
+    class ForbiddenException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::ApiGatewayManagementApi::Types::ForbiddenException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+    end
+
+    class GoneException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::ApiGatewayManagementApi::Types::GoneException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+    end
+
     class PayloadTooLargeException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -23,7 +69,16 @@ module Aws::ApiGatewayManagementApi
       def message
         @message || @data[:message]
       end
+    end
 
+    class LimitExceededException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::ApiGatewayManagementApi::Types::LimitExceededException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
     end
 
   end

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

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

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

@@ -8,6 +8,75 @@
 module Aws::ApiGatewayManagementApi
   module Types
 
+    # @note When making an API call, you may pass DeleteConnectionRequest
+    #   data as a hash:
+    #
+    #       {
+    #         connection_id: "__string", # required
+    #       }
+    #
+    # @!attribute [rw] connection_id
+    #   @return [String]
+    #
+    class DeleteConnectionRequest < Struct.new(
+      :connection_id)
+      include Aws::Structure
+    end
+
+    # The caller is not authorized to invoke this operation.
+    #
+    class ForbiddenException < Aws::EmptyStructure; end
+
+    # @note When making an API call, you may pass GetConnectionRequest
+    #   data as a hash:
+    #
+    #       {
+    #         connection_id: "__string", # required
+    #       }
+    #
+    # @!attribute [rw] connection_id
+    #   @return [String]
+    #
+    class GetConnectionRequest < Struct.new(
+      :connection_id)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] connected_at
+    #   @return [Time]
+    #
+    # @!attribute [rw] identity
+    #   @return [Types::Identity]
+    #
+    # @!attribute [rw] last_active_at
+    #   @return [Time]
+    #
+    class GetConnectionResponse < Struct.new(
+      :connected_at,
+      :identity,
+      :last_active_at)
+      include Aws::Structure
+    end
+
+    # The connection with the provided id no longer exists.
+    #
+    class GoneException < Aws::EmptyStructure; end
+
+    # @!attribute [rw] source_ip
+    #   The source IP address of the TCP connection making the request to
+    #   API Gateway.
+    #   @return [String]
+    #
+    # @!attribute [rw] user_agent
+    #   The User Agent of the API caller.
+    #   @return [String]
+    #
+    class Identity < Struct.new(
+      :source_ip,
+      :user_agent)
+      include Aws::Structure
+    end
+
     # The data has exceeded the maximum size allowed.
     #
     # @!attribute [rw] message
@@ -39,5 +108,10 @@ module Aws::ApiGatewayManagementApi
       include Aws::Structure
     end
 
+    # The client is sending more than the allowed number of requests per
+    # unit of time or the WebSocket client side buffer is full.
+    #
+    class LimitExceededException < Aws::EmptyStructure; end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-apigatewaymanagementapi
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.14.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.58.0
+        version: 3.71.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.58.0
+        version: 3.71.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -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 - AmazonApiGatewayManagementApi