aws-sdk-apigatewaymanagementapi 1.11.0 → 1.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 9ba59dd3c6a4ea6625fc31b911c9ea68a3a1787b
4
- data.tar.gz: 4122a57f096a9affacafc9a70bbf47740b738a7b
2
+ SHA256:
3
+ metadata.gz: fb95ad5ce5fe9736699cc1512600db34e08f65fd8100deea611c3d12fc7aba9a
4
+ data.tar.gz: 7726839eaad226d6bdc570b6a3c47d4ca6a577a4110866598ff98a9a891de26c
5
5
  SHA512:
6
- metadata.gz: a8329bd72d78d86d6e5693d60ad56919156363e6544e274a8ccbbf36c090951569177031833a8d25ead3ce28e27fbc3e8ead8b9553fd4264ad15a17e13032809
7
- data.tar.gz: 87c52809b7537f8601e82cfc23372e88b5df0d819e974a3da94c5b5f58d87e48d048ba5e0ba5162cc2d3bc7778525468dca1e6c5e72009e1a6dcea0e857364b1
6
+ metadata.gz: 9cc277e036d7a4a5f52f68da471e590cfcb123c297c54ad693febe5d7603292bec2cca9b96bf151e8d19f240cf4c790c34b8676cc70746b00cff25b588d39d4c
7
+ data.tar.gz: 86dbac31ddc9f4ccd65825c9accb05286e411267b67966b8ef7523abd33e235ee0a83c3e6c588ea6cbe2b327d8f5659765dcf3799f899ddc8167bb8afc24f568
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -24,17 +26,20 @@ require_relative 'aws-sdk-apigatewaymanagementapi/customizations'
24
26
  # methods each accept a hash of request parameters and return a response
25
27
  # structure.
26
28
  #
29
+ # api_gateway_management_api = Aws::ApiGatewayManagementApi::Client.new
30
+ # resp = api_gateway_management_api.delete_connection(params)
31
+ #
27
32
  # See {Client} for more information.
28
33
  #
29
34
  # # Errors
30
35
  #
31
- # Errors returned from AmazonApiGatewayManagementApi all
32
- # extend {Errors::ServiceError}.
36
+ # Errors returned from AmazonApiGatewayManagementApi are defined in the
37
+ # {Errors} module and all extend {Errors::ServiceError}.
33
38
  #
34
39
  # begin
35
40
  # # do stuff
36
41
  # rescue Aws::ApiGatewayManagementApi::Errors::ServiceError
37
- # # rescues all service API errors
42
+ # # rescues all AmazonApiGatewayManagementApi API errors
38
43
  # end
39
44
  #
40
45
  # See {Errors} for more information.
@@ -42,6 +47,6 @@ require_relative 'aws-sdk-apigatewaymanagementapi/customizations'
42
47
  # @service
43
48
  module Aws::ApiGatewayManagementApi
44
49
 
45
- GEM_VERSION = '1.11.0'
50
+ GEM_VERSION = '1.16.0'
46
51
 
47
52
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -24,12 +26,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
26
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
30
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
31
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
29
32
 
30
33
  Aws::Plugins::GlobalConfiguration.add_identifier(:apigatewaymanagementapi)
31
34
 
32
35
  module Aws::ApiGatewayManagementApi
36
+ # An API client for ApiGatewayManagementApi. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::ApiGatewayManagementApi::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
33
48
  class Client < Seahorse::Client::Base
34
49
 
35
50
  include Aws::ClientStubs
@@ -57,6 +72,7 @@ module Aws::ApiGatewayManagementApi
57
72
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
73
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
74
  add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
60
76
  add_plugin(Aws::Plugins::SignatureV4)
61
77
  add_plugin(Aws::Plugins::Protocols::RestJson)
62
78
 
@@ -93,7 +109,7 @@ module Aws::ApiGatewayManagementApi
93
109
  # @option options [required, String] :region
94
110
  # The AWS region to connect to. The configured `:region` is
95
111
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
112
+ # a default `:region` is searched for in the following locations:
97
113
  #
98
114
  # * `Aws.config[:region]`
99
115
  # * `ENV['AWS_REGION']`
@@ -108,6 +124,12 @@ module Aws::ApiGatewayManagementApi
108
124
  # When set to `true`, a thread polling for endpoints will be running in
109
125
  # the background every 60 secs (default). Defaults to `false`.
110
126
  #
