aws-sdk-apigateway 1.37.0 → 1.38.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 +1 -1
- data/lib/aws-sdk-apigateway/client.rb +55 -30
- data/lib/aws-sdk-apigateway/resource.rb +1 -7
- data/lib/aws-sdk-apigateway/types.rb +20 -17
- 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: 2f0c39e53a8c384e134696151f3403d97ee0681ee0ec7fddabe0ab87ffb532a1
|
4
|
+
data.tar.gz: 22cb946f211bdafa4e998932ad2d13fae4c7546989ad21955cff2c3f9c55b337
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7181740af87f499c17f53bf72d64e87f74d3dde00eb9732913753cd444ef42aef25a79b7057a1b3602c92c846a4993e615a5d95d56888549c2be6a8ed4eca8b2
|
7
|
+
data.tar.gz: 2a57161af1c737d206612d63c4b0d40a8b4691bf59081bf72463f0b54814354bb2c198a524c0093b0c6c7fff232e3a8dfaafe6077ec63eb855e36174c1f627b2
|
data/lib/aws-sdk-apigateway.rb
CHANGED
@@ -33,11 +33,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:apigateway)
|
|
33
33
|
module Aws::APIGateway
|
34
34
|
# An API client for APIGateway. To construct a client, you need to configure a `:region` and `:credentials`.
|
35
35
|
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
40
|
-
#
|
36
|
+
# client = Aws::APIGateway::Client.new(
|
37
|
+
# region: region_name,
|
38
|
+
# credentials: credentials,
|
39
|
+
# # ...
|
40
|
+
# )
|
41
41
|
#
|
42
42
|
# For details on configuring region and credentials see
|
43
43
|
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
@@ -231,15 +231,19 @@ module Aws::APIGateway
|
|
231
231
|
#
|
232
232
|
# @option options [String] :retry_mode ("legacy")
|
233
233
|
# Specifies which retry algorithm to use. Values are:
|
234
|
-
#
|
235
|
-
#
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
241
|
-
#
|
242
|
-
#
|
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
|
+
#
|
243
247
|
#
|
244
248
|
# @option options [String] :secret_access_key
|
245
249
|
#
|
@@ -267,8 +271,7 @@ module Aws::APIGateway
|
|
267
271
|
#
|
268
272
|
# @option options [Integer] :http_read_timeout (60) The default
|
269
273
|
# number of seconds to wait for response data. This value can
|
270
|
-
# safely be set
|
271
|
-
# per-request on the session yielded by {#session_for}.
|
274
|
+
# safely be set per-request on the session.
|
272
275
|
#
|
273
276
|
# @option options [Float] :http_idle_timeout (5) The number of
|
274
277
|
# seconds a connection is allowed to sit idle before it is
|
@@ -280,7 +283,7 @@ module Aws::APIGateway
|
|
280
283
|
# request body. This option has no effect unless the request has
|
281
284
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
282
285
|
# disables this behaviour. This value can safely be set per
|
283
|
-
# request on the session
|
286
|
+
# request on the session.
|
284
287
|
#
|
285
288
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
286
289
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -328,7 +331,8 @@ module Aws::APIGateway
|
|
328
331
|
#
|
329
332
|
# @option params [Boolean] :generate_distinct_id
|
330
333
|
# Specifies whether (`true`) or not (`false`) the key identifier is
|
331
|
-
# 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.
|
332
336
|
#
|
333
337
|
# @option params [String] :value
|
334
338
|
# Specifies a value of the API key.
|
@@ -558,8 +562,8 @@ module Aws::APIGateway
|
|
558
562
|
#
|
559
563
|
# @option params [String] :stage
|
560
564
|
# The name of the API's stage that you want to use for this mapping.
|
561
|
-
# Specify '(none)' if you
|
562
|
-
#
|
565
|
+
# Specify '(none)' if you want callers to explicitly specify the stage
|
566
|
+
# name after any base path name.
|
563
567
|
#
|
564
568
|
# @return [Types::BasePathMapping] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
565
569
|
#
|
@@ -1461,9 +1465,9 @@ module Aws::APIGateway
|
|
1461
1465
|
# The description of the VPC link.
|
1462
1466
|
#
|
1463
1467
|
# @option params [required, Array<String>] :target_arns
|
1464
|
-
# \[Required\] The
|
1465
|
-
# the VPC link. The network load
|
1466
|
-
# 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.
|
1467
1471
|
#
|
1468
1472
|
# @option params [Hash<String,String>] :tags
|
1469
1473
|
# The key-value map of strings. The valid character set is
|
@@ -2251,6 +2255,8 @@ module Aws::APIGateway
|
|
2251
2255
|
# * {Types::ApiKeys#position #position} => String
|
2252
2256
|
# * {Types::ApiKeys#items #items} => Array<Types::ApiKey>
|
2253
2257
|
#
|
2258
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2259
|
+
#
|
2254
2260
|
# @example Request syntax with placeholder values
|
2255
2261
|
#
|
2256
2262
|
# resp = client.get_api_keys({
|
@@ -2456,6 +2462,8 @@ module Aws::APIGateway
|
|
2456
2462
|
# * {Types::BasePathMappings#position #position} => String
|
2457
2463
|
# * {Types::BasePathMappings#items #items} => Array<Types::BasePathMapping>
|
2458
2464
|
#
|
2465
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2466
|
+
#
|
2459
2467
|
# @example Request syntax with placeholder values
|
2460
2468
|
#
|
2461
2469
|
# resp = client.get_base_path_mappings({
|
@@ -2531,6 +2539,8 @@ module Aws::APIGateway
|
|
2531
2539
|
# * {Types::ClientCertificates#position #position} => String
|
2532
2540
|
# * {Types::ClientCertificates#items #items} => Array<Types::ClientCertificate>
|
2533
2541
|
#
|
2542
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2543
|
+
#
|
2534
2544
|
# @example Request syntax with placeholder values
|
2535
2545
|
#
|
2536
2546
|
# resp = client.get_client_certificates({
|
@@ -2628,6 +2638,8 @@ module Aws::APIGateway
|
|
2628
2638
|
# * {Types::Deployments#position #position} => String
|
2629
2639
|
# * {Types::Deployments#items #items} => Array<Types::Deployment>
|
2630
2640
|
#
|
2641
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2642
|
+
#
|
2631
2643
|
# @example Request syntax with placeholder values
|
2632
2644
|
#
|
2633
2645
|
# resp = client.get_deployments({
|
@@ -2896,6 +2908,8 @@ module Aws::APIGateway
|
|
2896
2908
|
# * {Types::DomainNames#position #position} => String
|
2897
2909
|
# * {Types::DomainNames#items #items} => Array<Types::DomainName>
|
2898
2910
|
#
|
2911
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2912
|
+
#
|
2899
2913
|
# @example Request syntax with placeholder values
|
2900
2914
|
#
|
2901
2915
|
# resp = client.get_domain_names({
|
@@ -3448,6 +3462,8 @@ module Aws::APIGateway
|
|
3448
3462
|
# * {Types::Models#position #position} => String
|
3449
3463
|
# * {Types::Models#items #items} => Array<Types::Model>
|
3450
3464
|
#
|
3465
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3466
|
+
#
|
3451
3467
|
# @example Request syntax with placeholder values
|
3452
3468
|
#
|
3453
3469
|
# resp = client.get_models({
|
@@ -3666,6 +3682,8 @@ module Aws::APIGateway
|
|
3666
3682
|
# * {Types::Resources#position #position} => String
|
3667
3683
|
# * {Types::Resources#items #items} => Array<Types::Resource>
|
3668
3684
|
#
|
3685
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3686
|
+
#
|
3669
3687
|
# @example Request syntax with placeholder values
|
3670
3688
|
#
|
3671
3689
|
# resp = client.get_resources({
|
@@ -3802,6 +3820,8 @@ module Aws::APIGateway
|
|
3802
3820
|
# * {Types::RestApis#position #position} => String
|
3803
3821
|
# * {Types::RestApis#items #items} => Array<Types::RestApi>
|
3804
3822
|
#
|
3823
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3824
|
+
#
|
3805
3825
|
# @example Request syntax with placeholder values
|
3806
3826
|
#
|
3807
3827
|
# resp = client.get_rest_apis({
|
@@ -4112,8 +4132,7 @@ module Aws::APIGateway
|
|
4112
4132
|
# Gets the Tags collection for a given resource.
|
4113
4133
|
#
|
4114
4134
|
# @option params [required, String] :resource_arn
|
4115
|
-
# \[Required\] The ARN of a resource that can be tagged.
|
4116
|
-
# ARN must be URL-encoded.
|
4135
|
+
# \[Required\] The ARN of a resource that can be tagged.
|
4117
4136
|
#
|
4118
4137
|
# @option params [String] :position
|
4119
4138
|
# (Not currently supported) The current pagination position in the paged
|
@@ -4176,6 +4195,8 @@ module Aws::APIGateway
|
|
4176
4195
|
# * {Types::Usage#position #position} => String
|
4177
4196
|
# * {Types::Usage#items #items} => Hash<String,Array<Array<Integer>>>
|
4178
4197
|
#
|
4198
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4199
|
+
#
|
4179
4200
|
# @example Request syntax with placeholder values
|
4180
4201
|
#
|
4181
4202
|
# resp = client.get_usage({
|
@@ -4317,6 +4338,8 @@ module Aws::APIGateway
|
|
4317
4338
|
# * {Types::UsagePlanKeys#position #position} => String
|
4318
4339
|
# * {Types::UsagePlanKeys#items #items} => Array<Types::UsagePlanKey>
|
4319
4340
|
#
|
4341
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4342
|
+
#
|
4320
4343
|
# @example Request syntax with placeholder values
|
4321
4344
|
#
|
4322
4345
|
# resp = client.get_usage_plan_keys({
|
@@ -4359,6 +4382,8 @@ module Aws::APIGateway
|
|
4359
4382
|
# * {Types::UsagePlans#position #position} => String
|
4360
4383
|
# * {Types::UsagePlans#items #items} => Array<Types::UsagePlan>
|
4361
4384
|
#
|
4385
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4386
|
+
#
|
4362
4387
|
# @example Request syntax with placeholder values
|
4363
4388
|
#
|
4364
4389
|
# resp = client.get_usage_plans({
|
@@ -4452,6 +4477,8 @@ module Aws::APIGateway
|
|
4452
4477
|
# * {Types::VpcLinks#position #position} => String
|
4453
4478
|
# * {Types::VpcLinks#items #items} => Array<Types::VpcLink>
|
4454
4479
|
#
|
4480
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4481
|
+
#
|
4455
4482
|
# @example Request syntax with placeholder values
|
4456
4483
|
#
|
4457
4484
|
# resp = client.get_vpc_links({
|
@@ -5348,8 +5375,7 @@ module Aws::APIGateway
|
|
5348
5375
|
# Adds or updates a tag on a given resource.
|
5349
5376
|
#
|
5350
5377
|
# @option params [required, String] :resource_arn
|
5351
|
-
# \[Required\] The ARN of a resource that can be tagged.
|
5352
|
-
# ARN must be URL-encoded.
|
5378
|
+
# \[Required\] The ARN of a resource that can be tagged.
|
5353
5379
|
#
|
5354
5380
|
# @option params [required, Hash<String,String>] :tags
|
5355
5381
|
# \[Required\] The key-value map of strings. The valid character set is
|
@@ -5558,8 +5584,7 @@ module Aws::APIGateway
|
|
5558
5584
|
# Removes a tag from a given resource.
|
5559
5585
|
#
|
5560
5586
|
# @option params [required, String] :resource_arn
|
5561
|
-
# \[Required\] The ARN of a resource that can be tagged.
|
5562
|
-
# ARN must be URL-encoded.
|
5587
|
+
# \[Required\] The ARN of a resource that can be tagged.
|
5563
5588
|
#
|
5564
5589
|
# @option params [required, Array<String>] :tag_keys
|
5565
5590
|
# \[Required\] The Tag keys to delete.
|
@@ -6966,7 +6991,7 @@ module Aws::APIGateway
|
|
6966
6991
|
params: params,
|
6967
6992
|
config: config)
|
6968
6993
|
context[:gem_name] = 'aws-sdk-apigateway'
|
6969
|
-
context[:gem_version] = '1.
|
6994
|
+
context[:gem_version] = '1.38.0'
|
6970
6995
|
Seahorse::Client::Request.new(handlers, context)
|
6971
6996
|
end
|
6972
6997
|
|
@@ -6,13 +6,7 @@
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
8
|
module Aws::APIGateway
|
9
|
-
|
10
|
-
# To create a resource object:
|
11
|
-
# resource = Aws::APIGateway::Resource.new(region: 'us-west-2')
|
12
|
-
# You can supply a client object with custom configuration that will be used for all resource operations.
|
13
|
-
# If you do not pass +:client+, a default client will be constructed.
|
14
|
-
# client = Aws::APIGateway::Client.new(region: 'us-west-2')
|
15
|
-
# resource = Aws::APIGateway::Resource.new(client: client)
|
9
|
+
|
16
10
|
class Resource
|
17
11
|
|
18
12
|
# @param options ({})
|
@@ -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
|
@@ -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.38.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: 2020-
|
11
|
+
date: 2020-04-07 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
|