aws-sdk-apigateway 1.36.0 → 1.41.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 +5 -5
- data/lib/aws-sdk-apigateway.rb +7 -4
- data/lib/aws-sdk-apigateway/client.rb +102 -26
- data/lib/aws-sdk-apigateway/errors.rb +29 -7
- data/lib/aws-sdk-apigateway/resource.rb +1 -0
- data/lib/aws-sdk-apigateway/types.rb +21 -18
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: ff652ee43bb9ed9d4348fd40c28aecbcb383b426ee94794d4c818c0914cca928
|
4
|
+
data.tar.gz: f92453e7edb01392a9d8a849d37b7a0f975e01b9c71ad1815c19b271bac9ebac
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f56b34281c3c4fb9e5a8c9faae845f78902962cce739e7f6574af9434fc34fbdeea59e252ec9d366ce1f2e2fa57e45336566a0ba14355585d07941f2a67b7820
|
7
|
+
data.tar.gz: a0936cda0b2542e23dc35daa5838eaeb8686297fced1c39734eb5be4af0b5940287950a5d7b4514369ed9578edca42c23abe66ddc2eb7be78e79bcc8a0efbfbf
|
data/lib/aws-sdk-apigateway.rb
CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-apigateway/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# api_gateway = Aws::APIGateway::Client.new
|
28
|
+
# resp = api_gateway.create_api_key(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from Amazon API Gateway
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from Amazon API Gateway are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::APIGateway::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all Amazon API Gateway API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-apigateway/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::APIGateway
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.41.0'
|
46
49
|
|
47
50
|
end
|
@@ -31,6 +31,18 @@ require 'aws-sdk-apigateway/plugins/apply_content_type_header.rb'
|
|
31
31
|
Aws::Plugins::GlobalConfiguration.add_identifier(:apigateway)
|
32
32
|
|
33
33
|
module Aws::APIGateway
|
34
|
+
# An API client for APIGateway. To construct a client, you need to configure a `:region` and `:credentials`.
|
35
|
+
#
|
36
|
+
# client = Aws::APIGateway::Client.new(
|
37
|
+
# region: region_name,
|
38
|
+
# credentials: credentials,
|
39
|
+
# # ...
|
40
|
+
# )
|
41
|
+
#
|
42
|
+
# For details on configuring region and credentials see
|
43
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
44
|
+
#
|
45
|
+
# See {#initialize} for a full list of supported configuration options.
|
34
46
|
class Client < Seahorse::Client::Base
|
35
47
|
|
36
48
|
include Aws::ClientStubs
|
@@ -95,7 +107,7 @@ module Aws::APIGateway
|
|
95
107
|
# @option options [required, String] :region
|
96
108
|
# The AWS region to connect to. The configured `:region` is
|
97
109
|
# used to determine the service `:endpoint`. When not passed,
|
98
|
-
# a default `:region` is
|
110
|
+
# a default `:region` is searched for in the following locations:
|
99
111
|
#
|
100
112
|
# * `Aws.config[:region]`
|
101
113
|
# * `ENV['AWS_REGION']`
|
@@ -110,6 +122,12 @@ module Aws::APIGateway
|
|
110
122
|
# When set to `true`, a thread polling for endpoints will be running in
|
111
123
|
# the background every 60 secs (default). Defaults to `false`.
|
112
124
|
#
|
125
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
126
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
127
|
+
# until there is sufficent client side capacity to retry the request.
|
128
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
129
|
+
# not retry instead of sleeping.
|
130
|
+
#
|
113
131
|
# @option options [Boolean] :client_side_monitoring (false)
|
114
132
|
# When `true`, client-side metrics will be collected for all API requests from
|
115
133
|
# this client.
|
@@ -134,6 +152,10 @@ module Aws::APIGateway
|
|
134
152
|
# When `true`, an attempt is made to coerce request parameters into
|
135
153
|
# the required types.
|
136
154
|
#
|
155
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
156
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
157
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
158
|
+
#
|
137
159
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
138
160
|
# Set to true to disable SDK automatically adding host prefix
|
139
161
|
# to default service endpoint when available.
|
@@ -141,7 +163,7 @@ module Aws::APIGateway
|
|
141
163
|
# @option options [String] :endpoint
|
142
164
|
# The client endpoint is normally constructed from the `:region`
|
143
165
|
# option. You should only configure an `:endpoint` when connecting
|
144
|
-
# to test endpoints. This should be
|
166
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
145
167
|
#
|
146
168
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
147
169
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -156,7 +178,7 @@ module Aws::APIGateway
|
|
156
178
|
# requests fetching endpoints information. Defaults to 60 sec.
|
157
179
|
#
|
158
180
|
# @option options [Boolean] :endpoint_discovery (false)
|
159
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
181
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
160
182
|
#
|
161
183
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
162
184
|
# The log formatter.
|
@@ -168,15 +190,29 @@ module Aws::APIGateway
|
|
168
190
|
# The Logger instance to send log messages to. If this option
|
169
191
|
# is not set, logging will be disabled.
|
170
192
|
#
|
193
|
+
# @option options [Integer] :max_attempts (3)
|
194
|
+
# An integer representing the maximum number attempts that will be made for
|
195
|
+
# a single request, including the initial attempt. For example,
|
196
|
+
# setting this value to 5 will result in a request being retried up to
|
197
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
198
|
+
#
|
171
199
|
# @option options [String] :profile ("default")
|
172
200
|
# Used when loading credentials from the shared credentials file
|
173
201
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
174
202
|
#
|
203
|
+
# @option options [Proc] :retry_backoff
|
204
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
205
|
+
# This option is only used in the `legacy` retry mode.
|
206
|
+
#
|
175
207
|
# @option options [Float] :retry_base_delay (0.3)
|
176
|
-
# The base delay in seconds used by the default backoff function.
|
208
|
+
# The base delay in seconds used by the default backoff function. This option
|
209
|
+
# is only used in the `legacy` retry mode.
|
177
210
|
#
|
178
211
|
# @option options [Symbol] :retry_jitter (:none)
|
179
|
-
# A delay randomiser function used by the default backoff function.
|
212
|
+
# A delay randomiser function used by the default backoff function.
|
213
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
214
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
215
|
+
# in the `legacy` retry mode.
|
180
216
|
#
|
181
217
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
182
218
|
#
|
@@ -184,11 +220,30 @@ module Aws::APIGateway
|
|
184
220
|
# The maximum number of times to retry failed requests. Only
|
185
221
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
186
222
|
# are retried. Generally, these are throttling errors, data
|
187
|
-
# checksum errors, networking errors, timeout errors
|
188
|
-
# errors from expired credentials.
|
223
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
224
|
+
# endpoint discovery, and errors from expired credentials.
|
225
|
+
# This option is only used in the `legacy` retry mode.
|
189
226
|
#
|
190
227
|
# @option options [Integer] :retry_max_delay (0)
|
191
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
228
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
229
|
+
# used by the default backoff function. This option is only used in the
|
230
|
+
# `legacy` retry mode.
|
231
|
+
#
|
232
|
+
# @option options [String] :retry_mode ("legacy")
|
233
|
+
# Specifies which retry algorithm to use. Values are:
|
234
|
+
#
|
235
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
236
|
+
# no retry mode is provided.
|
237
|
+
#
|
238
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
239
|
+
# This includes support for retry quotas, which limit the number of
|
240
|
+
# unsuccessful retries a client can make.
|
241
|
+
#
|
242
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
243
|
+
# functionality of `standard` mode along with automatic client side
|
244
|
+
# throttling. This is a provisional mode that may change behavior
|
245
|
+
# in the future.
|
246
|
+
#
|
192
247
|
#
|
193
248
|
# @option options [String] :secret_access_key
|
194
249
|
#
|
@@ -211,16 +266,15 @@ module Aws::APIGateway
|
|
211
266
|
# requests through. Formatted like 'http://proxy.com:123'.
|
212
267
|
#
|
213
268
|
# @option options [Float] :http_open_timeout (15) The number of
|
214
|
-
# seconds to wait when opening a HTTP session before
|
269
|
+
# seconds to wait when opening a HTTP session before raising a
|
215
270
|
# `Timeout::Error`.
|
216
271
|
#
|
217
272
|
# @option options [Integer] :http_read_timeout (60) The default
|
218
273
|
# number of seconds to wait for response data. This value can
|
219
|
-
# safely be set
|
220
|
-
# per-request on the session yeidled by {#session_for}.
|
274
|
+
# safely be set per-request on the session.
|
221
275
|
#
|
222
276
|
# @option options [Float] :http_idle_timeout (5) The number of
|
223
|
-
# seconds a connection is allowed to sit
|
277
|
+
# seconds a connection is allowed to sit idle before it is
|
224
278
|
# considered stale. Stale connections are closed and removed
|
225
279
|
# from the pool before making a request.
|
226
280
|
#
|
@@ -229,7 +283,7 @@ module Aws::APIGateway
|
|
229
283
|
# request body. This option has no effect unless the request has
|
230
284
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
231
285
|
# disables this behaviour. This value can safely be set per
|
232
|
-
# request on the session
|
286
|
+
# request on the session.
|
233
287
|
#
|
234
288
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
235
289
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -277,7 +331,8 @@ module Aws::APIGateway
|
|
277
331
|
#
|
278
332
|
# @option params [Boolean] :generate_distinct_id
|
279
333
|
# Specifies whether (`true`) or not (`false`) the key identifier is
|
280
|
-
# distinct from the created API key value.
|
334
|
+
# distinct from the created API key value. This parameter is deprecated
|
335
|
+
# and should not be used.
|
281
336
|
#
|
282
337
|
# @option params [String] :value
|
283
338
|
# Specifies a value of the API key.
|
@@ -507,8 +562,8 @@ module Aws::APIGateway
|
|
507
562
|
#
|
508
563
|
# @option params [String] :stage
|
509
564
|
# The name of the API's stage that you want to use for this mapping.
|
510
|
-
# Specify '(none)' if you
|
511
|
-
#
|
565
|
+
# Specify '(none)' if you want callers to explicitly specify the stage
|
566
|
+
# name after any base path name.
|
512
567
|
#
|
513
568
|
# @return [Types::BasePathMapping] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
514
569
|
#
|
@@ -1410,9 +1465,9 @@ module Aws::APIGateway
|
|
1410
1465
|
# The description of the VPC link.
|
1411
1466
|
#
|
1412
1467
|
# @option params [required, Array<String>] :target_arns
|
1413
|
-
# \[Required\] The
|
1414
|
-
# the VPC link. The network load
|
1415
|
-
# account of the API owner.
|
1468
|
+
# \[Required\] The ARN of the network load balancer of the VPC targeted
|
1469
|
+
# by the VPC link. The network load balancer must be owned by the same
|
1470
|
+
# AWS account of the API owner.
|
1416
1471
|
#
|
1417
1472
|
# @option params [Hash<String,String>] :tags
|
1418
1473
|
# The key-value map of strings. The valid character set is
|
@@ -2200,6 +2255,8 @@ module Aws::APIGateway
|
|
2200
2255
|
# * {Types::ApiKeys#position #position} => String
|
2201
2256
|
# * {Types::ApiKeys#items #items} => Array<Types::ApiKey>
|
2202
2257
|
#
|
2258
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2259
|
+
#
|
2203
2260
|
# @example Request syntax with placeholder values
|
2204
2261
|
#
|
2205
2262
|
# resp = client.get_api_keys({
|
@@ -2405,6 +2462,8 @@ module Aws::APIGateway
|
|
2405
2462
|
# * {Types::BasePathMappings#position #position} => String
|
2406
2463
|
# * {Types::BasePathMappings#items #items} => Array<Types::BasePathMapping>
|
2407
2464
|
#
|
2465
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2466
|
+
#
|
2408
2467
|
# @example Request syntax with placeholder values
|
2409
2468
|
#
|
2410
2469
|
# resp = client.get_base_path_mappings({
|
@@ -2480,6 +2539,8 @@ module Aws::APIGateway
|
|
2480
2539
|
# * {Types::ClientCertificates#position #position} => String
|
2481
2540
|
# * {Types::ClientCertificates#items #items} => Array<Types::ClientCertificate>
|
2482
2541
|
#
|
2542
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2543
|
+
#
|
2483
2544
|
# @example Request syntax with placeholder values
|
2484
2545
|
#
|
2485
2546
|
# resp = client.get_client_certificates({
|
@@ -2577,6 +2638,8 @@ module Aws::APIGateway
|
|
2577
2638
|
# * {Types::Deployments#position #position} => String
|
2578
2639
|
# * {Types::Deployments#items #items} => Array<Types::Deployment>
|
2579
2640
|
#
|
2641
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2642
|
+
#
|
2580
2643
|
# @example Request syntax with placeholder values
|
2581
2644
|
#
|
2582
2645
|
# resp = client.get_deployments({
|
@@ -2845,6 +2908,8 @@ module Aws::APIGateway
|
|
2845
2908
|
# * {Types::DomainNames#position #position} => String
|
2846
2909
|
# * {Types::DomainNames#items #items} => Array<Types::DomainName>
|
2847
2910
|
#
|
2911
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2912
|
+
#
|
2848
2913
|
# @example Request syntax with placeholder values
|
2849
2914
|
#
|
2850
2915
|
# resp = client.get_domain_names({
|
@@ -3397,6 +3462,8 @@ module Aws::APIGateway
|
|
3397
3462
|
# * {Types::Models#position #position} => String
|
3398
3463
|
# * {Types::Models#items #items} => Array<Types::Model>
|
3399
3464
|
#
|
3465
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3466
|
+
#
|
3400
3467
|
# @example Request syntax with placeholder values
|
3401
3468
|
#
|
3402
3469
|
# resp = client.get_models({
|
@@ -3615,6 +3682,8 @@ module Aws::APIGateway
|
|
3615
3682
|
# * {Types::Resources#position #position} => String
|
3616
3683
|
# * {Types::Resources#items #items} => Array<Types::Resource>
|
3617
3684
|
#
|
3685
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3686
|
+
#
|
3618
3687
|
# @example Request syntax with placeholder values
|
3619
3688
|
#
|
3620
3689
|
# resp = client.get_resources({
|
@@ -3751,6 +3820,8 @@ module Aws::APIGateway
|
|
3751
3820
|
# * {Types::RestApis#position #position} => String
|
3752
3821
|
# * {Types::RestApis#items #items} => Array<Types::RestApi>
|
3753
3822
|
#
|
3823
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3824
|
+
#
|
3754
3825
|
# @example Request syntax with placeholder values
|
3755
3826
|
#
|
3756
3827
|
# resp = client.get_rest_apis({
|
@@ -4061,8 +4132,7 @@ module Aws::APIGateway
|
|
4061
4132
|
# Gets the Tags collection for a given resource.
|
4062
4133
|
#
|
4063
4134
|
# @option params [required, String] :resource_arn
|
4064
|
-
# \[Required\] The ARN of a resource that can be tagged.
|
4065
|
-
# ARN must be URL-encoded.
|
4135
|
+
# \[Required\] The ARN of a resource that can be tagged.
|
4066
4136
|
#
|
4067
4137
|
# @option params [String] :position
|
4068
4138
|
# (Not currently supported) The current pagination position in the paged
|
@@ -4125,6 +4195,8 @@ module Aws::APIGateway
|
|
4125
4195
|
# * {Types::Usage#position #position} => String
|
4126
4196
|
# * {Types::Usage#items #items} => Hash<String,Array<Array<Integer>>>
|
4127
4197
|
#
|
4198
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4199
|
+
#
|
4128
4200
|
# @example Request syntax with placeholder values
|
4129
4201
|
#
|
4130
4202
|
# resp = client.get_usage({
|
@@ -4266,6 +4338,8 @@ module Aws::APIGateway
|
|
4266
4338
|
# * {Types::UsagePlanKeys#position #position} => String
|
4267
4339
|
# * {Types::UsagePlanKeys#items #items} => Array<Types::UsagePlanKey>
|
4268
4340
|
#
|
4341
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4342
|
+
#
|
4269
4343
|
# @example Request syntax with placeholder values
|
4270
4344
|
#
|
4271
4345
|
# resp = client.get_usage_plan_keys({
|
@@ -4308,6 +4382,8 @@ module Aws::APIGateway
|
|
4308
4382
|
# * {Types::UsagePlans#position #position} => String
|
4309
4383
|
# * {Types::UsagePlans#items #items} => Array<Types::UsagePlan>
|
4310
4384
|
#
|
4385
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4386
|
+
#
|
4311
4387
|
# @example Request syntax with placeholder values
|
4312
4388
|
#
|
4313
4389
|
# resp = client.get_usage_plans({
|
@@ -4401,6 +4477,8 @@ module Aws::APIGateway
|
|
4401
4477
|
# * {Types::VpcLinks#position #position} => String
|
4402
4478
|
# * {Types::VpcLinks#items #items} => Array<Types::VpcLink>
|
4403
4479
|
#
|
4480
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4481
|
+
#
|
4404
4482
|
# @example Request syntax with placeholder values
|
4405
4483
|
#
|
4406
4484
|
# resp = client.get_vpc_links({
|
@@ -5297,8 +5375,7 @@ module Aws::APIGateway
|
|
5297
5375
|
# Adds or updates a tag on a given resource.
|
5298
5376
|
#
|
5299
5377
|
# @option params [required, String] :resource_arn
|
5300
|
-
# \[Required\] The ARN of a resource that can be tagged.
|
5301
|
-
# ARN must be URL-encoded.
|
5378
|
+
# \[Required\] The ARN of a resource that can be tagged.
|
5302
5379
|
#
|
5303
5380
|
# @option params [required, Hash<String,String>] :tags
|
5304
5381
|
# \[Required\] The key-value map of strings. The valid character set is
|
@@ -5507,8 +5584,7 @@ module Aws::APIGateway
|
|
5507
5584
|
# Removes a tag from a given resource.
|
5508
5585
|
#
|
5509
5586
|
# @option params [required, String] :resource_arn
|
5510
|
-
# \[Required\] The ARN of a resource that can be tagged.
|
5511
|
-
# ARN must be URL-encoded.
|
5587
|
+
# \[Required\] The ARN of a resource that can be tagged.
|
5512
5588
|
#
|
5513
5589
|
# @option params [required, Array<String>] :tag_keys
|
5514
5590
|
# \[Required\] The Tag keys to delete.
|
@@ -6915,7 +6991,7 @@ module Aws::APIGateway
|
|
6915
6991
|
params: params,
|
6916
6992
|
config: config)
|
6917
6993
|
context[:gem_name] = 'aws-sdk-apigateway'
|
6918
|
-
context[:gem_version] = '1.
|
6994
|
+
context[:gem_version] = '1.41.0'
|
6919
6995
|
Seahorse::Client::Request.new(handlers, context)
|
6920
6996
|
end
|
6921
6997
|
|
@@ -6,6 +6,35 @@
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
8
|
module Aws::APIGateway
|
9
|
+
|
10
|
+
# When APIGateway returns an error response, the Ruby SDK constructs and raises an error.
|
11
|
+
# These errors all extend Aws::APIGateway::Errors::ServiceError < {Aws::Errors::ServiceError}
|
12
|
+
#
|
13
|
+
# You can rescue all APIGateway errors using ServiceError:
|
14
|
+
#
|
15
|
+
# begin
|
16
|
+
# # do stuff
|
17
|
+
# rescue Aws::APIGateway::Errors::ServiceError
|
18
|
+
# # rescues all APIGateway API errors
|
19
|
+
# end
|
20
|
+
#
|
21
|
+
#
|
22
|
+
# ## Request Context
|
23
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
24
|
+
# information about the request that generated the error.
|
25
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
26
|
+
#
|
27
|
+
# ## Error Classes
|
28
|
+
# * {BadRequestException}
|
29
|
+
# * {ConflictException}
|
30
|
+
# * {LimitExceededException}
|
31
|
+
# * {NotFoundException}
|
32
|
+
# * {ServiceUnavailableException}
|
33
|
+
# * {TooManyRequestsException}
|
34
|
+
# * {UnauthorizedException}
|
35
|
+
#
|
36
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
37
|
+
# if they are not defined above.
|
9
38
|
module Errors
|
10
39
|
|
11
40
|
extend Aws::Errors::DynamicErrors
|
@@ -23,7 +52,6 @@ module Aws::APIGateway
|
|
23
52
|
def message
|
24
53
|
@message || @data[:message]
|
25
54
|
end
|
26
|
-
|
27
55
|
end
|
28
56
|
|
29
57
|
class ConflictException < ServiceError
|
@@ -39,7 +67,6 @@ module Aws::APIGateway
|
|
39
67
|
def message
|
40
68
|
@message || @data[:message]
|
41
69
|
end
|
42
|
-
|
43
70
|
end
|
44
71
|
|
45
72
|
class LimitExceededException < ServiceError
|
@@ -60,7 +87,6 @@ module Aws::APIGateway
|
|
60
87
|
def message
|
61
88
|
@message || @data[:message]
|
62
89
|
end
|
63
|
-
|
64
90
|
end
|
65
91
|
|
66
92
|
class NotFoundException < ServiceError
|
@@ -76,7 +102,6 @@ module Aws::APIGateway
|
|
76
102
|
def message
|
77
103
|
@message || @data[:message]
|
78
104
|
end
|
79
|
-
|
80
105
|
end
|
81
106
|
|
82
107
|
class ServiceUnavailableException < ServiceError
|
@@ -97,7 +122,6 @@ module Aws::APIGateway
|
|
97
122
|
def message
|
98
123
|
@message || @data[:message]
|
99
124
|
end
|
100
|
-
|
101
125
|
end
|
102
126
|
|
103
127
|
class TooManyRequestsException < ServiceError
|
@@ -118,7 +142,6 @@ module Aws::APIGateway
|
|
118
142
|
def message
|
119
143
|
@message || @data[:message]
|
120
144
|
end
|
121
|
-
|
122
145
|
end
|
123
146
|
|
124
147
|
class UnauthorizedException < ServiceError
|
@@ -134,7 +157,6 @@ module Aws::APIGateway
|
|
134
157
|
def message
|
135
158
|
@message || @data[:message]
|
136
159
|
end
|
137
|
-
|
138
160
|
end
|
139
161
|
|
140
162
|
end
|
@@ -22,7 +22,10 @@ module Aws::APIGateway
|
|
22
22
|
# @return [String]
|
23
23
|
#
|
24
24
|
# @!attribute [rw] destination_arn
|
25
|
-
# The ARN of the CloudWatch Logs log group
|
25
|
+
# The Amazon Resource Name (ARN) of the CloudWatch Logs log group or
|
26
|
+
# Kinesis Data Firehose delivery stream to receive access logs. If you
|
27
|
+
# specify a Kinesis Data Firehose delivery stream, the stream name
|
28
|
+
# must begin with `amazon-apigateway-`.
|
26
29
|
# @return [String]
|
27
30
|
#
|
28
31
|
class AccessLogSettings < Struct.new(
|
@@ -634,7 +637,8 @@ module Aws::APIGateway
|
|
634
637
|
#
|
635
638
|
# @!attribute [rw] generate_distinct_id
|
636
639
|
# Specifies whether (`true`) or not (`false`) the key identifier is
|
637
|
-
# distinct from the created API key value.
|
640
|
+
# distinct from the created API key value. This parameter is
|
641
|
+
# deprecated and should not be used.
|
638
642
|
# @return [Boolean]
|
639
643
|
#
|
640
644
|
# @!attribute [rw] value
|
@@ -822,8 +826,8 @@ module Aws::APIGateway
|
|
822
826
|
#
|
823
827
|
# @!attribute [rw] stage
|
824
828
|
# The name of the API's stage that you want to use for this mapping.
|
825
|
-
# Specify '(none)' if you
|
826
|
-
#
|
829
|
+
# Specify '(none)' if you want callers to explicitly specify the
|
830
|
+
# stage name after any base path name.
|
827
831
|
# @return [String]
|
828
832
|
#
|
829
833
|
class CreateBasePathMappingRequest < Struct.new(
|
@@ -1534,9 +1538,9 @@ module Aws::APIGateway
|
|
1534
1538
|
# @return [String]
|
1535
1539
|
#
|
1536
1540
|
# @!attribute [rw] target_arns
|
1537
|
-
# \[Required\] The
|
1538
|
-
# by the VPC link. The network load
|
1539
|
-
# same AWS account of the API owner.
|
1541
|
+
# \[Required\] The ARN of the network load balancer of the VPC
|
1542
|
+
# targeted by the VPC link. The network load balancer must be owned by
|
1543
|
+
# the same AWS account of the API owner.
|
1540
1544
|
# @return [Array<String>]
|
1541
1545
|
#
|
1542
1546
|
# @!attribute [rw] tags
|
@@ -4100,8 +4104,7 @@ module Aws::APIGateway
|
|
4100
4104
|
# }
|
4101
4105
|
#
|
4102
4106
|
# @!attribute [rw] resource_arn
|
4103
|
-
# \[Required\] The ARN of a resource that can be tagged.
|
4104
|
-
# ARN must be URL-encoded.
|
4107
|
+
# \[Required\] The ARN of a resource that can be tagged.
|
4105
4108
|
# @return [String]
|
4106
4109
|
#
|
4107
4110
|
# @!attribute [rw] position
|
@@ -5097,7 +5100,9 @@ module Aws::APIGateway
|
|
5097
5100
|
# Specifies the logging level for this method, which affects the log
|
5098
5101
|
# entries pushed to Amazon CloudWatch Logs. The PATCH path for this
|
5099
5102
|
# setting is `/\{method_setting_key\}/logging/loglevel`, and the
|
5100
|
-
# available levels are `OFF`, `ERROR`, and `INFO`.
|
5103
|
+
# available levels are `OFF`, `ERROR`, and `INFO`. Choose `ERROR` to
|
5104
|
+
# write only error-level entries to CloudWatch Logs, or choose `INFO`
|
5105
|
+
# to include all `ERROR` events as well as extra informational events.
|
5101
5106
|
# @return [String]
|
5102
5107
|
#
|
5103
5108
|
# @!attribute [rw] data_trace_enabled
|
@@ -6533,8 +6538,7 @@ module Aws::APIGateway
|
|
6533
6538
|
# }
|
6534
6539
|
#
|
6535
6540
|
# @!attribute [rw] resource_arn
|
6536
|
-
# \[Required\] The ARN of a resource that can be tagged.
|
6537
|
-
# ARN must be URL-encoded.
|
6541
|
+
# \[Required\] The ARN of a resource that can be tagged.
|
6538
6542
|
# @return [String]
|
6539
6543
|
#
|
6540
6544
|
# @!attribute [rw] tags
|
@@ -6579,7 +6583,7 @@ module Aws::APIGateway
|
|
6579
6583
|
#
|
6580
6584
|
#
|
6581
6585
|
#
|
6582
|
-
# [1]: https://velocity.apache.org/engine/devel/vtl-reference
|
6586
|
+
# [1]: https://velocity.apache.org/engine/devel/vtl-reference.html
|
6583
6587
|
# @return [String]
|
6584
6588
|
#
|
6585
6589
|
class Template < Struct.new(
|
@@ -6897,8 +6901,7 @@ module Aws::APIGateway
|
|
6897
6901
|
# }
|
6898
6902
|
#
|
6899
6903
|
# @!attribute [rw] resource_arn
|
6900
|
-
# \[Required\] The ARN of a resource that can be tagged.
|
6901
|
-
# ARN must be URL-encoded.
|
6904
|
+
# \[Required\] The ARN of a resource that can be tagged.
|
6902
6905
|
# @return [String]
|
6903
6906
|
#
|
6904
6907
|
# @!attribute [rw] tag_keys
|
@@ -7977,7 +7980,7 @@ module Aws::APIGateway
|
|
7977
7980
|
include Aws::Structure
|
7978
7981
|
end
|
7979
7982
|
|
7980
|
-
#
|
7983
|
+
# An API Gateway VPC link for a RestApi to access resources in an Amazon
|
7981
7984
|
# Virtual Private Cloud (VPC).
|
7982
7985
|
#
|
7983
7986
|
# <div class="remarks" markdown="1">
|
@@ -8006,8 +8009,8 @@ module Aws::APIGateway
|
|
8006
8009
|
# @return [String]
|
8007
8010
|
#
|
8008
8011
|
# @!attribute [rw] target_arns
|
8009
|
-
# The
|
8010
|
-
# link. The network load
|
8012
|
+
# The ARN of the network load balancer of the VPC targeted by the VPC
|
8013
|
+
# link. The network load balancer must be owned by the same AWS
|
8011
8014
|
# account of the API owner.
|
8012
8015
|
# @return [Array<String>]
|
8013
8016
|
#
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-apigateway
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.41.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:
|
11
|
+
date: 2020-05-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
82
82
|
version: '0'
|
83
83
|
requirements: []
|
84
84
|
rubyforge_project:
|
85
|
-
rubygems_version: 2.
|
85
|
+
rubygems_version: 2.7.6.2
|
86
86
|
signing_key:
|
87
87
|
specification_version: 4
|
88
88
|
summary: AWS SDK for Ruby - Amazon API Gateway
|