127
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
128
+ # Used only in `adaptive` retry mode. When true, the request will sleep
129
+ # until there is sufficent client side capacity to retry the request.
130
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
131
+ # not retry instead of sleeping.
132
+ #
111
133
  # @option options [Boolean] :client_side_monitoring (false)
112
134
  # When `true`, client-side metrics will be collected for all API requests from
113
135
  # this client.
@@ -132,6 +154,10 @@ module Aws::ApiGatewayManagementApi
132
154
  # When `true`, an attempt is made to coerce request parameters into
133
155
  # the required types.
134
156
  #
157
+ # @option options [Boolean] :correct_clock_skew (true)
158
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
159
+ # a clock skew correction and retry requests with skewed client clocks.
160
+ #
135
161
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
162
  # Set to true to disable SDK automatically adding host prefix
137
163
  # to default service endpoint when available.
@@ -139,7 +165,7 @@ module Aws::ApiGatewayManagementApi
139
165
  # @option options [String] :endpoint
140
166
  # The client endpoint is normally constructed from the `:region`
141
167
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
168
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
143
169
  #
144
170
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
171
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +180,7 @@ module Aws::ApiGatewayManagementApi
154
180
  # requests fetching endpoints information. Defaults to 60 sec.
155
181
  #
156
182
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
183
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
184
  #
159
185
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
186
  # The log formatter.
@@ -166,15 +192,29 @@ module Aws::ApiGatewayManagementApi
166
192
  # The Logger instance to send log messages to. If this option
167
193
  # is not set, logging will be disabled.
168
194
  #
195
+ # @option options [Integer] :max_attempts (3)
196
+ # An integer representing the maximum number attempts that will be made for
197
+ # a single request, including the initial attempt. For example,
198
+ # setting this value to 5 will result in a request being retried up to
199
+ # 4 times. Used in `standard` and `adaptive` retry modes.
200
+ #
169
201
  # @option options [String] :profile ("default")
170
202
  # Used when loading credentials from the shared credentials file
171
203
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
204
  #
205
+ # @option options [Proc] :retry_backoff
206
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
207
+ # This option is only used in the `legacy` retry mode.
208
+ #
173
209
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
210
+ # The base delay in seconds used by the default backoff function. This option
211
+ # is only used in the `legacy` retry mode.
175
212
  #
176
213
  # @option options [Symbol] :retry_jitter (:none)
177
- # 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.
214
+ # A delay randomiser function used by the default backoff function.
215
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
216
+ # otherwise a Proc that takes and returns a number. This option is only used
217
+ # in the `legacy` retry mode.
178
218
  #
179
219
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
220
  #
@@ -182,11 +222,30 @@ module Aws::ApiGatewayManagementApi
182
222
  # The maximum number of times to retry failed requests. Only
183
223
  # ~ 500 level server errors and certain ~ 400 level client errors
184
224
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
225
+ # checksum errors, networking errors, timeout errors, auth errors,
226
+ # endpoint discovery, and errors from expired credentials.
227
+ # This option is only used in the `legacy` retry mode.
187
228
  #
188
229
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
230
+ # The maximum number of seconds to delay between retries (0 for no limit)
231
+ # used by the default backoff function. This option is only used in the
232
+ # `legacy` retry mode.
233
+ #
234
+ # @option options [String] :retry_mode ("legacy")
235
+ # Specifies which retry algorithm to use. Values are:
236
+ #
237
+ # * `legacy` - The pre-existing retry behavior. This is default value if
238
+ # no retry mode is provided.
239
+ #
240
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
241
+ # This includes support for retry quotas, which limit the number of
242
+ # unsuccessful retries a client can make.
243
+ #
244
+ # * `adaptive` - An experimental retry mode that includes all the
245
+ # functionality of `standard` mode along with automatic client side
246
+ # throttling. This is a provisional mode that may change behavior
247
+ # in the future.
248
+ #
190
249
  #
191
250
  # @option options [String] :secret_access_key
192
251
  #
@@ -209,16 +268,15 @@ module Aws::ApiGatewayManagementApi
209
268
  # requests through. Formatted like 'http://proxy.com:123'.
210
269
  #
211
270
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
271
+ # seconds to wait when opening a HTTP session before raising a
213
272
  # `Timeout::Error`.
214
273
  #
215
274
  # @option options [Integer] :http_read_timeout (60) The default
216
275
  # number of seconds to wait for response data. This value can
