aws-sdk-apigateway 1.85.0 → 1.87.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 +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-apigateway/client.rb +33 -24
- data/lib/aws-sdk-apigateway/client_api.rb +1 -0
- data/lib/aws-sdk-apigateway/endpoint_parameters.rb +0 -3
- data/lib/aws-sdk-apigateway/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-apigateway/types.rb +71 -90
- data/lib/aws-sdk-apigateway.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6b3740537b6ea593a5262511e275b73a064208c03e2e9ff8989cf9c23776319a
|
|
4
|
+
data.tar.gz: 8a5b770bb1306d3cfef7cb48de5b6b49db8e9745d1ef3ad44a6367db705df4d5
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 349ecd5e32604aa28690cce9162911b73e9659391e8b5234bf6d6e3f7f289b7a314d7409787d5e41312659a2fc2645411d89938e09038c647703902d89e83caf
|
|
7
|
+
data.tar.gz: ce4a18f4f54b9608e374c15c43c9a3d64183fcac950b7655bfc0772d8e1f8e05a59ae132f8b1bf84cda05bfbf2cc918b3badb9e7c77548f78887c8b26f4de365
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,16 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.87.0 (2023-08-23)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - This release adds RootResourceId to GetRestApi response.
|
|
8
|
+
|
|
9
|
+
1.86.0 (2023-07-11)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
13
|
+
|
|
4
14
|
1.85.0 (2023-07-06)
|
|
5
15
|
------------------
|
|
6
16
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.87.0
|
|
@@ -218,6 +218,10 @@ module Aws::APIGateway
|
|
|
218
218
|
# @option options [Boolean] :endpoint_discovery (false)
|
|
219
219
|
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
|
220
220
|
#
|
|
221
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
|
222
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
|
223
|
+
# variables and the shared configuration file.
|
|
224
|
+
#
|
|
221
225
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
|
222
226
|
# The log formatter.
|
|
223
227
|
#
|
|
@@ -410,8 +414,8 @@ module Aws::APIGateway
|
|
|
410
414
|
# key.
|
|
411
415
|
#
|
|
412
416
|
# @option params [String] :customer_id
|
|
413
|
-
# An
|
|
414
|
-
# SaaS Marketplace.
|
|
417
|
+
# An Amazon Web Services Marketplace customer identifier, when
|
|
418
|
+
# integrating with the Amazon Web Services SaaS Marketplace.
|
|
415
419
|
#
|
|
416
420
|
# @option params [Hash<String,String>] :tags
|
|
417
421
|
# The key-value map of strings. The valid character set is
|
|
@@ -857,18 +861,18 @@ module Aws::APIGateway
|
|
|
857
861
|
# include any intermediaries that are not in the chain of trust path.
|
|
858
862
|
#
|
|
859
863
|
# @option params [String] :certificate_arn
|
|
860
|
-
# The reference to an
|
|
861
|
-
# edge-optimized endpoint for this domain name.
|
|
862
|
-
# is the only supported source.
|
|
864
|
+
# The reference to an Amazon Web Services-managed certificate that will
|
|
865
|
+
# be used by edge-optimized endpoint for this domain name. Certificate
|
|
866
|
+
# Manager is the only supported source.
|
|
863
867
|
#
|
|
864
868
|
# @option params [String] :regional_certificate_name
|
|
865
869
|
# The user-friendly name of the certificate that will be used by
|
|
866
870
|
# regional endpoint for this domain name.
|
|
867
871
|
#
|
|
868
872
|
# @option params [String] :regional_certificate_arn
|
|
869
|
-
# The reference to an
|
|
870
|
-
# regional endpoint for this domain name.
|
|
871
|
-
# only supported source.
|
|
873
|
+
# The reference to an Amazon Web Services-managed certificate that will
|
|
874
|
+
# be used by regional endpoint for this domain name. Certificate Manager
|
|
875
|
+
# is the only supported source.
|
|
872
876
|
#
|
|
873
877
|
# @option params [Types::EndpointConfiguration] :endpoint_configuration
|
|
874
878
|
# The endpoint configuration of this DomainName showing the endpoint
|
|
@@ -1186,7 +1190,7 @@ module Aws::APIGateway
|
|
|
1186
1190
|
#
|
|
1187
1191
|
# @option params [String] :api_key_source
|
|
1188
1192
|
# The source of the API key for metering requests according to a usage
|
|
1189
|
-
# plan. Valid values are:
|
|
1193
|
+
# plan. Valid values are: `HEADER` to read the API key from the
|
|
1190
1194
|
# `X-API-Key` header of a request. `AUTHORIZER` to read the API key from
|
|
1191
1195
|
# the `UsageIdentifierKey` from a custom authorizer.
|
|
1192
1196
|
#
|
|
@@ -1225,6 +1229,7 @@ module Aws::APIGateway
|
|
|
1225
1229
|
# * {Types::RestApi#policy #policy} => String
|
|
1226
1230
|
# * {Types::RestApi#tags #tags} => Hash<String,String>
|
|
1227
1231
|
# * {Types::RestApi#disable_execute_api_endpoint #disable_execute_api_endpoint} => Boolean
|
|
1232
|
+
# * {Types::RestApi#root_resource_id #root_resource_id} => String
|
|
1228
1233
|
#
|
|
1229
1234
|
# @example Request syntax with placeholder values
|
|
1230
1235
|
#
|
|
@@ -1268,6 +1273,7 @@ module Aws::APIGateway
|
|
|
1268
1273
|
# resp.tags #=> Hash
|
|
1269
1274
|
# resp.tags["String"] #=> String
|
|
1270
1275
|
# resp.disable_execute_api_endpoint #=> Boolean
|
|
1276
|
+
# resp.root_resource_id #=> String
|
|
1271
1277
|
#
|
|
1272
1278
|
# @overload create_rest_api(params = {})
|
|
1273
1279
|
# @param [Hash] params ({})
|
|
@@ -1562,8 +1568,8 @@ module Aws::APIGateway
|
|
|
1562
1568
|
#
|
|
1563
1569
|
# @option params [required, Array<String>] :target_arns
|
|
1564
1570
|
# The ARN of the network load balancer of the VPC targeted by the VPC
|
|
1565
|
-
# link. The network load balancer must be owned by the same
|
|
1566
|
-
# of the API owner.
|
|
1571
|
+
# link. The network load balancer must be owned by the same Amazon Web
|
|
1572
|
+
# Services account of the API owner.
|
|
1567
1573
|
#
|
|
1568
1574
|
# @option params [Hash<String,String>] :tags
|
|
1569
1575
|
# The key-value map of strings. The valid character set is
|
|
@@ -2305,8 +2311,8 @@ module Aws::APIGateway
|
|
|
2305
2311
|
# The name of queried API keys.
|
|
2306
2312
|
#
|
|
2307
2313
|
# @option params [String] :customer_id
|
|
2308
|
-
# The identifier of a customer in
|
|
2309
|
-
# such as a developer portal.
|
|
2314
|
+
# The identifier of a customer in Amazon Web Services Marketplace or an
|
|
2315
|
+
# external system, such as a developer portal.
|
|
2310
2316
|
#
|
|
2311
2317
|
# @option params [Boolean] :include_values
|
|
2312
2318
|
# A boolean flag to specify whether (`true`) or not (`false`) the result
|
|
@@ -3814,6 +3820,7 @@ module Aws::APIGateway
|
|
|
3814
3820
|
# * {Types::RestApi#policy #policy} => String
|
|
3815
3821
|
# * {Types::RestApi#tags #tags} => Hash<String,String>
|
|
3816
3822
|
# * {Types::RestApi#disable_execute_api_endpoint #disable_execute_api_endpoint} => Boolean
|
|
3823
|
+
# * {Types::RestApi#root_resource_id #root_resource_id} => String
|
|
3817
3824
|
#
|
|
3818
3825
|
# @example Request syntax with placeholder values
|
|
3819
3826
|
#
|
|
@@ -3842,6 +3849,7 @@ module Aws::APIGateway
|
|
|
3842
3849
|
# resp.tags #=> Hash
|
|
3843
3850
|
# resp.tags["String"] #=> String
|
|
3844
3851
|
# resp.disable_execute_api_endpoint #=> Boolean
|
|
3852
|
+
# resp.root_resource_id #=> String
|
|
3845
3853
|
#
|
|
3846
3854
|
# @overload get_rest_api(params = {})
|
|
3847
3855
|
# @param [Hash] params ({})
|
|
@@ -3896,6 +3904,7 @@ module Aws::APIGateway
|
|
|
3896
3904
|
# resp.items[0].tags #=> Hash
|
|
3897
3905
|
# resp.items[0].tags["String"] #=> String
|
|
3898
3906
|
# resp.items[0].disable_execute_api_endpoint #=> Boolean
|
|
3907
|
+
# resp.items[0].root_resource_id #=> String
|
|
3899
3908
|
#
|
|
3900
3909
|
# @overload get_rest_apis(params = {})
|
|
3901
3910
|
# @param [Hash] params ({})
|
|
@@ -4603,9 +4612,9 @@ module Aws::APIGateway
|
|
|
4603
4612
|
# The string identifier of the associated RestApi.
|
|
4604
4613
|
#
|
|
4605
4614
|
# @option params [String] :mode
|
|
4606
|
-
# A query parameter to indicate whether to overwrite (`
|
|
4607
|
-
# existing DocumentationParts definition or to merge (`
|
|
4608
|
-
# definition into the existing one. The default value is `
|
|
4615
|
+
# A query parameter to indicate whether to overwrite (`overwrite`) any
|
|
4616
|
+
# existing DocumentationParts definition or to merge (`merge`) the new
|
|
4617
|
+
# definition into the existing one. The default value is `merge`.
|
|
4609
4618
|
#
|
|
4610
4619
|
# @option params [Boolean] :fail_on_warnings
|
|
4611
4620
|
# A query parameter to specify whether to rollback the documentation
|
|
@@ -4669,12 +4678,6 @@ module Aws::APIGateway
|
|
|
4669
4678
|
# To handle imported `basepath`, set `parameters` as `basepath=ignore`,
|
|
4670
4679
|
# `basepath=prepend` or `basepath=split`.
|
|
4671
4680
|
#
|
|
4672
|
-
# For example, the AWS CLI command to exclude documentation from the
|
|
4673
|
-
# imported API is:
|
|
4674
|
-
#
|
|
4675
|
-
# The AWS CLI command to set the regional endpoint on the imported API
|
|
4676
|
-
# is:
|
|
4677
|
-
#
|
|
4678
4681
|
# @option params [required, String, StringIO, File] :body
|
|
4679
4682
|
# The POST request body containing external API definitions. Currently,
|
|
4680
4683
|
# only OpenAPI definition JSON/YAML files are supported. The maximum
|
|
@@ -4695,6 +4698,7 @@ module Aws::APIGateway
|
|
|
4695
4698
|
# * {Types::RestApi#policy #policy} => String
|
|
4696
4699
|
# * {Types::RestApi#tags #tags} => Hash<String,String>
|
|
4697
4700
|
# * {Types::RestApi#disable_execute_api_endpoint #disable_execute_api_endpoint} => Boolean
|
|
4701
|
+
# * {Types::RestApi#root_resource_id #root_resource_id} => String
|
|
4698
4702
|
#
|
|
4699
4703
|
# @example Request syntax with placeholder values
|
|
4700
4704
|
#
|
|
@@ -4727,6 +4731,7 @@ module Aws::APIGateway
|
|
|
4727
4731
|
# resp.tags #=> Hash
|
|
4728
4732
|
# resp.tags["String"] #=> String
|
|
4729
4733
|
# resp.disable_execute_api_endpoint #=> Boolean
|
|
4734
|
+
# resp.root_resource_id #=> String
|
|
4730
4735
|
#
|
|
4731
4736
|
# @overload import_rest_api(params = {})
|
|
4732
4737
|
# @param [Hash] params ({})
|
|
@@ -5333,6 +5338,7 @@ module Aws::APIGateway
|
|
|
5333
5338
|
# * {Types::RestApi#policy #policy} => String
|
|
5334
5339
|
# * {Types::RestApi#tags #tags} => Hash<String,String>
|
|
5335
5340
|
# * {Types::RestApi#disable_execute_api_endpoint #disable_execute_api_endpoint} => Boolean
|
|
5341
|
+
# * {Types::RestApi#root_resource_id #root_resource_id} => String
|
|
5336
5342
|
#
|
|
5337
5343
|
# @example Request syntax with placeholder values
|
|
5338
5344
|
#
|
|
@@ -5367,6 +5373,7 @@ module Aws::APIGateway
|
|
|
5367
5373
|
# resp.tags #=> Hash
|
|
5368
5374
|
# resp.tags["String"] #=> String
|
|
5369
5375
|
# resp.disable_execute_api_endpoint #=> Boolean
|
|
5376
|
+
# resp.root_resource_id #=> String
|
|
5370
5377
|
#
|
|
5371
5378
|
# @overload put_rest_api(params = {})
|
|
5372
5379
|
# @param [Hash] params ({})
|
|
@@ -5987,7 +5994,7 @@ module Aws::APIGateway
|
|
|
5987
5994
|
# Updates a documentation version.
|
|
5988
5995
|
#
|
|
5989
5996
|
# @option params [required, String] :rest_api_id
|
|
5990
|
-
# The string identifier of the associated RestApi
|
|
5997
|
+
# The string identifier of the associated RestApi.
|
|
5991
5998
|
#
|
|
5992
5999
|
# @option params [required, String] :documentation_version
|
|
5993
6000
|
# The version identifier of the to-be-updated documentation version.
|
|
@@ -6718,6 +6725,7 @@ module Aws::APIGateway
|
|
|
6718
6725
|
# * {Types::RestApi#policy #policy} => String
|
|
6719
6726
|
# * {Types::RestApi#tags #tags} => Hash<String,String>
|
|
6720
6727
|
# * {Types::RestApi#disable_execute_api_endpoint #disable_execute_api_endpoint} => Boolean
|
|
6728
|
+
# * {Types::RestApi#root_resource_id #root_resource_id} => String
|
|
6721
6729
|
#
|
|
6722
6730
|
# @example Request syntax with placeholder values
|
|
6723
6731
|
#
|
|
@@ -6754,6 +6762,7 @@ module Aws::APIGateway
|
|
|
6754
6762
|
# resp.tags #=> Hash
|
|
6755
6763
|
# resp.tags["String"] #=> String
|
|
6756
6764
|
# resp.disable_execute_api_endpoint #=> Boolean
|
|
6765
|
+
# resp.root_resource_id #=> String
|
|
6757
6766
|
#
|
|
6758
6767
|
# @overload update_rest_api(params = {})
|
|
6759
6768
|
# @param [Hash] params ({})
|
|
@@ -7051,7 +7060,7 @@ module Aws::APIGateway
|
|
|
7051
7060
|
params: params,
|
|
7052
7061
|
config: config)
|
|
7053
7062
|
context[:gem_name] = 'aws-sdk-apigateway'
|
|
7054
|
-
context[:gem_version] = '1.
|
|
7063
|
+
context[:gem_version] = '1.87.0'
|
|
7055
7064
|
Seahorse::Client::Request.new(handlers, context)
|
|
7056
7065
|
end
|
|
7057
7066
|
|
|
@@ -1194,6 +1194,7 @@ module Aws::APIGateway
|
|
|
1194
1194
|
RestApi.add_member(:policy, Shapes::ShapeRef.new(shape: String, location_name: "policy"))
|
|
1195
1195
|
RestApi.add_member(:tags, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "tags"))
|
|
1196
1196
|
RestApi.add_member(:disable_execute_api_endpoint, Shapes::ShapeRef.new(shape: Boolean, location_name: "disableExecuteApiEndpoint"))
|
|
1197
|
+
RestApi.add_member(:root_resource_id, Shapes::ShapeRef.new(shape: String, location_name: "rootResourceId"))
|
|
1197
1198
|
RestApi.struct_class = Types::RestApi
|
|
1198
1199
|
|
|
1199
1200
|
RestApis.add_member(:position, Shapes::ShapeRef.new(shape: String, location_name: "position"))
|
|
@@ -50,9 +50,6 @@ module Aws::APIGateway
|
|
|
50
50
|
|
|
51
51
|
def initialize(options = {})
|
|
52
52
|
self[:region] = options[:region]
|
|
53
|
-
if self[:region].nil?
|
|
54
|
-
raise ArgumentError, "Missing required EndpointParameter: :region"
|
|
55
|
-
end
|
|
56
53
|
self[:use_dual_stack] = options[:use_dual_stack]
|
|
57
54
|
self[:use_dual_stack] = false if self[:use_dual_stack].nil?
|
|
58
55
|
if self[:use_dual_stack].nil?
|
|
@@ -14,36 +14,39 @@ module Aws::APIGateway
|
|
|
14
14
|
use_dual_stack = parameters.use_dual_stack
|
|
15
15
|
use_fips = parameters.use_fips
|
|
16
16
|
endpoint = parameters.endpoint
|
|
17
|
-
if
|
|
18
|
-
if Aws::Endpoints::Matchers.set?(endpoint)
|
|
19
|
-
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
|
|
20
|
-
raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
|
|
21
|
-
end
|
|
22
|
-
if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
|
|
23
|
-
raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
|
|
24
|
-
end
|
|
25
|
-
return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
|
|
26
|
-
end
|
|
27
|
-
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
|
|
28
|
-
if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) && Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
|
|
29
|
-
return Aws::Endpoints::Endpoint.new(url: "https://apigateway-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
|
|
30
|
-
end
|
|
31
|
-
raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
|
|
32
|
-
end
|
|
17
|
+
if Aws::Endpoints::Matchers.set?(endpoint)
|
|
33
18
|
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
|
|
34
|
-
|
|
35
|
-
return Aws::Endpoints::Endpoint.new(url: "https://apigateway-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
|
|
36
|
-
end
|
|
37
|
-
raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
|
|
19
|
+
raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
|
|
38
20
|
end
|
|
39
21
|
if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
|
|
40
|
-
|
|
41
|
-
|
|
22
|
+
raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
|
|
23
|
+
end
|
|
24
|
+
return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
|
|
25
|
+
end
|
|
26
|
+
if Aws::Endpoints::Matchers.set?(region)
|
|
27
|
+
if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
|
|
28
|
+
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
|
|
29
|
+
if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) && Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
|
|
30
|
+
return Aws::Endpoints::Endpoint.new(url: "https://apigateway-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
|
|
31
|
+
end
|
|
32
|
+
raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
|
|
33
|
+
end
|
|
34
|
+
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
|
|
35
|
+
if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
|
|
36
|
+
return Aws::Endpoints::Endpoint.new(url: "https://apigateway-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
|
|
37
|
+
end
|
|
38
|
+
raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
|
|
39
|
+
end
|
|
40
|
+
if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
|
|
41
|
+
if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
|
|
42
|
+
return Aws::Endpoints::Endpoint.new(url: "https://apigateway.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
|
|
43
|
+
end
|
|
44
|
+
raise ArgumentError, "DualStack is enabled but this partition does not support DualStack"
|
|
42
45
|
end
|
|
43
|
-
|
|
46
|
+
return Aws::Endpoints::Endpoint.new(url: "https://apigateway.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
|
|
44
47
|
end
|
|
45
|
-
return Aws::Endpoints::Endpoint.new(url: "https://apigateway.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
|
|
46
48
|
end
|
|
49
|
+
raise ArgumentError, "Invalid Configuration: Missing Region"
|
|
47
50
|
raise ArgumentError, 'No endpoint could be resolved'
|
|
48
51
|
|
|
49
52
|
end
|
|
@@ -79,8 +79,8 @@ module Aws::APIGateway
|
|
|
79
79
|
# @return [String]
|
|
80
80
|
#
|
|
81
81
|
# @!attribute [rw] customer_id
|
|
82
|
-
# An
|
|
83
|
-
#
|
|
82
|
+
# An Amazon Web Services Marketplace customer identifier, when
|
|
83
|
+
# integrating with the Amazon Web Services SaaS Marketplace.
|
|
84
84
|
# @return [String]
|
|
85
85
|
#
|
|
86
86
|
# @!attribute [rw] description
|
|
@@ -495,8 +495,8 @@ module Aws::APIGateway
|
|
|
495
495
|
# @return [Array<Types::StageKey>]
|
|
496
496
|
#
|
|
497
497
|
# @!attribute [rw] customer_id
|
|
498
|
-
# An
|
|
499
|
-
#
|
|
498
|
+
# An Amazon Web Services Marketplace customer identifier, when
|
|
499
|
+
# integrating with the Amazon Web Services SaaS Marketplace.
|
|
500
500
|
# @return [String]
|
|
501
501
|
#
|
|
502
502
|
# @!attribute [rw] tags
|
|
@@ -810,9 +810,9 @@ module Aws::APIGateway
|
|
|
810
810
|
# @return [String]
|
|
811
811
|
#
|
|
812
812
|
# @!attribute [rw] certificate_arn
|
|
813
|
-
# The reference to an
|
|
814
|
-
# edge-optimized endpoint for this domain name.
|
|
815
|
-
# Manager is the only supported source.
|
|
813
|
+
# The reference to an Amazon Web Services-managed certificate that
|
|
814
|
+
# will be used by edge-optimized endpoint for this domain name.
|
|
815
|
+
# Certificate Manager is the only supported source.
|
|
816
816
|
# @return [String]
|
|
817
817
|
#
|
|
818
818
|
# @!attribute [rw] regional_certificate_name
|
|
@@ -821,9 +821,9 @@ module Aws::APIGateway
|
|
|
821
821
|
# @return [String]
|
|
822
822
|
#
|
|
823
823
|
# @!attribute [rw] regional_certificate_arn
|
|
824
|
-
# The reference to an
|
|
825
|
-
# regional endpoint for this domain name.
|
|
826
|
-
# the only supported source.
|
|
824
|
+
# The reference to an Amazon Web Services-managed certificate that
|
|
825
|
+
# will be used by regional endpoint for this domain name. Certificate
|
|
826
|
+
# Manager is the only supported source.
|
|
827
827
|
# @return [String]
|
|
828
828
|
#
|
|
829
829
|
# @!attribute [rw] endpoint_configuration
|
|
@@ -993,7 +993,7 @@ module Aws::APIGateway
|
|
|
993
993
|
#
|
|
994
994
|
# @!attribute [rw] api_key_source
|
|
995
995
|
# The source of the API key for metering requests according to a usage
|
|
996
|
-
# plan. Valid values are:
|
|
996
|
+
# plan. Valid values are: `HEADER` to read the API key from the
|
|
997
997
|
# `X-API-Key` header of a request. `AUTHORIZER` to read the API key
|
|
998
998
|
# from the `UsageIdentifierKey` from a custom authorizer.
|
|
999
999
|
# @return [String]
|
|
@@ -1195,8 +1195,8 @@ module Aws::APIGateway
|
|
|
1195
1195
|
#
|
|
1196
1196
|
# @!attribute [rw] target_arns
|
|
1197
1197
|
# The ARN of the network load balancer of the VPC targeted by the VPC
|
|
1198
|
-
# link. The network load balancer must be owned by the same
|
|
1199
|
-
# account of the API owner.
|
|
1198
|
+
# link. The network load balancer must be owned by the same Amazon Web
|
|
1199
|
+
# Services account of the API owner.
|
|
1200
1200
|
# @return [Array<String>]
|
|
1201
1201
|
#
|
|
1202
1202
|
# @!attribute [rw] tags
|
|
@@ -1837,9 +1837,9 @@ module Aws::APIGateway
|
|
|
1837
1837
|
# @return [String]
|
|
1838
1838
|
#
|
|
1839
1839
|
# @!attribute [rw] certificate_arn
|
|
1840
|
-
# The reference to an
|
|
1841
|
-
# edge-optimized endpoint for this domain name.
|
|
1842
|
-
# Manager is the only supported source.
|
|
1840
|
+
# The reference to an Amazon Web Services-managed certificate that
|
|
1841
|
+
# will be used by edge-optimized endpoint for this domain name.
|
|
1842
|
+
# Certificate Manager is the only supported source.
|
|
1843
1843
|
# @return [String]
|
|
1844
1844
|
#
|
|
1845
1845
|
# @!attribute [rw] certificate_upload_date
|
|
@@ -1867,9 +1867,9 @@ module Aws::APIGateway
|
|
|
1867
1867
|
# @return [String]
|
|
1868
1868
|
#
|
|
1869
1869
|
# @!attribute [rw] regional_certificate_arn
|
|
1870
|
-
# The reference to an
|
|
1871
|
-
# validating the regional domain name.
|
|
1872
|
-
# only supported source.
|
|
1870
|
+
# The reference to an Amazon Web Services-managed certificate that
|
|
1871
|
+
# will be used for validating the regional domain name. Certificate
|
|
1872
|
+
# Manager is the only supported source.
|
|
1873
1873
|
# @return [String]
|
|
1874
1874
|
#
|
|
1875
1875
|
# @!attribute [rw] distribution_domain_name
|
|
@@ -2163,8 +2163,8 @@ module Aws::APIGateway
|
|
|
2163
2163
|
# @return [String]
|
|
2164
2164
|
#
|
|
2165
2165
|
# @!attribute [rw] customer_id
|
|
2166
|
-
# The identifier of a customer in
|
|
2167
|
-
# system, such as a developer portal.
|
|
2166
|
+
# The identifier of a customer in Amazon Web Services Marketplace or
|
|
2167
|
+
# an external system, such as a developer portal.
|
|
2168
2168
|
# @return [String]
|
|
2169
2169
|
#
|
|
2170
2170
|
# @!attribute [rw] include_values
|
|
@@ -3193,9 +3193,9 @@ module Aws::APIGateway
|
|
|
3193
3193
|
# @return [String]
|
|
3194
3194
|
#
|
|
3195
3195
|
# @!attribute [rw] mode
|
|
3196
|
-
# A query parameter to indicate whether to overwrite (`
|
|
3197
|
-
# existing DocumentationParts definition or to merge (`
|
|
3198
|
-
# definition into the existing one. The default value is `
|
|
3196
|
+
# A query parameter to indicate whether to overwrite (`overwrite`) any
|
|
3197
|
+
# existing DocumentationParts definition or to merge (`merge`) the new
|
|
3198
|
+
# definition into the existing one. The default value is `merge`.
|
|
3199
3199
|
# @return [String]
|
|
3200
3200
|
#
|
|
3201
3201
|
# @!attribute [rw] fail_on_warnings
|
|
@@ -3244,12 +3244,6 @@ module Aws::APIGateway
|
|
|
3244
3244
|
#
|
|
3245
3245
|
# To handle imported `basepath`, set `parameters` as
|
|
3246
3246
|
# `basepath=ignore`, `basepath=prepend` or `basepath=split`.
|
|
3247
|
-
#
|
|
3248
|
-
# For example, the AWS CLI command to exclude documentation from the
|
|
3249
|
-
# imported API is:
|
|
3250
|
-
#
|
|
3251
|
-
# The AWS CLI command to set the regional endpoint on the imported API
|
|
3252
|
-
# is:
|
|
3253
3247
|
# @return [Hash<String,String>]
|
|
3254
3248
|
#
|
|
3255
3249
|
# @!attribute [rw] body
|
|
@@ -3266,7 +3260,8 @@ module Aws::APIGateway
|
|
|
3266
3260
|
include Aws::Structure
|
|
3267
3261
|
end
|
|
3268
3262
|
|
|
3269
|
-
# Represents an HTTP
|
|
3263
|
+
# Represents an `HTTP`, `HTTP_PROXY`, `AWS`, `AWS_PROXY`, or Mock
|
|
3264
|
+
# integration.
|
|
3270
3265
|
#
|
|
3271
3266
|
# @!attribute [rw] type
|
|
3272
3267
|
# Specifies an API method integration type. The valid value is one of
|
|
@@ -3281,7 +3276,10 @@ module Aws::APIGateway
|
|
|
3281
3276
|
# @return [String]
|
|
3282
3277
|
#
|
|
3283
3278
|
# @!attribute [rw] http_method
|
|
3284
|
-
# Specifies the integration's HTTP method type.
|
|
3279
|
+
# Specifies the integration's HTTP method type. For the Type
|
|
3280
|
+
# property, if you specify `MOCK`, this property is optional. For
|
|
3281
|
+
# Lambda integrations, you must set the integration method to `POST`.
|
|
3282
|
+
# For all other types, you must specify this property.
|
|
3285
3283
|
# @return [String]
|
|
3286
3284
|
#
|
|
3287
3285
|
# @!attribute [rw] uri
|
|
@@ -3289,12 +3287,10 @@ module Aws::APIGateway
|
|
|
3289
3287
|
# endpoint.
|
|
3290
3288
|
#
|
|
3291
3289
|
# For `HTTP` or `HTTP_PROXY` integrations, the URI must be a fully
|
|
3292
|
-
# formed, encoded HTTP(S) URL according to the RFC-3986 specification
|
|
3293
|
-
# for
|
|
3294
|
-
#
|
|
3295
|
-
#
|
|
3296
|
-
# routing. For `AWS` or `AWS_PROXY` integrations, the URI is of the
|
|
3297
|
-
# form
|
|
3290
|
+
# formed, encoded HTTP(S) URL according to the RFC-3986 specification
|
|
3291
|
+
# for standard integrations. If `connectionType` is `VPC_LINK` specify
|
|
3292
|
+
# the Network Load Balancer DNS name. For `AWS` or `AWS_PROXY`
|
|
3293
|
+
# integrations, the URI is of the form
|
|
3298
3294
|
# `arn:aws:apigateway:\{region\}:\{subdomain.service|service\}:path|action/\{service_api\}`.
|
|
3299
3295
|
# Here, \\\{Region\\} is the API Gateway region (e.g., us-east-1);
|
|
3300
3296
|
# \\\{service\\} is the name of the integrated Amazon Web Services
|
|
@@ -3305,11 +3301,11 @@ module Aws::APIGateway
|
|
|
3305
3301
|
# Action=\\\{name\\}&\\\{p1\\}=\\\{v1\\}&p2=\\\{v2\\}... query
|
|
3306
3302
|
# string. The ensuing \\\{service\_api\\} refers to a supported action
|
|
3307
3303
|
# \\\{name\\} plus any required input parameters. Alternatively, path
|
|
3308
|
-
# can be used for an
|
|
3309
|
-
# service\_api refers to the path to an Amazon Web Services
|
|
3310
|
-
# resource, including the region of the integrated Amazon Web
|
|
3311
|
-
# service, if applicable. For example, for integration with
|
|
3312
|
-
# of GetObject, the uri can be either
|
|
3304
|
+
# can be used for an Amazon Web Services service path-based API. The
|
|
3305
|
+
# ensuing service\_api refers to the path to an Amazon Web Services
|
|
3306
|
+
# service resource, including the region of the integrated Amazon Web
|
|
3307
|
+
# Services service, if applicable. For example, for integration with
|
|
3308
|
+
# the S3 API of GetObject, the uri can be either
|
|
3313
3309
|
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket=\{bucket\}&Key=\{key\}`
|
|
3314
3310
|
# or `arn:aws:apigateway:us-west-2:s3:path/\{bucket\}/\{key\}`
|
|
3315
3311
|
# @return [String]
|
|
@@ -3333,7 +3329,8 @@ module Aws::APIGateway
|
|
|
3333
3329
|
# Role for API Gateway to assume, use the role's Amazon Resource Name
|
|
3334
3330
|
# (ARN). To require that the caller's identity be passed through from
|
|
3335
3331
|
# the request, specify the string `arn:aws:iam::*:user/*`. To use
|
|
3336
|
-
# resource-based permissions on supported
|
|
3332
|
+
# resource-based permissions on supported Amazon Web Services
|
|
3333
|
+
# services, specify null.
|
|
3337
3334
|
# @return [String]
|
|
3338
3335
|
#
|
|
3339
3336
|
# @!attribute [rw] request_parameters
|
|
@@ -3452,9 +3449,9 @@ module Aws::APIGateway
|
|
|
3452
3449
|
# response returns some string, you could use the `.+` regex to match
|
|
3453
3450
|
# error response. However, make sure that the error response does not
|
|
3454
3451
|
# contain any newline (`\n`) character in such cases. If the back end
|
|
3455
|
-
# is an
|
|
3456
|
-
#
|
|
3457
|
-
# is matched.
|
|
3452
|
+
# is an Lambda function, the Lambda function error header is matched.
|
|
3453
|
+
# For all other HTTP and Amazon Web Services back ends, the HTTP
|
|
3454
|
+
# status code is matched.
|
|
3458
3455
|
# @return [String]
|
|
3459
3456
|
#
|
|
3460
3457
|
# @!attribute [rw] response_parameters
|
|
@@ -3660,75 +3657,53 @@ module Aws::APIGateway
|
|
|
3660
3657
|
#
|
|
3661
3658
|
# @!attribute [rw] metrics_enabled
|
|
3662
3659
|
# Specifies whether Amazon CloudWatch metrics are enabled for this
|
|
3663
|
-
# method.
|
|
3664
|
-
# `/\{method_setting_key\}/metrics/enabled`, and the value is a
|
|
3665
|
-
# Boolean.
|
|
3660
|
+
# method.
|
|
3666
3661
|
# @return [Boolean]
|
|
3667
3662
|
#
|
|
3668
3663
|
# @!attribute [rw] logging_level
|
|
3669
3664
|
# Specifies the logging level for this method, which affects the log
|
|
3670
|
-
# entries pushed to Amazon CloudWatch Logs.
|
|
3671
|
-
#
|
|
3672
|
-
#
|
|
3673
|
-
#
|
|
3674
|
-
# to include all `ERROR` events as well as extra informational events.
|
|
3665
|
+
# entries pushed to Amazon CloudWatch Logs. Valid values are `OFF`,
|
|
3666
|
+
# `ERROR`, and `INFO`. Choose `ERROR` to write only error-level
|
|
3667
|
+
# entries to CloudWatch Logs, or choose `INFO` to include all `ERROR`
|
|
3668
|
+
# events as well as extra informational events.
|
|
3675
3669
|
# @return [String]
|
|
3676
3670
|
#
|
|
3677
3671
|
# @!attribute [rw] data_trace_enabled
|
|
3678
3672
|
# Specifies whether data trace logging is enabled for this method,
|
|
3679
|
-
# which affects the log entries pushed to Amazon CloudWatch Logs.
|
|
3680
|
-
# PATCH path for this setting is
|
|
3681
|
-
# `/\{method_setting_key\}/logging/dataTrace`, and the value is a
|
|
3682
|
-
# Boolean.
|
|
3673
|
+
# which affects the log entries pushed to Amazon CloudWatch Logs.
|
|
3683
3674
|
# @return [Boolean]
|
|
3684
3675
|
#
|
|
3685
3676
|
# @!attribute [rw] throttling_burst_limit
|
|
3686
|
-
# Specifies the throttling burst limit.
|
|
3687
|
-
# setting is `/\{method_setting_key\}/throttling/burstLimit`, and the
|
|
3688
|
-
# value is an integer.
|
|
3677
|
+
# Specifies the throttling burst limit.
|
|
3689
3678
|
# @return [Integer]
|
|
3690
3679
|
#
|
|
3691
3680
|
# @!attribute [rw] throttling_rate_limit
|
|
3692
|
-
# Specifies the throttling rate limit.
|
|
3693
|
-
# is `/\{method_setting_key\}/throttling/rateLimit`, and the value is
|
|
3694
|
-
# a double.
|
|
3681
|
+
# Specifies the throttling rate limit.
|
|
3695
3682
|
# @return [Float]
|
|
3696
3683
|
#
|
|
3697
3684
|
# @!attribute [rw] caching_enabled
|
|
3698
3685
|
# Specifies whether responses should be cached and returned for
|
|
3699
3686
|
# requests. A cache cluster must be enabled on the stage for responses
|
|
3700
|
-
# to be cached.
|
|
3701
|
-
# `/\{method_setting_key\}/caching/enabled`, and the value is a
|
|
3702
|
-
# Boolean.
|
|
3687
|
+
# to be cached.
|
|
3703
3688
|
# @return [Boolean]
|
|
3704
3689
|
#
|
|
3705
3690
|
# @!attribute [rw] cache_ttl_in_seconds
|
|
3706
3691
|
# Specifies the time to live (TTL), in seconds, for cached responses.
|
|
3707
|
-
# The higher the TTL, the longer the response will be cached.
|
|
3708
|
-
# PATCH path for this setting is
|
|
3709
|
-
# `/\{method_setting_key\}/caching/ttlInSeconds`, and the value is an
|
|
3710
|
-
# integer.
|
|
3692
|
+
# The higher the TTL, the longer the response will be cached.
|
|
3711
3693
|
# @return [Integer]
|
|
3712
3694
|
#
|
|
3713
3695
|
# @!attribute [rw] cache_data_encrypted
|
|
3714
|
-
# Specifies whether the cached responses are encrypted.
|
|
3715
|
-
# for this setting is `/\{method_setting_key\}/caching/dataEncrypted`,
|
|
3716
|
-
# and the value is a Boolean.
|
|
3696
|
+
# Specifies whether the cached responses are encrypted.
|
|
3717
3697
|
# @return [Boolean]
|
|
3718
3698
|
#
|
|
3719
3699
|
# @!attribute [rw] require_authorization_for_cache_control
|
|
3720
3700
|
# Specifies whether authorization is required for a cache invalidation
|
|
3721
|
-
# request.
|
|
3722
|
-
# `/\{method_setting_key\}/caching/requireAuthorizationForCacheControl`,
|
|
3723
|
-
# and the value is a Boolean.
|
|
3701
|
+
# request.
|
|
3724
3702
|
# @return [Boolean]
|
|
3725
3703
|
#
|
|
3726
3704
|
# @!attribute [rw] unauthorized_cache_control_header_strategy
|
|
3727
3705
|
# Specifies how to handle unauthorized requests for cache
|
|
3728
|
-
# invalidation.
|
|
3729
|
-
# `/\{method_setting_key\}/caching/unauthorizedCacheControlHeaderStrategy`,
|
|
3730
|
-
# and the available values are `FAIL_WITH_403`,
|
|
3731
|
-
# `SUCCEED_WITH_RESPONSE_HEADER`, `SUCCEED_WITHOUT_RESPONSE_HEADER`.
|
|
3706
|
+
# invalidation.
|
|
3732
3707
|
# @return [String]
|
|
3733
3708
|
#
|
|
3734
3709
|
class MethodSetting < Struct.new(
|
|
@@ -4580,6 +4555,10 @@ module Aws::APIGateway
|
|
|
4580
4555
|
# disable the default endpoint.
|
|
4581
4556
|
# @return [Boolean]
|
|
4582
4557
|
#
|
|
4558
|
+
# @!attribute [rw] root_resource_id
|
|
4559
|
+
# The API's root resource ID.
|
|
4560
|
+
# @return [String]
|
|
4561
|
+
#
|
|
4583
4562
|
class RestApi < Struct.new(
|
|
4584
4563
|
:id,
|
|
4585
4564
|
:name,
|
|
@@ -4593,7 +4572,8 @@ module Aws::APIGateway
|
|
|
4593
4572
|
:endpoint_configuration,
|
|
4594
4573
|
:policy,
|
|
4595
4574
|
:tags,
|
|
4596
|
-
:disable_execute_api_endpoint
|
|
4575
|
+
:disable_execute_api_endpoint,
|
|
4576
|
+
:root_resource_id)
|
|
4597
4577
|
SENSITIVE = []
|
|
4598
4578
|
include Aws::Structure
|
|
4599
4579
|
end
|
|
@@ -4986,7 +4966,7 @@ module Aws::APIGateway
|
|
|
4986
4966
|
# @return [String]
|
|
4987
4967
|
#
|
|
4988
4968
|
# @!attribute [rw] latency
|
|
4989
|
-
# The execution latency of the test authorizer request.
|
|
4969
|
+
# The execution latency, in ms, of the test authorizer request.
|
|
4990
4970
|
# @return [Integer]
|
|
4991
4971
|
#
|
|
4992
4972
|
# @!attribute [rw] principal_id
|
|
@@ -5101,7 +5081,7 @@ module Aws::APIGateway
|
|
|
5101
5081
|
# @return [String]
|
|
5102
5082
|
#
|
|
5103
5083
|
# @!attribute [rw] latency
|
|
5104
|
-
# The execution latency of the test invoke request.
|
|
5084
|
+
# The execution latency, in ms, of the test invoke request.
|
|
5105
5085
|
# @return [Integer]
|
|
5106
5086
|
#
|
|
5107
5087
|
class TestInvokeMethodResponse < Struct.new(
|
|
@@ -5379,7 +5359,7 @@ module Aws::APIGateway
|
|
|
5379
5359
|
# Updates an existing documentation version of an API.
|
|
5380
5360
|
#
|
|
5381
5361
|
# @!attribute [rw] rest_api_id
|
|
5382
|
-
# The string identifier of the associated RestApi
|
|
5362
|
+
# The string identifier of the associated RestApi.
|
|
5383
5363
|
# @return [String]
|
|
5384
5364
|
#
|
|
5385
5365
|
# @!attribute [rw] documentation_version
|
|
@@ -5870,8 +5850,9 @@ module Aws::APIGateway
|
|
|
5870
5850
|
# @return [Types::QuotaSettings]
|
|
5871
5851
|
#
|
|
5872
5852
|
# @!attribute [rw] product_code
|
|
5873
|
-
# The
|
|
5874
|
-
# plan as a SaaS product on
|
|
5853
|
+
# The Amazon Web Services Marketplace product identifier to associate
|
|
5854
|
+
# with the usage plan as a SaaS product on the Amazon Web Services
|
|
5855
|
+
# Marketplace.
|
|
5875
5856
|
# @return [String]
|
|
5876
5857
|
#
|
|
5877
5858
|
# @!attribute [rw] tags
|
|
@@ -5971,8 +5952,8 @@ module Aws::APIGateway
|
|
|
5971
5952
|
#
|
|
5972
5953
|
# @!attribute [rw] target_arns
|
|
5973
5954
|
# The ARN of the network load balancer of the VPC targeted by the VPC
|
|
5974
|
-
# link. The network load balancer must be owned by the same
|
|
5975
|
-
# account of the API owner.
|
|
5955
|
+
# link. The network load balancer must be owned by the same Amazon Web
|
|
5956
|
+
# Services account of the API owner.
|
|
5976
5957
|
# @return [Array<String>]
|
|
5977
5958
|
#
|
|
5978
5959
|
# @!attribute [rw] status
|
data/lib/aws-sdk-apigateway.rb
CHANGED
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.87.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: 2023-
|
|
11
|
+
date: 2023-08-23 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: aws-sdk-core
|