217
- # safely be set
218
- # per-request on the session yeidled by {#session_for}.
276
+ # safely be set per-request on the session.
219
277
  #
220
278
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
279
+ # seconds a connection is allowed to sit idle before it is
222
280
  # considered stale. Stale connections are closed and removed
223
281
  # from the pool before making a request.
224
282
  #
@@ -227,7 +285,7 @@ module Aws::ApiGatewayManagementApi
227
285
  # request body. This option has no effect unless the request has
228
286
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
287
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
288
+ # request on the session.
231
289
  #
232
290
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
291
  # HTTP debug output will be sent to the `:logger`.
@@ -339,7 +397,7 @@ module Aws::ApiGatewayManagementApi
339
397
  params: params,
340
398
  config: config)
341
399
  context[:gem_name] = 'aws-sdk-apigatewaymanagementapi'
342
- context[:gem_version] = '1.11.0'
400
+ context[:gem_version] = '1.16.0'
343
401
  Seahorse::Client::Request.new(handlers, context)
344
402
  end
345
403
 
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -27,6 +29,8 @@ module Aws::ApiGatewayManagementApi
27
29
  DeleteConnectionRequest.add_member(:connection_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "connectionId"))
28
30
  DeleteConnectionRequest.struct_class = Types::DeleteConnectionRequest
29
31
 
32
+ ForbiddenException.struct_class = Types::ForbiddenException
33
+
30
34
  GetConnectionRequest.add_member(:connection_id, Shapes::ShapeRef.new(shape: __string, required: true, location: "uri", location_name: "connectionId"))
31
35
  GetConnectionRequest.struct_class = Types::GetConnectionRequest
32
36
 
@@ -35,10 +39,14 @@ module Aws::ApiGatewayManagementApi
35
39
  GetConnectionResponse.add_member(:last_active_at, Shapes::ShapeRef.new(shape: __timestampIso8601, location_name: "lastActiveAt"))
36
40
  GetConnectionResponse.struct_class = Types::GetConnectionResponse
37
41
 
42
+ GoneException.struct_class = Types::GoneException
43
+
38
44
  Identity.add_member(:source_ip, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "sourceIp"))
39
45
  Identity.add_member(:user_agent, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "userAgent"))
40
46
  Identity.struct_class = Types::Identity
41
47
 
48
+ LimitExceededException.struct_class = Types::LimitExceededException
49
+
42
50
  PayloadTooLargeException.add_member(:message, Shapes::ShapeRef.new(shape: __string, location_name: "message"))
43
51
  PayloadTooLargeException.struct_class = Types::PayloadTooLargeException
44
52
 
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -6,10 +8,56 @@
6
8
  # WARNING ABOUT GENERATED CODE
7
9
 
8
10
  module Aws::ApiGatewayManagementApi
11
+
12
+ # When ApiGatewayManagementApi returns an error response, the Ruby SDK constructs and raises an error.
13
+ # These errors all extend Aws::ApiGatewayManagementApi::Errors::ServiceError < {Aws::Errors::ServiceError}
14
+ #
15
+ # You can rescue all ApiGatewayManagementApi errors using ServiceError:
16
+ #
17
+ # begin
18
+ # # do stuff
19
+ # rescue Aws::ApiGatewayManagementApi::Errors::ServiceError
20
+ # # rescues all ApiGatewayManagementApi API errors
21
+ # end
22
+ #
23
+ #
24
+ # ## Request Context
25
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
26
+ # information about the request that generated the error.
27
+ # See {Seahorse::Client::RequestContext} for more information.
28
+ #
29
+ # ## Error Classes
30
+ # * {ForbiddenException}
31
+ # * {GoneException}
32
+ # * {PayloadTooLargeException}
33
+ # * {LimitExceededException}
34
+ #
35
+ # Additionally, error classes are dynamically generated for service errors based on the error code
36
+ # if they are not defined above.
9
37
  module Errors
10
38
 
11
39
  extend Aws::Errors::DynamicErrors
12
40
 
41
+ class ForbiddenException < ServiceError
42
+
43
+ # @param [Seahorse::Client::RequestContext] context
44
+ # @param [String] message
45
+ # @param [Aws::ApiGatewayManagementApi::Types::ForbiddenException] data
46
+ def initialize(context, message, data = Aws::EmptyStructure.new)
47
+ super(context, message, data)
48
+ end
49
+ end
50
+
51
+ class GoneException < ServiceError
52
+
53
+ # @param [Seahorse::Client::RequestContext] context
54
+ # @param [String] message
55
+ # @param [Aws::ApiGatewayManagementApi::Types::GoneException] data
56
+ def initialize(context, message, data = Aws::EmptyStructure.new)
57
+ super(context, message, data)
58
+ end
59
+ end
60
+
13
61
  class PayloadTooLargeException < ServiceError
14
62
 
15
63
  # @param [Seahorse::Client::RequestContext] context
@@ -23,7 +71,16 @@ module Aws::ApiGatewayManagementApi
23
71
  def message
24
72
  @message || @data[:message]
25
73
  end
74
+ end
26
75
 
76
+ class LimitExceededException < ServiceError
77
+
78
+ # @param [Seahorse::Client::RequestContext] context
79
+ # @param [String] message
80
+ # @param [Aws::ApiGatewayManagementApi::Types::LimitExceededException] data
81
+ def initialize(context, message, data = Aws::EmptyStructure.new)
82
+ super(context, message, data)
83
+ end
27
84
  end
28
85
 
29
86
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -6,6 +8,7 @@
6
8
  # WARNING ABOUT GENERATED CODE
7
9
 
8
10
  module Aws::ApiGatewayManagementApi
11
+
9
12
  class Resource
10
13
 
11
14
  # @param options ({})
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -20,9 +22,14 @@ module Aws::ApiGatewayManagementApi
20
22
  #
21
23
  class DeleteConnectionRequest < Struct.new(
22
24
  :connection_id)
25
+ SENSITIVE = []
23
26
  include Aws::Structure
24
27
  end
25
28
 
29
+ # The caller is not authorized to invoke this operation.
30
+ #
31
+ class ForbiddenException < Aws::EmptyStructure; end
32
+
26
33
  # @note When making an API call, you may pass GetConnectionRequest
27
34
  # data as a hash:
28
35
  #
@@ -35,6 +42,7 @@ module Aws::ApiGatewayManagementApi
35
42
  #
36
43
  class GetConnectionRequest < Struct.new(
37
44
  :connection_id)
45
+ SENSITIVE = []
38
46
  include Aws::Structure
39
47
  end
40
48
 
@@ -51,9 +59,14 @@ module Aws::ApiGatewayManagementApi
51
59
  :connected_at,
52
60
  :identity,
53
61
  :last_active_at)
62
+ SENSITIVE = []
54
63
  include Aws::Structure
55
64
  end
56
65
 
66
+ # The connection with the provided id no longer exists.
67
+ #
68
+ class GoneException < Aws::EmptyStructure; end
69
+
57
70
  # @!attribute [rw] source_ip
58
71
  # The source IP address of the TCP connection making the request to
59
72
  # API Gateway.
@@ -66,6 +79,7 @@ module Aws::ApiGatewayManagementApi
66
79
  class Identity < Struct.new(
67
80
  :source_ip,
68
81
  :user_agent)
82
+ SENSITIVE = []
69
83
  include Aws::Structure
70
84
  end
71
85
 
@@ -76,6 +90,7 @@ module Aws::ApiGatewayManagementApi
76
90
  #
77
91
  class PayloadTooLargeException < Struct.new(
78
92
  :message)
93
+ SENSITIVE = []
79
94
  include Aws::Structure
80
95
  end
81
96
 
@@ -97,8 +112,14 @@ module Aws::ApiGatewayManagementApi
97
112
  class PostToConnectionRequest < Struct.new(
98
113
  :data,
99
114
  :connection_id)
115
+ SENSITIVE = []
100
116
  include Aws::Structure
101
117
  end
102
118
 
119
+ # The client is sending more than the allowed number of requests per
120
+ # unit of time or the WebSocket client side buffer is full.
121
+ #
122
+ class LimitExceededException < Aws::EmptyStructure; end
123
+
103
124
  end
104
125
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-apigatewaymanagementapi
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.11.0
4
+ version: 1.16.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-11-05 00:00:00.000000000 Z
11
+ date: 2020-06-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.71.0
22
+ version: 3.99.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.71.0
32
+ version: 3.99.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
81
81
  version: '0'
82
82
  requirements: []
83
83
  rubyforge_project:
84
- rubygems_version: 2.5.2.3
84
+ rubygems_version: 2.7.6.2
85
85
  signing_key:
86
86
  specification_version: 4
87
87
  summary: AWS SDK for Ruby - AmazonApiGatewayManagementApi