aws-sdk-apigateway 1.17.0 → 1.18.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-apigateway.rb +1 -1
- data/lib/aws-sdk-apigateway/client.rb +58 -77
- data/lib/aws-sdk-apigateway/client_api.rb +6 -7
- data/lib/aws-sdk-apigateway/types.rb +227 -386
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2139dd9efcf10ab11e862865329839e14b84fc0e
|
4
|
+
data.tar.gz: 26f79ab20bc12b2570086dfcadaea36c56829b0b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8944a844a3b904156ff76b294dd2032020dd63b24d6cefee54af738bf7f2de3c2440bd241911fe57530e4372972b04644109af38ae54556453c68207d998b991
|
7
|
+
data.tar.gz: 90d327c485d68557dcc6edbb29c6245f53f04919b51584d14115e46a75d0b20316512f41bb83e4474b55d5047aa08c3e9b74c080ba451e8a36bc6ada32256af6
|
data/lib/aws-sdk-apigateway.rb
CHANGED
@@ -181,13 +181,10 @@ module Aws::APIGateway
|
|
181
181
|
# Create an ApiKey resource.
|
182
182
|
#
|
183
183
|
# <div class="seeAlso">
|
184
|
-
# [AWS
|
184
|
+
# [AWS
|
185
|
+
# CLI]([[AwsDocsUrlPrefix]]/cli/latest/reference/apigateway/create-api-key.html)
|
185
186
|
# </div>
|
186
187
|
#
|
187
|
-
#
|
188
|
-
#
|
189
|
-
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html
|
190
|
-
#
|
191
188
|
# @option params [String] :name
|
192
189
|
# The name of the ApiKey.
|
193
190
|
#
|
@@ -264,13 +261,10 @@ module Aws::APIGateway
|
|
264
261
|
# Adds a new Authorizer resource to an existing RestApi resource.
|
265
262
|
#
|
266
263
|
# <div class="seeAlso">
|
267
|
-
# [AWS
|
264
|
+
# [AWS
|
265
|
+
# CLI]([[AwsDocsUrlPrefix]]/cli/latest/reference/apigateway/create-authorizer.html)
|
268
266
|
# </div>
|
269
267
|
#
|
270
|
-
#
|
271
|
-
#
|
272
|
-
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html
|
273
|
-
#
|
274
268
|
# @option params [required, String] :rest_api_id
|
275
269
|
# \[Required\] The string identifier of the associated RestApi.
|
276
270
|
#
|
@@ -291,7 +285,7 @@ module Aws::APIGateway
|
|
291
285
|
# For a `TOKEN` or `REQUEST` authorizer, this is not defined.
|
292
286
|
#
|
293
287
|
# @option params [String] :auth_type
|
294
|
-
# Optional customer-defined field, used in
|
288
|
+
# Optional customer-defined field, used in Swagger imports and exports
|
295
289
|
# without functional impact.
|
296
290
|
#
|
297
291
|
# @option params [String] :authorizer_uri
|
@@ -540,7 +534,7 @@ module Aws::APIGateway
|
|
540
534
|
# @option params [required, String] :properties
|
541
535
|
# \[Required\] The new documentation content map of the targeted API
|
542
536
|
# entity. Enclosed key-value pairs are API-specific, but only
|
543
|
-
#
|
537
|
+
# Swagger-compliant key-value pairs can be exported and, hence,
|
544
538
|
# published.
|
545
539
|
#
|
546
540
|
# @return [Types::DocumentationPart] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -731,11 +725,7 @@ module Aws::APIGateway
|
|
731
725
|
#
|
732
726
|
# @option params [String] :schema
|
733
727
|
# The schema for the model. For `application/json` models, this should
|
734
|
-
# be [JSON schema draft 4][
|
735
|
-
#
|
736
|
-
#
|
737
|
-
#
|
738
|
-
# [1]: https://tools.ietf.org/html/draft-zyp-json-schema-04
|
728
|
+
# be [JSON schema draft 4]([[JsonSchemaUrl]]) model.
|
739
729
|
#
|
740
730
|
# @option params [required, String] :content_type
|
741
731
|
# \[Required\] The content-type for the model.
|
@@ -1327,13 +1317,10 @@ module Aws::APIGateway
|
|
1327
1317
|
# Deletes an existing Authorizer resource.
|
1328
1318
|
#
|
1329
1319
|
# <div class="seeAlso">
|
1330
|
-
# [AWS
|
1320
|
+
# [AWS
|
1321
|
+
# CLI]([[AwsDocsUrlPrefix]]/cli/latest/reference/apigateway/delete-authorizer.html)
|
1331
1322
|
# </div>
|
1332
1323
|
#
|
1333
|
-
#
|
1334
|
-
#
|
1335
|
-
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html
|
1336
|
-
#
|
1337
1324
|
# @option params [required, String] :rest_api_id
|
1338
1325
|
# \[Required\] The string identifier of the associated RestApi.
|
1339
1326
|
#
|
@@ -2066,13 +2053,10 @@ module Aws::APIGateway
|
|
2066
2053
|
# Describe an existing Authorizer resource.
|
2067
2054
|
#
|
2068
2055
|
# <div class="seeAlso">
|
2069
|
-
# [AWS
|
2056
|
+
# [AWS
|
2057
|
+
# CLI]([[AwsDocsUrlPrefix]]/cli/latest/reference/apigateway/get-authorizer.html)
|
2070
2058
|
# </div>
|
2071
2059
|
#
|
2072
|
-
#
|
2073
|
-
#
|
2074
|
-
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html
|
2075
|
-
#
|
2076
2060
|
# @option params [required, String] :rest_api_id
|
2077
2061
|
# \[Required\] The string identifier of the associated RestApi.
|
2078
2062
|
#
|
@@ -2123,13 +2107,10 @@ module Aws::APIGateway
|
|
2123
2107
|
# Describe an existing Authorizers resource.
|
2124
2108
|
#
|
2125
2109
|
# <div class="seeAlso">
|
2126
|
-
# [AWS
|
2110
|
+
# [AWS
|
2111
|
+
# CLI]([[AwsDocsUrlPrefix]]/cli/latest/reference/apigateway/get-authorizers.html)
|
2127
2112
|
# </div>
|
2128
2113
|
#
|
2129
|
-
#
|
2130
|
-
#
|
2131
|
-
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html
|
2132
|
-
#
|
2133
2114
|
# @option params [required, String] :rest_api_id
|
2134
2115
|
# \[Required\] The string identifier of the associated RestApi.
|
2135
2116
|
#
|
@@ -2696,15 +2677,15 @@ module Aws::APIGateway
|
|
2696
2677
|
# \[Required\] The name of the Stage that will be exported.
|
2697
2678
|
#
|
2698
2679
|
# @option params [required, String] :export_type
|
2699
|
-
# \[Required\] The type of export.
|
2700
|
-
#
|
2680
|
+
# \[Required\] The type of export. Currently only 'swagger' is
|
2681
|
+
# supported.
|
2701
2682
|
#
|
2702
2683
|
# @option params [Hash<String,String>] :parameters
|
2703
2684
|
# A key-value map of query string parameters that specify properties of
|
2704
2685
|
# the export, depending on the requested `exportType`. For `exportType`
|
2705
|
-
# `
|
2706
|
-
#
|
2707
|
-
#
|
2686
|
+
# `swagger`, any combination of the following parameters are supported:
|
2687
|
+
# `extensions='integrations'` or `extensions='apigateway'` will export
|
2688
|
+
# the API with x-amazon-apigateway-integration extensions.
|
2708
2689
|
# `extensions='authorizers'` will export the API with
|
2709
2690
|
# x-amazon-apigateway-authorizer extensions. `postman` will export the
|
2710
2691
|
# API with Postman extensions, allowing for import to the Postman tool
|
@@ -2712,8 +2693,8 @@ module Aws::APIGateway
|
|
2712
2693
|
# @option params [String] :accepts
|
2713
2694
|
# The content-type of the export, for example `application/json`.
|
2714
2695
|
# Currently `application/json` and `application/yaml` are supported for
|
2715
|
-
# `exportType` of
|
2716
|
-
#
|
2696
|
+
# `exportType` of `swagger`. This should be specified in the `Accept`
|
2697
|
+
# header for direct API requests.
|
2717
2698
|
#
|
2718
2699
|
# @return [Types::ExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2719
2700
|
#
|
@@ -4216,11 +4197,8 @@ module Aws::APIGateway
|
|
4216
4197
|
#
|
4217
4198
|
# @option params [required, String, IO] :body
|
4218
4199
|
# The payload of the POST request to import API keys. For the payload
|
4219
|
-
# format, see [API Key File
|
4220
|
-
#
|
4221
|
-
#
|
4222
|
-
#
|
4223
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-file-format.html
|
4200
|
+
# format, see [API Key File
|
4201
|
+
# Format]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-key-file-format.html).
|
4224
4202
|
#
|
4225
4203
|
# @option params [required, String] :format
|
4226
4204
|
# A query parameter to specify the input format to imported API keys.
|
@@ -4272,7 +4250,7 @@ module Aws::APIGateway
|
|
4272
4250
|
#
|
4273
4251
|
# @option params [required, String, IO] :body
|
4274
4252
|
# \[Required\] Raw byte array representing the to-be-imported
|
4275
|
-
# documentation parts. To import from
|
4253
|
+
# documentation parts. To import from a Swagger file, this is a JSON
|
4276
4254
|
# object.
|
4277
4255
|
#
|
4278
4256
|
# @return [Types::DocumentationPartIds] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -4340,7 +4318,7 @@ module Aws::APIGateway
|
|
4340
4318
|
#
|
4341
4319
|
# @option params [required, String, IO] :body
|
4342
4320
|
# \[Required\] The POST request body containing external API
|
4343
|
-
# definitions. Currently, only
|
4321
|
+
# definitions. Currently, only Swagger definition JSON files are
|
4344
4322
|
# supported. The maximum size of the API definition file is 2MB.
|
4345
4323
|
#
|
4346
4324
|
# @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -4495,10 +4473,10 @@ module Aws::APIGateway
|
|
4495
4473
|
#
|
4496
4474
|
# * For `HTTP` or `HTTP_PROXY` integrations, the URI must be a fully
|
4497
4475
|
# formed, encoded HTTP(S) URL according to the [RFC-3986
|
4498
|
-
# specification][
|
4499
|
-
# `connectionType` is not `VPC_LINK`, or private
|
4500
|
-
# `connectionType` is `VPC_LINK`. For a private
|
4501
|
-
# URI is not used for routing.
|
4476
|
+
# specification]([[UriEntryWikipediaUrl]]), for either standard
|
4477
|
+
# integration, where `connectionType` is not `VPC_LINK`, or private
|
4478
|
+
# integration, where `connectionType` is `VPC_LINK`. For a private
|
4479
|
+
# HTTP integration, the URI is not used for routing.
|
4502
4480
|
#
|
4503
4481
|
# * For `AWS` or `AWS_PROXY` integrations, the URI is of the form
|
4504
4482
|
# `arn:aws:apigateway:\{region\}:\{subdomain.service|service\}:path|action/\{service_api\}`.
|
@@ -4517,10 +4495,6 @@ module Aws::APIGateway
|
|
4517
4495
|
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket=\{bucket\}&Key=\{key\}`
|
4518
4496
|
# or `arn:aws:apigateway:us-west-2:s3:path/\{bucket\}/\{key\}`
|
4519
4497
|
#
|
4520
|
-
#
|
4521
|
-
#
|
4522
|
-
# [1]: https://en.wikipedia.org/wiki/Uniform_Resource_Identifier
|
4523
|
-
#
|
4524
4498
|
# @option params [String] :connection_type
|
4525
4499
|
# The type of the network connection to the integration endpoint. The
|
4526
4500
|
# valid value is `INTERNET` for connections through the public routable
|
@@ -4528,12 +4502,10 @@ module Aws::APIGateway
|
|
4528
4502
|
# a network load balancer in a VPC. The default value is `INTERNET`.
|
4529
4503
|
#
|
4530
4504
|
# @option params [String] :connection_id
|
4531
|
-
# The
|
4532
|
-
# `
|
4533
|
-
#
|
4534
|
-
#
|
4535
|
-
#
|
4536
|
-
# [1]: https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id
|
4505
|
+
# The
|
4506
|
+
# ([`id`]([[AwsDocsUrlPrefix]]/apigateway/api-reference/resource/vpc-link/#id))
|
4507
|
+
# of the VpcLink used for the integration when `connectionType=VPC_LINK`
|
4508
|
+
# and undefined, otherwise.
|
4537
4509
|
#
|
4538
4510
|
# @option params [String] :credentials
|
4539
4511
|
# Specifies whether credentials are required for a put integration.
|
@@ -4796,11 +4768,7 @@ module Aws::APIGateway
|
|
4796
4768
|
# @option params [String] :operation_name
|
4797
4769
|
# A human-friendly operation identifier for the method. For example, you
|
4798
4770
|
# can assign the `operationName` of `ListPets` for the `GET /pets`
|
4799
|
-
# method in [PetStore][
|
4800
|
-
#
|
4801
|
-
#
|
4802
|
-
#
|
4803
|
-
# [1]: https://petstore-demo-endpoint.execute-api.com/petstore/pets
|
4771
|
+
# method in [PetStore]([[PetstoreDemoUrl]]) example.
|
4804
4772
|
#
|
4805
4773
|
# @option params [Hash<String,Boolean>] :request_parameters
|
4806
4774
|
# A key-value map defining required or optional method request
|
@@ -5018,7 +4986,7 @@ module Aws::APIGateway
|
|
5018
4986
|
#
|
5019
4987
|
# @option params [required, String, IO] :body
|
5020
4988
|
# \[Required\] The PUT request body containing external API definitions.
|
5021
|
-
# Currently, only
|
4989
|
+
# Currently, only Swagger definition JSON files are supported. The
|
5022
4990
|
# maximum size of the API definition file is 2MB.
|
5023
4991
|
#
|
5024
4992
|
# @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -5105,13 +5073,10 @@ module Aws::APIGateway
|
|
5105
5073
|
# parameters, and an incoming request body.
|
5106
5074
|
#
|
5107
5075
|
# <div class="seeAlso">
|
5108
|
-
# [Enable custom
|
5076
|
+
# [Enable custom
|
5077
|
+
# authorizers]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/use-custom-authorizer.html)
|
5109
5078
|
# </div>
|
5110
5079
|
#
|
5111
|
-
#
|
5112
|
-
#
|
5113
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html
|
5114
|
-
#
|
5115
5080
|
# @option params [required, String] :rest_api_id
|
5116
5081
|
# \[Required\] The string identifier of the associated RestApi.
|
5117
5082
|
#
|
@@ -5124,6 +5089,11 @@ module Aws::APIGateway
|
|
5124
5089
|
# invocation request. This is where the incoming authorization token, or
|
5125
5090
|
# identity source, should be specified.
|
5126
5091
|
#
|
5092
|
+
# @option params [Hash<String,Array>] :multi_value_headers
|
5093
|
+
# \[Optional\] The headers as a map from string to list of values to
|
5094
|
+
# simulate an incoming invocation request. This is where the incoming
|
5095
|
+
# authorization token, or identity source, may be specified.
|
5096
|
+
#
|
5127
5097
|
# @option params [String] :path_with_query_string
|
5128
5098
|
# \[Optional\] The URI path, including query string, of the simulated
|
5129
5099
|
# invocation request. Use this to specify path parameters and query
|
@@ -5158,6 +5128,9 @@ module Aws::APIGateway
|
|
5158
5128
|
# headers: {
|
5159
5129
|
# "String" => "String",
|
5160
5130
|
# },
|
5131
|
+
# multi_value_headers: {
|
5132
|
+
# "String" => ["String"],
|
5133
|
+
# },
|
5161
5134
|
# path_with_query_string: "String",
|
5162
5135
|
# body: "String",
|
5163
5136
|
# stage_variables: {
|
@@ -5211,6 +5184,10 @@ module Aws::APIGateway
|
|
5211
5184
|
# @option params [Hash<String,String>] :headers
|
5212
5185
|
# A key-value map of headers to simulate an incoming invocation request.
|
5213
5186
|
#
|
5187
|
+
# @option params [Hash<String,Array>] :multi_value_headers
|
5188
|
+
# The headers as a map from string to list of values to simulate an
|
5189
|
+
# incoming invocation request.
|
5190
|
+
#
|
5214
5191
|
# @option params [String] :client_certificate_id
|
5215
5192
|
# A ClientCertificate identifier to use in the test invocation. API
|
5216
5193
|
# Gateway will use the certificate when making the HTTPS request to the
|
@@ -5225,6 +5202,7 @@ module Aws::APIGateway
|
|
5225
5202
|
# * {Types::TestInvokeMethodResponse#status #status} => Integer
|
5226
5203
|
# * {Types::TestInvokeMethodResponse#body #body} => String
|
5227
5204
|
# * {Types::TestInvokeMethodResponse#headers #headers} => Hash<String,String>
|
5205
|
+
# * {Types::TestInvokeMethodResponse#multi_value_headers #multi_value_headers} => Hash<String,Array<String>>
|
5228
5206
|
# * {Types::TestInvokeMethodResponse#log #log} => String
|
5229
5207
|
# * {Types::TestInvokeMethodResponse#latency #latency} => Integer
|
5230
5208
|
#
|
@@ -5239,6 +5217,9 @@ module Aws::APIGateway
|
|
5239
5217
|
# headers: {
|
5240
5218
|
# "String" => "String",
|
5241
5219
|
# },
|
5220
|
+
# multi_value_headers: {
|
5221
|
+
# "String" => ["String"],
|
5222
|
+
# },
|
5242
5223
|
# client_certificate_id: "String",
|
5243
5224
|
# stage_variables: {
|
5244
5225
|
# "String" => "String",
|
@@ -5251,6 +5232,9 @@ module Aws::APIGateway
|
|
5251
5232
|
# resp.body #=> String
|
5252
5233
|
# resp.headers #=> Hash
|
5253
5234
|
# resp.headers["String"] #=> String
|
5235
|
+
# resp.multi_value_headers #=> Hash
|
5236
|
+
# resp.multi_value_headers["String"] #=> Array
|
5237
|
+
# resp.multi_value_headers["String"][0] #=> String
|
5254
5238
|
# resp.log #=> String
|
5255
5239
|
# resp.latency #=> Integer
|
5256
5240
|
#
|
@@ -5387,13 +5371,10 @@ module Aws::APIGateway
|
|
5387
5371
|
# Updates an existing Authorizer resource.
|
5388
5372
|
#
|
5389
5373
|
# <div class="seeAlso">
|
5390
|
-
# [AWS
|
5374
|
+
# [AWS
|
5375
|
+
# CLI]([[AwsDocsUrlPrefix]]/cli/latest/reference/apigateway/update-authorizer.html)
|
5391
5376
|
# </div>
|
5392
5377
|
#
|
5393
|
-
#
|
5394
|
-
#
|
5395
|
-
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html
|
5396
|
-
#
|
5397
5378
|
# @option params [required, String] :rest_api_id
|
5398
5379
|
# \[Required\] The string identifier of the associated RestApi.
|
5399
5380
|
#
|
@@ -6641,7 +6622,7 @@ module Aws::APIGateway
|
|
6641
6622
|
params: params,
|
6642
6623
|
config: config)
|
6643
6624
|
context[:gem_name] = 'aws-sdk-apigateway'
|
6644
|
-
context[:gem_version] = '1.
|
6625
|
+
context[:gem_version] = '1.18.0'
|
6645
6626
|
Seahorse::Client::Request.new(handlers, context)
|
6646
6627
|
end
|
6647
6628
|
|
@@ -178,7 +178,6 @@ module Aws::APIGateway
|
|
178
178
|
LocationStatusType = Shapes::StringShape.new(name: 'LocationStatusType')
|
179
179
|
Long = Shapes::IntegerShape.new(name: 'Long')
|
180
180
|
MapOfApiStageThrottleSettings = Shapes::MapShape.new(name: 'MapOfApiStageThrottleSettings')
|
181
|
-
MapOfHeaderValues = Shapes::MapShape.new(name: 'MapOfHeaderValues')
|
182
181
|
MapOfIntegrationResponse = Shapes::MapShape.new(name: 'MapOfIntegrationResponse')
|
183
182
|
MapOfKeyUsages = Shapes::MapShape.new(name: 'MapOfKeyUsages')
|
184
183
|
MapOfMethod = Shapes::MapShape.new(name: 'MapOfMethod')
|
@@ -960,9 +959,6 @@ module Aws::APIGateway
|
|
960
959
|
MapOfApiStageThrottleSettings.key = Shapes::ShapeRef.new(shape: String)
|
961
960
|
MapOfApiStageThrottleSettings.value = Shapes::ShapeRef.new(shape: ThrottleSettings)
|
962
961
|
|
963
|
-
MapOfHeaderValues.key = Shapes::ShapeRef.new(shape: String)
|
964
|
-
MapOfHeaderValues.value = Shapes::ShapeRef.new(shape: String)
|
965
|
-
|
966
962
|
MapOfIntegrationResponse.key = Shapes::ShapeRef.new(shape: String)
|
967
963
|
MapOfIntegrationResponse.value = Shapes::ShapeRef.new(shape: IntegrationResponse)
|
968
964
|
|
@@ -1213,7 +1209,8 @@ module Aws::APIGateway
|
|
1213
1209
|
|
1214
1210
|
TestInvokeAuthorizerRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
1215
1211
|
TestInvokeAuthorizerRequest.add_member(:authorizer_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "authorizer_id"))
|
1216
|
-
TestInvokeAuthorizerRequest.add_member(:headers, Shapes::ShapeRef.new(shape:
|
1212
|
+
TestInvokeAuthorizerRequest.add_member(:headers, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "headers"))
|
1213
|
+
TestInvokeAuthorizerRequest.add_member(:multi_value_headers, Shapes::ShapeRef.new(shape: MapOfStringToList, location_name: "multiValueHeaders"))
|
1217
1214
|
TestInvokeAuthorizerRequest.add_member(:path_with_query_string, Shapes::ShapeRef.new(shape: String, location_name: "pathWithQueryString"))
|
1218
1215
|
TestInvokeAuthorizerRequest.add_member(:body, Shapes::ShapeRef.new(shape: String, location_name: "body"))
|
1219
1216
|
TestInvokeAuthorizerRequest.add_member(:stage_variables, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "stageVariables"))
|
@@ -1234,14 +1231,16 @@ module Aws::APIGateway
|
|
1234
1231
|
TestInvokeMethodRequest.add_member(:http_method, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "http_method"))
|
1235
1232
|
TestInvokeMethodRequest.add_member(:path_with_query_string, Shapes::ShapeRef.new(shape: String, location_name: "pathWithQueryString"))
|
1236
1233
|
TestInvokeMethodRequest.add_member(:body, Shapes::ShapeRef.new(shape: String, location_name: "body"))
|
1237
|
-
TestInvokeMethodRequest.add_member(:headers, Shapes::ShapeRef.new(shape:
|
1234
|
+
TestInvokeMethodRequest.add_member(:headers, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "headers"))
|
1235
|
+
TestInvokeMethodRequest.add_member(:multi_value_headers, Shapes::ShapeRef.new(shape: MapOfStringToList, location_name: "multiValueHeaders"))
|
1238
1236
|
TestInvokeMethodRequest.add_member(:client_certificate_id, Shapes::ShapeRef.new(shape: String, location_name: "clientCertificateId"))
|
1239
1237
|
TestInvokeMethodRequest.add_member(:stage_variables, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "stageVariables"))
|
1240
1238
|
TestInvokeMethodRequest.struct_class = Types::TestInvokeMethodRequest
|
1241
1239
|
|
1242
1240
|
TestInvokeMethodResponse.add_member(:status, Shapes::ShapeRef.new(shape: Integer, location_name: "status"))
|
1243
1241
|
TestInvokeMethodResponse.add_member(:body, Shapes::ShapeRef.new(shape: String, location_name: "body"))
|
1244
|
-
TestInvokeMethodResponse.add_member(:headers, Shapes::ShapeRef.new(shape:
|
1242
|
+
TestInvokeMethodResponse.add_member(:headers, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "headers"))
|
1243
|
+
TestInvokeMethodResponse.add_member(:multi_value_headers, Shapes::ShapeRef.new(shape: MapOfStringToList, location_name: "multiValueHeaders"))
|
1245
1244
|
TestInvokeMethodResponse.add_member(:log, Shapes::ShapeRef.new(shape: String, location_name: "log"))
|
1246
1245
|
TestInvokeMethodResponse.add_member(:latency, Shapes::ShapeRef.new(shape: Long, location_name: "latency"))
|
1247
1246
|
TestInvokeMethodResponse.struct_class = Types::TestInvokeMethodResponse
|
@@ -13,12 +13,9 @@ module Aws::APIGateway
|
|
13
13
|
#
|
14
14
|
# @!attribute [rw] format
|
15
15
|
# A single line format of the access logs of data, as specified by
|
16
|
-
# selected [$context
|
17
|
-
#
|
18
|
-
#
|
19
|
-
#
|
20
|
-
#
|
21
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference
|
16
|
+
# selected [$context
|
17
|
+
# variables]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference).
|
18
|
+
# The format must include at least `$context.requestId`.
|
22
19
|
# @return [String]
|
23
20
|
#
|
24
21
|
# @!attribute [rw] destination_arn
|
@@ -45,7 +42,8 @@ module Aws::APIGateway
|
|
45
42
|
# * TooManyRequestsException
|
46
43
|
#
|
47
44
|
# For detailed error code information, including the corresponding HTTP
|
48
|
-
# Status Codes, see [API Gateway Error
|
45
|
+
# Status Codes, see [API Gateway Error
|
46
|
+
# Codes]([[AwsDocsUrlPrefix]]/apigateway/api-reference/handling-errors/#api-error-codes)
|
49
47
|
#
|
50
48
|
# #### Example: Get the information about an account.
|
51
49
|
#
|
@@ -58,7 +56,7 @@ module Aws::APIGateway
|
|
58
56
|
# The successful response returns a `200 OK` status code and a payload
|
59
57
|
# similar to the following:
|
60
58
|
#
|
61
|
-
# \{ "_links": \{ "curies": \{ "href": "
|
59
|
+
# \{ "_links": \{ "curies": \{ "href": "[[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/account-apigateway-\{rel\}.html", "name": "account", "templated": true \}, "self": \{ "href": "/account" \}, "account:update": \{ "href": "/account" \} \}, "cloudwatchRoleArn": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "throttleSettings": \{ "rateLimit": 500, "burstLimit": 1000 \} \}
|
62
60
|
#
|
63
61
|
# In addition to making the REST API call directly, you can use the AWS
|
64
62
|
# CLI and an AWS SDK to access this resource.
|
@@ -66,16 +64,14 @@ module Aws::APIGateway
|
|
66
64
|
# </div>
|
67
65
|
#
|
68
66
|
# <div class="seeAlso">
|
69
|
-
# [API Gateway
|
67
|
+
# [API Gateway
|
68
|
+
# Limits]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-limits.html)
|
69
|
+
# [Developer
|
70
|
+
# Guide]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/welcome.html),
|
71
|
+
# [AWS
|
72
|
+
# CLI]([[AwsDocsUrlPrefix]]/cli/latest/reference/apigateway/get-account.html)
|
70
73
|
# </div>
|
71
74
|
#
|
72
|
-
#
|
73
|
-
#
|
74
|
-
# [1]: https://docs.aws.amazon.com/apigateway/api-reference/handling-errors/#api-error-codes
|
75
|
-
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-limits.html
|
76
|
-
# [3]: https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html
|
77
|
-
# [4]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-account.html
|
78
|
-
#
|
79
75
|
# @!attribute [rw] cloudwatch_role_arn
|
80
76
|
# The ARN of an Amazon CloudWatch role for the current Account.
|
81
77
|
# @return [String]
|
@@ -107,13 +103,10 @@ module Aws::APIGateway
|
|
107
103
|
# make requests to that stage.
|
108
104
|
#
|
109
105
|
# <div class="seeAlso">
|
110
|
-
# [Use API
|
106
|
+
# [Use API
|
107
|
+
# Keys]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/how-to-api-keys.html)
|
111
108
|
# </div>
|
112
109
|
#
|
113
|
-
#
|
114
|
-
#
|
115
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html
|
116
|
-
#
|
117
110
|
# @!attribute [rw] id
|
118
111
|
# The identifier of the API Key.
|
119
112
|
# @return [String]
|
@@ -185,13 +178,10 @@ module Aws::APIGateway
|
|
185
178
|
# resource.
|
186
179
|
#
|
187
180
|
# <div class="seeAlso">
|
188
|
-
# [Use API
|
181
|
+
# [Use API
|
182
|
+
# Keys]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/how-to-api-keys.html)
|
189
183
|
# </div>
|
190
184
|
#
|
191
|
-
#
|
192
|
-
#
|
193
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html
|
194
|
-
#
|
195
185
|
# @!attribute [rw] warnings
|
196
186
|
# A list of warning messages logged during the import of API keys when
|
197
187
|
# the `failOnWarnings` option is set to true.
|
@@ -252,13 +242,10 @@ module Aws::APIGateway
|
|
252
242
|
# method.
|
253
243
|
#
|
254
244
|
# <div class="seeAlso">
|
255
|
-
# [Enable custom
|
245
|
+
# [Enable custom
|
246
|
+
# authorization]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/use-custom-authorizer.html)
|
256
247
|
# </div>
|
257
248
|
#
|
258
|
-
#
|
259
|
-
#
|
260
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html
|
261
|
-
#
|
262
249
|
# @!attribute [rw] id
|
263
250
|
# The identifier for the authorizer resource.
|
264
251
|
# @return [String]
|
@@ -282,7 +269,7 @@ module Aws::APIGateway
|
|
282
269
|
# @return [Array<String>]
|
283
270
|
#
|
284
271
|
# @!attribute [rw] auth_type
|
285
|
-
# Optional customer-defined field, used in
|
272
|
+
# Optional customer-defined field, used in Swagger imports and exports
|
286
273
|
# without functional impact.
|
287
274
|
# @return [String]
|
288
275
|
#
|
@@ -365,13 +352,10 @@ module Aws::APIGateway
|
|
365
352
|
# Represents a collection of Authorizer resources.
|
366
353
|
#
|
367
354
|
# <div class="seeAlso">
|
368
|
-
# [Enable custom
|
355
|
+
# [Enable custom
|
356
|
+
# authorization]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/use-custom-authorizer.html)
|
369
357
|
# </div>
|
370
358
|
#
|
371
|
-
#
|
372
|
-
#
|
373
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html
|
374
|
-
#
|
375
359
|
# @!attribute [rw] position
|
376
360
|
# @return [String]
|
377
361
|
#
|
@@ -394,13 +378,10 @@ module Aws::APIGateway
|
|
394
378
|
# </div>
|
395
379
|
#
|
396
380
|
# <div class="seeAlso">
|
397
|
-
# [Use Custom Domain
|
381
|
+
# [Use Custom Domain
|
382
|
+
# Names]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/how-to-custom-domains.html)
|
398
383
|
# </div>
|
399
384
|
#
|
400
|
-
#
|
401
|
-
#
|
402
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html
|
403
|
-
#
|
404
385
|
# @!attribute [rw] base_path
|
405
386
|
# The base path name that callers of the API must provide as part of
|
406
387
|
# the URL after the domain name.
|
@@ -424,13 +405,10 @@ module Aws::APIGateway
|
|
424
405
|
# Represents a collection of BasePathMapping resources.
|
425
406
|
#
|
426
407
|
# <div class="seeAlso">
|
427
|
-
# [Use Custom Domain
|
408
|
+
# [Use Custom Domain
|
409
|
+
# Names]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/how-to-custom-domains.html)
|
428
410
|
# </div>
|
429
411
|
#
|
430
|
-
#
|
431
|
-
#
|
432
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html
|
433
|
-
#
|
434
412
|
# @!attribute [rw] position
|
435
413
|
# @return [String]
|
436
414
|
#
|
@@ -496,13 +474,10 @@ module Aws::APIGateway
|
|
496
474
|
# </div>
|
497
475
|
#
|
498
476
|
# <div class="seeAlso">
|
499
|
-
# [Use Client-Side
|
477
|
+
# [Use Client-Side
|
478
|
+
# Certificate]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html)
|
500
479
|
# </div>
|
501
480
|
#
|
502
|
-
#
|
503
|
-
#
|
504
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html
|
505
|
-
#
|
506
481
|
# @!attribute [rw] client_certificate_id
|
507
482
|
# The identifier of the client certificate.
|
508
483
|
# @return [String]
|
@@ -537,13 +512,10 @@ module Aws::APIGateway
|
|
537
512
|
# Represents a collection of ClientCertificate resources.
|
538
513
|
#
|
539
514
|
# <div class="seeAlso">
|
540
|
-
# [Use Client-Side
|
515
|
+
# [Use Client-Side
|
516
|
+
# Certificate]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html)
|
541
517
|
# </div>
|
542
518
|
#
|
543
|
-
#
|
544
|
-
#
|
545
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html
|
546
|
-
#
|
547
519
|
# @!attribute [rw] position
|
548
520
|
# @return [String]
|
549
521
|
#
|
@@ -661,7 +633,7 @@ module Aws::APIGateway
|
|
661
633
|
# @return [Array<String>]
|
662
634
|
#
|
663
635
|
# @!attribute [rw] auth_type
|
664
|
-
# Optional customer-defined field, used in
|
636
|
+
# Optional customer-defined field, used in Swagger imports and exports
|
665
637
|
# without functional impact.
|
666
638
|
# @return [String]
|
667
639
|
#
|
@@ -895,7 +867,7 @@ module Aws::APIGateway
|
|
895
867
|
# @!attribute [rw] properties
|
896
868
|
# \[Required\] The new documentation content map of the targeted API
|
897
869
|
# entity. Enclosed key-value pairs are API-specific, but only
|
898
|
-
#
|
870
|
+
# Swagger-compliant key-value pairs can be exported and, hence,
|
899
871
|
# published.
|
900
872
|
# @return [String]
|
901
873
|
#
|
@@ -1055,11 +1027,7 @@ module Aws::APIGateway
|
|
1055
1027
|
#
|
1056
1028
|
# @!attribute [rw] schema
|
1057
1029
|
# The schema for the model. For `application/json` models, this should
|
1058
|
-
# be [JSON schema draft 4][
|
1059
|
-
#
|
1060
|
-
#
|
1061
|
-
#
|
1062
|
-
# [1]: https://tools.ietf.org/html/draft-zyp-json-schema-04
|
1030
|
+
# be [JSON schema draft 4]([[JsonSchemaUrl]]) model.
|
1063
1031
|
# @return [String]
|
1064
1032
|
#
|
1065
1033
|
# @!attribute [rw] content_type
|
@@ -2003,14 +1971,11 @@ module Aws::APIGateway
|
|
2003
1971
|
# </div>
|
2004
1972
|
#
|
2005
1973
|
# <div class="seeAlso">
|
2006
|
-
# RestApi, Deployments, Stage, [AWS
|
1974
|
+
# RestApi, Deployments, Stage, [AWS
|
1975
|
+
# CLI]([[AwsDocsUrlPrefix]]/cli/latest/reference/apigateway/get-deployment.html),
|
1976
|
+
# [AWS SDKs]([[AwsAmazonUrlPrefix]]/tools/)
|
2007
1977
|
# </div>
|
2008
1978
|
#
|
2009
|
-
#
|
2010
|
-
#
|
2011
|
-
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-deployment.html
|
2012
|
-
# [2]: https://aws.amazon.com/tools/
|
2013
|
-
#
|
2014
1979
|
# @!attribute [rw] id
|
2015
1980
|
# The identifier for the deployment resource.
|
2016
1981
|
# @return [String]
|
@@ -2087,15 +2052,13 @@ module Aws::APIGateway
|
|
2087
2052
|
# </div>
|
2088
2053
|
#
|
2089
2054
|
# <div class="seeAlso">
|
2090
|
-
# [Deploying an
|
2055
|
+
# [Deploying an
|
2056
|
+
# API]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/how-to-deploy-api.html),
|
2057
|
+
# [AWS
|
2058
|
+
# CLI]([[AwsDocsUrlPrefix]]/cli/latest/reference/apigateway/get-deployment.html),
|
2059
|
+
# [AWS SDKs]([[AwsAmazonUrlPrefix]]/tools/)
|
2091
2060
|
# </div>
|
2092
2061
|
#
|
2093
|
-
#
|
2094
|
-
#
|
2095
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html
|
2096
|
-
# [2]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-deployment.html
|
2097
|
-
# [3]: https://aws.amazon.com/tools/
|
2098
|
-
#
|
2099
2062
|
# @!attribute [rw] position
|
2100
2063
|
# @return [String]
|
2101
2064
|
#
|
@@ -2122,20 +2085,18 @@ module Aws::APIGateway
|
|
2122
2085
|
#
|
2123
2086
|
# The content map is a JSON string of API-specific key-value pairs.
|
2124
2087
|
# Although an API can use any shape for the content map, only the
|
2125
|
-
#
|
2126
|
-
# associated API entity definition in the exported
|
2088
|
+
# Swagger-compliant documentation fields will be injected into the
|
2089
|
+
# associated API entity definition in the exported Swagger definition
|
2127
2090
|
# file.
|
2128
2091
|
#
|
2129
2092
|
# </div>
|
2130
2093
|
#
|
2131
2094
|
# <div class="seeAlso">
|
2132
|
-
# [Documenting an
|
2095
|
+
# [Documenting an
|
2096
|
+
# API]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-documenting-api.html),
|
2097
|
+
# DocumentationParts
|
2133
2098
|
# </div>
|
2134
2099
|
#
|
2135
|
-
#
|
2136
|
-
#
|
2137
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
2138
|
-
#
|
2139
2100
|
# @!attribute [rw] id
|
2140
2101
|
# The DocumentationPart identifier, generated by API Gateway when the
|
2141
2102
|
# `DocumentationPart` is created.
|
@@ -2154,12 +2115,12 @@ module Aws::APIGateway
|
|
2154
2115
|
# A content map of API-specific key-value pairs describing the
|
2155
2116
|
# targeted API entity. The map must be encoded as a JSON string, e.g.,
|
2156
2117
|
# `"\{ "description": "The API does ..." \}"`. Only
|
2157
|
-
#
|
2118
|
+
# Swagger-compliant documentation-related fields from the
|
2158
2119
|
# <literal>properties</literal>
|
2159
2120
|
#
|
2160
2121
|
# map are exported and, hence, published as part of the API entity
|
2161
2122
|
# definitions, while the original documentation parts are exported in
|
2162
|
-
# a
|
2123
|
+
# a Swagger extension of `x-amazon-apigateway-documentation`.
|
2163
2124
|
# @return [String]
|
2164
2125
|
#
|
2165
2126
|
class DocumentationPart < Struct.new(
|
@@ -2173,19 +2134,16 @@ module Aws::APIGateway
|
|
2173
2134
|
#
|
2174
2135
|
# <div class="remarks">
|
2175
2136
|
# This is used to return the result when documentation parts in an
|
2176
|
-
# external (e.g.,
|
2137
|
+
# external (e.g., Swagger) file are imported into API Gateway
|
2177
2138
|
# </div>
|
2178
2139
|
#
|
2179
2140
|
# <div class="seeAlso">
|
2180
|
-
# [Documenting an
|
2141
|
+
# [Documenting an
|
2142
|
+
# API]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-documenting-api.html),
|
2143
|
+
# [documentationpart:import]([[AwsDocsUrlPrefix]]/apigateway/api-reference/link-relation/documentationpart-import/),
|
2181
2144
|
# DocumentationPart
|
2182
2145
|
# </div>
|
2183
2146
|
#
|
2184
|
-
#
|
2185
|
-
#
|
2186
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
2187
|
-
# [2]: https://docs.aws.amazon.com/apigateway/api-reference/link-relation/documentationpart-import/
|
2188
|
-
#
|
2189
2147
|
# @!attribute [rw] ids
|
2190
2148
|
# A list of the returned documentation part identifiers.
|
2191
2149
|
# @return [Array<String>]
|
@@ -2278,13 +2236,11 @@ module Aws::APIGateway
|
|
2278
2236
|
# <div class="remarks"></div>
|
2279
2237
|
#
|
2280
2238
|
# <div class="seeAlso">
|
2281
|
-
# [Documenting an
|
2239
|
+
# [Documenting an
|
2240
|
+
# API]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-documenting-api.html),
|
2241
|
+
# DocumentationPart
|
2282
2242
|
# </div>
|
2283
2243
|
#
|
2284
|
-
#
|
2285
|
-
#
|
2286
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
2287
|
-
#
|
2288
2244
|
# @!attribute [rw] position
|
2289
2245
|
# @return [String]
|
2290
2246
|
#
|
@@ -2303,18 +2259,16 @@ module Aws::APIGateway
|
|
2303
2259
|
# <div class="remarks" markdown="1">
|
2304
2260
|
# Publishing API documentation involves creating a documentation version
|
2305
2261
|
# associated with an API stage and exporting the versioned documentation
|
2306
|
-
# to an external (e.g.,
|
2262
|
+
# to an external (e.g., Swagger) file.
|
2307
2263
|
#
|
2308
2264
|
# </div>
|
2309
2265
|
#
|
2310
2266
|
# <div class="seeAlso">
|
2311
|
-
# [Documenting an
|
2267
|
+
# [Documenting an
|
2268
|
+
# API]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-documenting-api.html),
|
2269
|
+
# DocumentationPart, DocumentationVersions
|
2312
2270
|
# </div>
|
2313
2271
|
#
|
2314
|
-
#
|
2315
|
-
#
|
2316
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
2317
|
-
#
|
2318
2272
|
# @!attribute [rw] version
|
2319
2273
|
# The version identifier of the API documentation snapshot.
|
2320
2274
|
# @return [String]
|
@@ -2343,13 +2297,11 @@ module Aws::APIGateway
|
|
2343
2297
|
# </div>
|
2344
2298
|
#
|
2345
2299
|
# <div class="seeAlso">
|
2346
|
-
# [Documenting an
|
2300
|
+
# [Documenting an
|
2301
|
+
# API]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-documenting-api.html),
|
2302
|
+
# DocumentationPart, DocumentationVersion
|
2347
2303
|
# </div>
|
2348
2304
|
#
|
2349
|
-
#
|
2350
|
-
#
|
2351
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
2352
|
-
#
|
2353
2305
|
# @!attribute [rw] position
|
2354
2306
|
# @return [String]
|
2355
2307
|
#
|
@@ -2381,13 +2333,10 @@ module Aws::APIGateway
|
|
2381
2333
|
# </div>
|
2382
2334
|
#
|
2383
2335
|
# <div class="seeAlso">
|
2384
|
-
# [Set a Custom Host Name for an
|
2336
|
+
# [Set a Custom Host Name for an
|
2337
|
+
# API]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/how-to-custom-domains.html)
|
2385
2338
|
# </div>
|
2386
2339
|
#
|
2387
|
-
#
|
2388
|
-
#
|
2389
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html
|
2390
|
-
#
|
2391
2340
|
# @!attribute [rw] domain_name
|
2392
2341
|
# The custom domain name as an API host name, for example,
|
2393
2342
|
# `my-api.example.com`.
|
@@ -2420,12 +2369,9 @@ module Aws::APIGateway
|
|
2420
2369
|
# @!attribute [rw] regional_hosted_zone_id
|
2421
2370
|
# The region-specific Amazon Route 53 Hosted Zone ID of the regional
|
2422
2371
|
# endpoint. For more information, see [Set up a Regional Custom Domain
|
2423
|
-
# Name][
|
2424
|
-
#
|
2425
|
-
#
|
2426
|
-
#
|
2427
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html
|
2428
|
-
# [2]: https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region
|
2372
|
+
# Name]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)
|
2373
|
+
# and [AWS Regions and Endpoints for API
|
2374
|
+
# Gateway]([[AwsDocsUrlPrefix]]/general/latest/gr/rande.html#apigateway_region).
|
2429
2375
|
# @return [String]
|
2430
2376
|
#
|
2431
2377
|
# @!attribute [rw] regional_certificate_name
|
@@ -2445,23 +2391,17 @@ module Aws::APIGateway
|
|
2445
2391
|
# up this association when adding a DNS record pointing the custom
|
2446
2392
|
# domain name to this distribution name. For more information about
|
2447
2393
|
# CloudFront distributions, see the [Amazon CloudFront
|
2448
|
-
# documentation][
|
2449
|
-
#
|
2450
|
-
#
|
2451
|
-
#
|
2452
|
-
# [1]: https://aws.amazon.com/documentation/cloudfront/
|
2394
|
+
# documentation]([[AwsAmazonUrlPrefix]]/documentation/cloudfront/).
|
2453
2395
|
# @return [String]
|
2454
2396
|
#
|
2455
2397
|
# @!attribute [rw] distribution_hosted_zone_id
|
2456
2398
|
# The region-agnostic Amazon Route 53 Hosted Zone ID of the
|
2457
2399
|
# edge-optimized endpoint. The valid value is `Z2FDTNDATAQYW2` for all
|
2458
2400
|
# the regions. For more information, see [Set up a Regional Custom
|
2459
|
-
# Domain
|
2460
|
-
#
|
2461
|
-
#
|
2462
|
-
#
|
2463
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html
|
2464
|
-
# [2]: https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region
|
2401
|
+
# Domain
|
2402
|
+
# Name]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)
|
2403
|
+
# and [AWS Regions and Endpoints for API
|
2404
|
+
# Gateway]([[AwsDocsUrlPrefix]]/general/latest/gr/rande.html#apigateway_region).
|
2465
2405
|
# @return [String]
|
2466
2406
|
#
|
2467
2407
|
# @!attribute [rw] endpoint_configuration
|
@@ -2487,13 +2427,10 @@ module Aws::APIGateway
|
|
2487
2427
|
# Represents a collection of DomainName resources.
|
2488
2428
|
#
|
2489
2429
|
# <div class="seeAlso">
|
2490
|
-
# [Use Client-Side
|
2430
|
+
# [Use Client-Side
|
2431
|
+
# Certificate]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/how-to-custom-domains.html)
|
2491
2432
|
# </div>
|
2492
2433
|
#
|
2493
|
-
#
|
2494
|
-
#
|
2495
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html
|
2496
|
-
#
|
2497
2434
|
# @!attribute [rw] position
|
2498
2435
|
# @return [String]
|
2499
2436
|
#
|
@@ -2606,7 +2543,8 @@ module Aws::APIGateway
|
|
2606
2543
|
#
|
2607
2544
|
# <div class="remarks">
|
2608
2545
|
# For more information about valid gateway response types, see [Gateway
|
2609
|
-
# Response Types Supported by API
|
2546
|
+
# Response Types Supported by API
|
2547
|
+
# Gateway]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/supported-gateway-response-types.html)
|
2610
2548
|
# <div class="example" markdown="1">
|
2611
2549
|
# #### Example: Get a Gateway Response of a given response type
|
2612
2550
|
#
|
@@ -2632,14 +2570,10 @@ module Aws::APIGateway
|
|
2632
2570
|
# </div>
|
2633
2571
|
#
|
2634
2572
|
# <div class="seeAlso">
|
2635
|
-
# [Customize Gateway
|
2573
|
+
# [Customize Gateway
|
2574
|
+
# Responses]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/customize-gateway-responses.html)
|
2636
2575
|
# </div>
|
2637
2576
|
#
|
2638
|
-
#
|
2639
|
-
#
|
2640
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html
|
2641
|
-
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html
|
2642
|
-
#
|
2643
2577
|
# @!attribute [rw] response_type
|
2644
2578
|
# The response type of the associated GatewayResponse. Valid values
|
2645
2579
|
# are * ACCESS\_DENIED
|
@@ -2700,7 +2634,8 @@ module Aws::APIGateway
|
|
2700
2634
|
#
|
2701
2635
|
# <div class="remarks">
|
2702
2636
|
# For more information about valid gateway response types, see [Gateway
|
2703
|
-
# Response Types Supported by API
|
2637
|
+
# Response Types Supported by API
|
2638
|
+
# Gateway]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/supported-gateway-response-types.html)
|
2704
2639
|
# <div class="example" markdown="1">
|
2705
2640
|
# #### Example: Get the collection of gateway responses of an API
|
2706
2641
|
#
|
@@ -2726,14 +2661,10 @@ module Aws::APIGateway
|
|
2726
2661
|
# </div>
|
2727
2662
|
#
|
2728
2663
|
# <div class="seeAlso">
|
2729
|
-
# [Customize Gateway
|
2664
|
+
# [Customize Gateway
|
2665
|
+
# Responses]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/customize-gateway-responses.html)
|
2730
2666
|
# </div>
|
2731
2667
|
#
|
2732
|
-
#
|
2733
|
-
#
|
2734
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html
|
2735
|
-
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html
|
2736
|
-
#
|
2737
2668
|
# @!attribute [rw] position
|
2738
2669
|
# @return [String]
|
2739
2670
|
#
|
@@ -3283,15 +3214,15 @@ module Aws::APIGateway
|
|
3283
3214
|
# @return [String]
|
3284
3215
|
#
|
3285
3216
|
# @!attribute [rw] export_type
|
3286
|
-
# \[Required\] The type of export.
|
3287
|
-
#
|
3217
|
+
# \[Required\] The type of export. Currently only 'swagger' is
|
3218
|
+
# supported.
|
3288
3219
|
# @return [String]
|
3289
3220
|
#
|
3290
3221
|
# @!attribute [rw] parameters
|
3291
3222
|
# A key-value map of query string parameters that specify properties
|
3292
3223
|
# of the export, depending on the requested `exportType`. For
|
3293
|
-
# `exportType` `
|
3294
|
-
#
|
3224
|
+
# `exportType` `swagger`, any combination of the following parameters
|
3225
|
+
# are supported: `extensions='integrations'` or
|
3295
3226
|
# `extensions='apigateway'` will export the API with
|
3296
3227
|
# x-amazon-apigateway-integration extensions.
|
3297
3228
|
# `extensions='authorizers'` will export the API with
|
@@ -3302,8 +3233,8 @@ module Aws::APIGateway
|
|
3302
3233
|
# @!attribute [rw] accepts
|
3303
3234
|
# The content-type of the export, for example `application/json`.
|
3304
3235
|
# Currently `application/json` and `application/yaml` are supported
|
3305
|
-
# for `exportType` of
|
3306
|
-
#
|
3236
|
+
# for `exportType` of `swagger`. This should be specified in the
|
3237
|
+
# `Accept` header for direct API requests.
|
3307
3238
|
# @return [String]
|
3308
3239
|
#
|
3309
3240
|
class GetExportRequest < Struct.new(
|
@@ -4203,11 +4134,8 @@ module Aws::APIGateway
|
|
4203
4134
|
#
|
4204
4135
|
# @!attribute [rw] body
|
4205
4136
|
# The payload of the POST request to import API keys. For the payload
|
4206
|
-
# format, see [API Key File
|
4207
|
-
#
|
4208
|
-
#
|
4209
|
-
#
|
4210
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-file-format.html
|
4137
|
+
# format, see [API Key File
|
4138
|
+
# Format]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-key-file-format.html).
|
4211
4139
|
# @return [String]
|
4212
4140
|
#
|
4213
4141
|
# @!attribute [rw] format
|
@@ -4227,7 +4155,7 @@ module Aws::APIGateway
|
|
4227
4155
|
include Aws::Structure
|
4228
4156
|
end
|
4229
4157
|
|
4230
|
-
# Import documentation parts from an external (e.g.,
|
4158
|
+
# Import documentation parts from an external (e.g., Swagger) definition
|
4231
4159
|
# file.
|
4232
4160
|
#
|
4233
4161
|
# @note When making an API call, you may pass ImportDocumentationPartsRequest
|
@@ -4258,7 +4186,7 @@ module Aws::APIGateway
|
|
4258
4186
|
#
|
4259
4187
|
# @!attribute [rw] body
|
4260
4188
|
# \[Required\] Raw byte array representing the to-be-imported
|
4261
|
-
# documentation parts. To import from
|
4189
|
+
# documentation parts. To import from a Swagger file, this is a JSON
|
4262
4190
|
# object.
|
4263
4191
|
# @return [String]
|
4264
4192
|
#
|
@@ -4321,7 +4249,7 @@ module Aws::APIGateway
|
|
4321
4249
|
#
|
4322
4250
|
# @!attribute [rw] body
|
4323
4251
|
# \[Required\] The POST request body containing external API
|
4324
|
-
# definitions. Currently, only
|
4252
|
+
# definitions. Currently, only Swagger definition JSON files are
|
4325
4253
|
# supported. The maximum size of the API definition file is 2MB.
|
4326
4254
|
# @return [String]
|
4327
4255
|
#
|
@@ -4340,13 +4268,10 @@ module Aws::APIGateway
|
|
4340
4268
|
# </div>
|
4341
4269
|
#
|
4342
4270
|
# <div class="seeAlso">
|
4343
|
-
# [Creating an
|
4271
|
+
# [Creating an
|
4272
|
+
# API]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/how-to-create-api.html)
|
4344
4273
|
# </div>
|
4345
4274
|
#
|
4346
|
-
#
|
4347
|
-
#
|
4348
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
4349
|
-
#
|
4350
4275
|
# @!attribute [rw] type
|
4351
4276
|
# Specifies an API method integration type. The valid value is one of
|
4352
4277
|
# the following:
|
@@ -4388,10 +4313,10 @@ module Aws::APIGateway
|
|
4388
4313
|
#
|
4389
4314
|
# * For `HTTP` or `HTTP_PROXY` integrations, the URI must be a fully
|
4390
4315
|
# formed, encoded HTTP(S) URL according to the [RFC-3986
|
4391
|
-
# specification][
|
4392
|
-
# `connectionType` is not `VPC_LINK`, or private
|
4393
|
-
# `connectionType` is `VPC_LINK`. For a private
|
4394
|
-
# the URI is not used for routing.
|
4316
|
+
# specification]([[UriEntryWikipediaUrl]]), for either standard
|
4317
|
+
# integration, where `connectionType` is not `VPC_LINK`, or private
|
4318
|
+
# integration, where `connectionType` is `VPC_LINK`. For a private
|
4319
|
+
# HTTP integration, the URI is not used for routing.
|
4395
4320
|
#
|
4396
4321
|
# * For `AWS` or `AWS_PROXY` integrations, the URI is of the form
|
4397
4322
|
# `arn:aws:apigateway:\{region\}:\{subdomain.service|service\}:path|action/\{service_api\}`.
|
@@ -4410,10 +4335,6 @@ module Aws::APIGateway
|
|
4410
4335
|
# either
|
4411
4336
|
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket=\{bucket\}&Key=\{key\}`
|
4412
4337
|
# or `arn:aws:apigateway:us-west-2:s3:path/\{bucket\}/\{key\}`
|
4413
|
-
#
|
4414
|
-
#
|
4415
|
-
#
|
4416
|
-
# [1]: https://en.wikipedia.org/wiki/Uniform_Resource_Identifier
|
4417
4338
|
# @return [String]
|
4418
4339
|
#
|
4419
4340
|
# @!attribute [rw] connection_type
|
@@ -4425,12 +4346,10 @@ module Aws::APIGateway
|
|
4425
4346
|
# @return [String]
|
4426
4347
|
#
|
4427
4348
|
# @!attribute [rw] connection_id
|
4428
|
-
# The
|
4349
|
+
# The
|
4350
|
+
# ([`id`]([[AwsDocsUrlPrefix]]/apigateway/api-reference/resource/vpc-link/#id))
|
4351
|
+
# of the VpcLink used for the integration when
|
4429
4352
|
# `connectionType=VPC_LINK` and undefined, otherwise.
|
4430
|
-
#
|
4431
|
-
#
|
4432
|
-
#
|
4433
|
-
# [1]: https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id
|
4434
4353
|
# @return [String]
|
4435
4354
|
#
|
4436
4355
|
# @!attribute [rw] credentials
|
@@ -4539,19 +4458,16 @@ module Aws::APIGateway
|
|
4539
4458
|
# The successful response returns `200 OK` status and a payload as
|
4540
4459
|
# follows:
|
4541
4460
|
#
|
4542
|
-
# \{ "_links": \{ "curies": \{ "href": "
|
4461
|
+
# \{ "_links": \{ "curies": \{ "href": "[[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/restapi-integration-response-\{rel\}.html", "name": "integrationresponse", "templated": true \}, "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" \}, "integrationresponse:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" \}, "integrationresponse:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" \} \}, "responseParameters": \{ "method.response.header.Content-Type": "'application/xml'" \}, "responseTemplates": \{ "application/json": "$util.urlDecode("%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E")\n" \}, "statusCode": "200" \}
|
4543
4462
|
#
|
4544
4463
|
#
|
4545
4464
|
#
|
4546
4465
|
# </div>
|
4547
4466
|
#
|
4548
4467
|
# <div class="seeAlso">
|
4549
|
-
# [Creating an
|
4468
|
+
# [Creating an
|
4469
|
+
# API]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/how-to-create-api.html)
|
4550
4470
|
# </div>
|
4551
|
-
#
|
4552
|
-
#
|
4553
|
-
#
|
4554
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
4555
4471
|
# @return [Hash<String,Types::IntegrationResponse>]
|
4556
4472
|
#
|
4557
4473
|
class Integration < Struct.new(
|
@@ -4577,13 +4493,10 @@ module Aws::APIGateway
|
|
4577
4493
|
# transform the back-end response.
|
4578
4494
|
#
|
4579
4495
|
# <div class="seeAlso">
|
4580
|
-
# [Creating an
|
4496
|
+
# [Creating an
|
4497
|
+
# API]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/how-to-create-api.html)
|
4581
4498
|
# </div>
|
4582
4499
|
#
|
4583
|
-
#
|
4584
|
-
#
|
4585
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
4586
|
-
#
|
4587
4500
|
# @!attribute [rw] status_code
|
4588
4501
|
# Specifies the status code that is used to map the integration
|
4589
4502
|
# response to an existing MethodResponse.
|
@@ -4676,27 +4589,24 @@ module Aws::APIGateway
|
|
4676
4589
|
# The successful response returns a `200 OK` status code and a payload
|
4677
4590
|
# similar to the following:
|
4678
4591
|
#
|
4679
|
-
# \{ "_links": \{ "curies": [ \{ "href": "
|
4592
|
+
# \{ "_links": \{ "curies": [ \{ "href": "[[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/restapi-integration-\{rel\}.html", "name": "integration", "templated": true \}, \{ "href": "[[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/restapi-integration-response-\{rel\}.html", "name": "integrationresponse", "templated": true \}, \{ "href": "[[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/restapi-method-\{rel\}.html", "name": "method", "templated": true \}, \{ "href": "[[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/restapi-method-response-\{rel\}.html", "name": "methodresponse", "templated": true \} ], "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" \}, "integration:put": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "method:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" \}, "method:integration": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "method:responses": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" \}, "method:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" \}, "methodresponse:put": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/\{status_code\}", "templated": true \} \}, "apiKeyRequired": true, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": \{ "method:integration": \{ "_links": \{ "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "integration:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "integration:responses": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" \}, "integration:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "integrationresponse:put": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/\{status_code\}", "templated": true \} \}, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": \{ "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" \}, "requestTemplates": \{ "application/json": "\{\n\}" \}, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": \{ "integration:responses": \{ "_links": \{ "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" \}, "integrationresponse:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" \}, "integrationresponse:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" \} \}, "responseParameters": \{ "method.response.header.Content-Type": "'application/xml'" \}, "responseTemplates": \{ "application/json": "$util.urlDecode("%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E")" \}, "statusCode": "200" \} \} \}, "method:responses": \{ "_links": \{ "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" \}, "methodresponse:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" \}, "methodresponse:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" \} \}, "responseModels": \{ "application/json": "Empty" \}, "responseParameters": \{ "method.response.header.Content-Type": false \}, "statusCode": "200" \} \} \}
|
4680
4593
|
#
|
4681
4594
|
# In the example above, the response template for the `200 OK` response
|
4682
4595
|
# maps the JSON output from the `ListStreams` action in the back end to
|
4683
4596
|
# an XML output. The mapping template is URL-encoded as
|
4684
4597
|
# `%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E`
|
4685
|
-
# and the output is decoded using the
|
4686
|
-
#
|
4598
|
+
# and the output is decoded using the
|
4599
|
+
# [$util.urlDecode()]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#util-templat-reference)
|
4600
|
+
# helper function.
|
4687
4601
|
#
|
4688
4602
|
# </div>
|
4689
4603
|
#
|
4690
4604
|
# <div class="seeAlso">
|
4691
4605
|
# MethodResponse, Integration, IntegrationResponse, Resource, [Set up an
|
4692
|
-
# API's
|
4606
|
+
# API's
|
4607
|
+
# method]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/how-to-method-settings.html)
|
4693
4608
|
# </div>
|
4694
4609
|
#
|
4695
|
-
#
|
4696
|
-
#
|
4697
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#util-templat-reference
|
4698
|
-
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-method-settings.html
|
4699
|
-
#
|
4700
4610
|
# @!attribute [rw] http_method
|
4701
4611
|
# The method's HTTP verb.
|
4702
4612
|
# @return [String]
|
@@ -4725,11 +4635,7 @@ module Aws::APIGateway
|
|
4725
4635
|
# @!attribute [rw] operation_name
|
4726
4636
|
# A human-friendly operation identifier for the method. For example,
|
4727
4637
|
# you can assign the `operationName` of `ListPets` for the `GET /pets`
|
4728
|
-
# method in [PetStore][
|
4729
|
-
#
|
4730
|
-
#
|
4731
|
-
#
|
4732
|
-
# [1]: https://petstore-demo-endpoint.execute-api.com/petstore/pets
|
4638
|
+
# method in [PetStore]([[PetstoreDemoUrl]]) example.
|
4733
4639
|
# @return [String]
|
4734
4640
|
#
|
4735
4641
|
# @!attribute [rw] request_parameters
|
@@ -4773,19 +4679,16 @@ module Aws::APIGateway
|
|
4773
4679
|
# The successful response returns a `200 OK` status code and a payload
|
4774
4680
|
# similar to the following:
|
4775
4681
|
#
|
4776
|
-
# \{ "_links": \{ "curies": \{ "href": "
|
4682
|
+
# \{ "_links": \{ "curies": \{ "href": "[[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/restapi-method-response-\{rel\}.html", "name": "methodresponse", "templated": true \}, "self": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" \}, "methodresponse:delete": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" \}, "methodresponse:update": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" \} \}, "responseModels": \{ "application/json": "Empty" \}, "responseParameters": \{ "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false \}, "statusCode": "200" \}
|
4777
4683
|
#
|
4778
4684
|
#
|
4779
4685
|
#
|
4780
4686
|
# </div>
|
4781
4687
|
#
|
4782
4688
|
# <div class="seeAlso">
|
4783
|
-
# [AWS
|
4689
|
+
# [AWS
|
4690
|
+
# CLI]([[AwsDocsUrlPrefix]]/cli/latest/reference/apigateway/get-method-response.html)
|
4784
4691
|
# </div>
|
4785
|
-
#
|
4786
|
-
#
|
4787
|
-
#
|
4788
|
-
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-method-response.html
|
4789
4692
|
# @return [Hash<String,Types::MethodResponse>]
|
4790
4693
|
#
|
4791
4694
|
# @!attribute [rw] method_integration
|
@@ -4809,19 +4712,16 @@ module Aws::APIGateway
|
|
4809
4712
|
# The successful response returns a `200 OK` status code and a payload
|
4810
4713
|
# similar to the following:
|
4811
4714
|
#
|
4812
|
-
# \{ "_links": \{ "curies": [ \{ "href": "
|
4715
|
+
# \{ "_links": \{ "curies": [ \{ "href": "[[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/restapi-integration-\{rel\}.html", "name": "integration", "templated": true \}, \{ "href": "[[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/restapi-integration-response-\{rel\}.html", "name": "integrationresponse", "templated": true \} ], "self": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" \}, "integration:delete": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" \}, "integration:responses": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" \}, "integration:update": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" \}, "integrationresponse:put": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/\{status_code\}", "templated": true \} \}, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": \{ "application/json": "\{\n "a": "$input.params('operand1')",\n "b": "$input.params('operand2')", \n "op": "$input.params('operator')" \n\}" \}, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": \{ "integration:responses": \{ "_links": \{ "self": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" \}, "integrationresponse:delete": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" \}, "integrationresponse:update": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" \} \}, "responseParameters": \{ "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" \}, "responseTemplates": \{ "application/json": "#set($res = $input.path('$'))\n\{\n "result": "$res.a, $res.b, $res.op => $res.c",\n "a" : "$res.a",\n "b" : "$res.b",\n "op" : "$res.op",\n "c" : "$res.c"\n\}" \}, "selectionPattern": "", "statusCode": "200" \} \} \}
|
4813
4716
|
#
|
4814
4717
|
#
|
4815
4718
|
#
|
4816
4719
|
# </div>
|
4817
4720
|
#
|
4818
4721
|
# <div class="seeAlso">
|
4819
|
-
# [AWS
|
4722
|
+
# [AWS
|
4723
|
+
# CLI]([[AwsDocsUrlPrefix]]/cli/latest/reference/apigateway/get-integration.html)
|
4820
4724
|
# </div>
|
4821
|
-
#
|
4822
|
-
#
|
4823
|
-
#
|
4824
|
-
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-integration.html
|
4825
4725
|
# @return [Types::Integration]
|
4826
4726
|
#
|
4827
4727
|
# @!attribute [rw] authorization_scopes
|
@@ -4873,20 +4773,17 @@ module Aws::APIGateway
|
|
4873
4773
|
# The successful response returns `200 OK` status and a payload as
|
4874
4774
|
# follows:
|
4875
4775
|
#
|
4876
|
-
# \{ "_links": \{ "curies": \{ "href": "
|
4776
|
+
# \{ "_links": \{ "curies": \{ "href": "[[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/restapi-method-response-\{rel\}.html", "name": "methodresponse", "templated": true \}, "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "title": "200" \}, "methodresponse:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" \}, "methodresponse:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" \} \}, "responseModels": \{ "application/json": "Empty" \}, "responseParameters": \{ "method.response.header.Content-Type": false \}, "statusCode": "200" \}
|
4877
4777
|
#
|
4878
4778
|
#
|
4879
4779
|
#
|
4880
4780
|
# </div>
|
4881
4781
|
#
|
4882
4782
|
# <div class="seeAlso">
|
4883
|
-
# Method, IntegrationResponse, Integration [Creating an
|
4783
|
+
# Method, IntegrationResponse, Integration [Creating an
|
4784
|
+
# API]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/how-to-create-api.html)
|
4884
4785
|
# </div>
|
4885
4786
|
#
|
4886
|
-
#
|
4887
|
-
#
|
4888
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
4889
|
-
#
|
4890
4787
|
# @!attribute [rw] status_code
|
4891
4788
|
# The method response's status code.
|
4892
4789
|
# @return [String]
|
@@ -5046,13 +4943,10 @@ module Aws::APIGateway
|
|
5046
4943
|
# </div>
|
5047
4944
|
#
|
5048
4945
|
# <div class="seeAlso">
|
5049
|
-
# Method, MethodResponse, [Models and
|
4946
|
+
# Method, MethodResponse, [Models and
|
4947
|
+
# Mappings]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/models-mappings.html)
|
5050
4948
|
# </div>
|
5051
4949
|
#
|
5052
|
-
#
|
5053
|
-
#
|
5054
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html
|
5055
|
-
#
|
5056
4950
|
# @!attribute [rw] id
|
5057
4951
|
# The identifier for the model resource.
|
5058
4952
|
# @return [String]
|
@@ -5067,15 +4961,12 @@ module Aws::APIGateway
|
|
5067
4961
|
#
|
5068
4962
|
# @!attribute [rw] schema
|
5069
4963
|
# The schema for the model. For `application/json` models, this should
|
5070
|
-
# be [JSON schema draft 4][
|
5071
|
-
# characters in the description of any properties because
|
5072
|
-
# "\\*/" characters may be interpreted as the closing marker
|
5073
|
-
# comments in some languages, such as Java or JavaScript, causing
|
5074
|
-
# installation of your API's SDK generated by API Gateway to
|
5075
|
-
#
|
5076
|
-
#
|
5077
|
-
#
|
5078
|
-
# [1]: https://tools.ietf.org/html/draft-zyp-json-schema-04
|
4964
|
+
# be [JSON schema draft 4]([[JsonSchemaUrl]]) model. Do not include
|
4965
|
+
# "\\*/" characters in the description of any properties because
|
4966
|
+
# such "\\*/" characters may be interpreted as the closing marker
|
4967
|
+
# for comments in some languages, such as Java or JavaScript, causing
|
4968
|
+
# the installation of your API's SDK generated by API Gateway to
|
4969
|
+
# fail.
|
5079
4970
|
# @return [String]
|
5080
4971
|
#
|
5081
4972
|
# @!attribute [rw] content_type
|
@@ -5094,13 +4985,10 @@ module Aws::APIGateway
|
|
5094
4985
|
# Represents a collection of Model resources.
|
5095
4986
|
#
|
5096
4987
|
# <div class="seeAlso">
|
5097
|
-
# Method, MethodResponse, [Models and
|
4988
|
+
# Method, MethodResponse, [Models and
|
4989
|
+
# Mappings]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/models-mappings.html)
|
5098
4990
|
# </div>
|
5099
4991
|
#
|
5100
|
-
#
|
5101
|
-
#
|
5102
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html
|
5103
|
-
#
|
5104
4992
|
# @!attribute [rw] position
|
5105
4993
|
# @return [String]
|
5106
4994
|
#
|
@@ -5138,20 +5026,16 @@ module Aws::APIGateway
|
|
5138
5026
|
# @return [String]
|
5139
5027
|
#
|
5140
5028
|
# @!attribute [rw] path
|
5141
|
-
# The `op` operation's target, as identified by a [JSON
|
5142
|
-
# value that references a location
|
5143
|
-
# example, if the target resource
|
5144
|
-
# `\{"name":"value"\}`, the path for
|
5145
|
-
# `name` property value is a JSON
|
5146
|
-
# \{"child/name": "child-value"\}\}`), the
|
5147
|
-
# property will be `/name/child~1name`. Any
|
5148
|
-
# appearing in path names must be escaped with
|
5149
|
-
# example above. Each `op` operation can have
|
5150
|
-
# associated with it.
|
5151
|
-
#
|
5152
|
-
#
|
5153
|
-
#
|
5154
|
-
# [1]: https://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-08
|
5029
|
+
# The `op` operation's target, as identified by a [JSON
|
5030
|
+
# Pointer]([[JsonPointerRefUrl]]) value that references a location
|
5031
|
+
# within the targeted resource. For example, if the target resource
|
5032
|
+
# has an updateable property of `\{"name":"value"\}`, the path for
|
5033
|
+
# this property is `/name`. If the `name` property value is a JSON
|
5034
|
+
# object (e.g., `\{"name": \{"child/name": "child-value"\}\}`), the
|
5035
|
+
# path for the `child/name` property will be `/name/child~1name`. Any
|
5036
|
+
# slash ("/") character appearing in path names must be escaped with
|
5037
|
+
# "~1", as shown in the example above. Each `op` operation can have
|
5038
|
+
# only one `path` associated with it.
|
5155
5039
|
# @return [String]
|
5156
5040
|
#
|
5157
5041
|
# @!attribute [rw] value
|
@@ -5159,11 +5043,8 @@ module Aws::APIGateway
|
|
5159
5043
|
# the `add` or `replace` operation. When using AWS CLI to update a
|
5160
5044
|
# property of a JSON value, enclose the JSON object with a pair of
|
5161
5045
|
# single quotes in a Linux shell, e.g., '\\\{"a": ...\\}'. In a
|
5162
|
-
# Windows shell, see [Using JSON for
|
5163
|
-
#
|
5164
|
-
#
|
5165
|
-
#
|
5166
|
-
# [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json
|
5046
|
+
# Windows shell, see [Using JSON for
|
5047
|
+
# Parameters]([[AwsDocsUrlPrefix]]/cli/latest/userguide/cli-using-param.html#cli-using-param-json).
|
5167
5048
|
# @return [String]
|
5168
5049
|
#
|
5169
5050
|
# @!attribute [rw] from
|
@@ -5309,10 +5190,10 @@ module Aws::APIGateway
|
|
5309
5190
|
#
|
5310
5191
|
# * For `HTTP` or `HTTP_PROXY` integrations, the URI must be a fully
|
5311
5192
|
# formed, encoded HTTP(S) URL according to the [RFC-3986
|
5312
|
-
# specification][
|
5313
|
-
# `connectionType` is not `VPC_LINK`, or private
|
5314
|
-
# `connectionType` is `VPC_LINK`. For a private
|
5315
|
-
# the URI is not used for routing.
|
5193
|
+
# specification]([[UriEntryWikipediaUrl]]), for either standard
|
5194
|
+
# integration, where `connectionType` is not `VPC_LINK`, or private
|
5195
|
+
# integration, where `connectionType` is `VPC_LINK`. For a private
|
5196
|
+
# HTTP integration, the URI is not used for routing.
|
5316
5197
|
#
|
5317
5198
|
# * For `AWS` or `AWS_PROXY` integrations, the URI is of the form
|
5318
5199
|
# `arn:aws:apigateway:\{region\}:\{subdomain.service|service\}:path|action/\{service_api\}`.
|
@@ -5331,10 +5212,6 @@ module Aws::APIGateway
|
|
5331
5212
|
# either
|
5332
5213
|
# `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket=\{bucket\}&Key=\{key\}`
|
5333
5214
|
# or `arn:aws:apigateway:us-west-2:s3:path/\{bucket\}/\{key\}`
|
5334
|
-
#
|
5335
|
-
#
|
5336
|
-
#
|
5337
|
-
# [1]: https://en.wikipedia.org/wiki/Uniform_Resource_Identifier
|
5338
5215
|
# @return [String]
|
5339
5216
|
#
|
5340
5217
|
# @!attribute [rw] connection_type
|
@@ -5346,12 +5223,10 @@ module Aws::APIGateway
|
|
5346
5223
|
# @return [String]
|
5347
5224
|
#
|
5348
5225
|
# @!attribute [rw] connection_id
|
5349
|
-
# The
|
5226
|
+
# The
|
5227
|
+
# ([`id`]([[AwsDocsUrlPrefix]]/apigateway/api-reference/resource/vpc-link/#id))
|
5228
|
+
# of the VpcLink used for the integration when
|
5350
5229
|
# `connectionType=VPC_LINK` and undefined, otherwise.
|
5351
|
-
#
|
5352
|
-
#
|
5353
|
-
#
|
5354
|
-
# [1]: https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id
|
5355
5230
|
# @return [String]
|
5356
5231
|
#
|
5357
5232
|
# @!attribute [rw] credentials
|
@@ -5592,11 +5467,7 @@ module Aws::APIGateway
|
|
5592
5467
|
# @!attribute [rw] operation_name
|
5593
5468
|
# A human-friendly operation identifier for the method. For example,
|
5594
5469
|
# you can assign the `operationName` of `ListPets` for the `GET /pets`
|
5595
|
-
# method in [PetStore][
|
5596
|
-
#
|
5597
|
-
#
|
5598
|
-
#
|
5599
|
-
# [1]: https://petstore-demo-endpoint.execute-api.com/petstore/pets
|
5470
|
+
# method in [PetStore]([[PetstoreDemoUrl]]) example.
|
5600
5471
|
# @return [String]
|
5601
5472
|
#
|
5602
5473
|
# @!attribute [rw] request_parameters
|
@@ -5761,7 +5632,7 @@ module Aws::APIGateway
|
|
5761
5632
|
#
|
5762
5633
|
# @!attribute [rw] body
|
5763
5634
|
# \[Required\] The PUT request body containing external API
|
5764
|
-
# definitions. Currently, only
|
5635
|
+
# definitions. Currently, only Swagger definition JSON files are
|
5765
5636
|
# supported. The maximum size of the API definition file is 2MB.
|
5766
5637
|
# @return [String]
|
5767
5638
|
#
|
@@ -5810,23 +5681,19 @@ module Aws::APIGateway
|
|
5810
5681
|
# A set of validation rules for incoming Method requests.
|
5811
5682
|
#
|
5812
5683
|
# <div class="remarks" markdown="1">
|
5813
|
-
# In
|
5814
|
-
# [x-amazon-apigateway-request-validators.requestValidator][
|
5815
|
-
# It the referenced using the
|
5684
|
+
# In Swagger, a RequestValidator of an API is defined by the
|
5685
|
+
# [x-amazon-apigateway-request-validators.requestValidator]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.requestValidator.html)
|
5686
|
+
# object. It the referenced using the
|
5687
|
+
# [x-amazon-apigateway-request-validator]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validator)
|
5816
5688
|
# property.
|
5817
5689
|
#
|
5818
5690
|
# </div>
|
5819
5691
|
#
|
5820
5692
|
# <div class="seeAlso">
|
5821
|
-
# [Enable Basic Request Validation in API
|
5693
|
+
# [Enable Basic Request Validation in API
|
5694
|
+
# Gateway]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-method-request-validation.html)
|
5822
5695
|
# </div>
|
5823
5696
|
#
|
5824
|
-
#
|
5825
|
-
#
|
5826
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.requestValidator.html
|
5827
|
-
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validator
|
5828
|
-
# [3]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html
|
5829
|
-
#
|
5830
5697
|
# @!attribute [rw] id
|
5831
5698
|
# The identifier of this RequestValidator.
|
5832
5699
|
# @return [String]
|
@@ -5856,20 +5723,17 @@ module Aws::APIGateway
|
|
5856
5723
|
# A collection of RequestValidator resources of a given RestApi.
|
5857
5724
|
#
|
5858
5725
|
# <div class="remarks" markdown="1">
|
5859
|
-
# In
|
5860
|
-
# [x-amazon-apigateway-request-validators][
|
5726
|
+
# In Swagger, the RequestValidators of an API is defined by the
|
5727
|
+
# [x-amazon-apigateway-request-validators]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.html)
|
5728
|
+
# extension.
|
5861
5729
|
#
|
5862
5730
|
# </div>
|
5863
5731
|
#
|
5864
5732
|
# <div class="seeAlso">
|
5865
|
-
# [Enable Basic Request Validation in API
|
5733
|
+
# [Enable Basic Request Validation in API
|
5734
|
+
# Gateway]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-method-request-validation.html)
|
5866
5735
|
# </div>
|
5867
5736
|
#
|
5868
|
-
#
|
5869
|
-
#
|
5870
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.html
|
5871
|
-
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html
|
5872
|
-
#
|
5873
5737
|
# @!attribute [rw] position
|
5874
5738
|
# @return [String]
|
5875
5739
|
#
|
@@ -5886,13 +5750,10 @@ module Aws::APIGateway
|
|
5886
5750
|
# Represents an API resource.
|
5887
5751
|
#
|
5888
5752
|
# <div class="seeAlso">
|
5889
|
-
# [Create an
|
5753
|
+
# [Create an
|
5754
|
+
# API]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/how-to-create-api.html)
|
5890
5755
|
# </div>
|
5891
5756
|
#
|
5892
|
-
#
|
5893
|
-
#
|
5894
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
5895
|
-
#
|
5896
5757
|
# @!attribute [rw] id
|
5897
5758
|
# The resource's identifier.
|
5898
5759
|
# @return [String]
|
@@ -5928,7 +5789,7 @@ module Aws::APIGateway
|
|
5928
5789
|
#
|
5929
5790
|
# ##### Response
|
5930
5791
|
#
|
5931
|
-
# \{ "_links": \{ "curies": [ \{ "href": "
|
5792
|
+
# \{ "_links": \{ "curies": [ \{ "href": "[[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/restapi-integration-\{rel\}.html", "name": "integration", "templated": true \}, \{ "href": "[[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/restapi-integration-response-\{rel\}.html", "name": "integrationresponse", "templated": true \}, \{ "href": "[[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/restapi-method-\{rel\}.html", "name": "method", "templated": true \}, \{ "href": "[[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/restapi-method-response-\{rel\}.html", "name": "methodresponse", "templated": true \} ], "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" \}, "integration:put": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "method:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" \}, "method:integration": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "method:responses": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" \}, "method:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" \}, "methodresponse:put": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/\{status_code\}", "templated": true \} \}, "apiKeyRequired": false, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": \{ "method:integration": \{ "_links": \{ "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "integration:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "integration:responses": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" \}, "integration:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "integrationresponse:put": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/\{status_code\}", "templated": true \} \}, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": \{ "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" \}, "requestTemplates": \{ "application/json": "\{\n\}" \}, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": \{ "integration:responses": \{ "_links": \{ "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" \}, "integrationresponse:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" \}, "integrationresponse:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" \} \}, "responseParameters": \{ "method.response.header.Content-Type": "'application/xml'" \}, "responseTemplates": \{ "application/json": "$util.urlDecode("%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E")\n" \}, "statusCode": "200" \} \} \}, "method:responses": \{ "_links": \{ "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" \}, "methodresponse:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" \}, "methodresponse:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" \} \}, "responseModels": \{ "application/json": "Empty" \}, "responseParameters": \{ "method.response.header.Content-Type": false \}, "statusCode": "200" \} \} \}
|
5932
5793
|
#
|
5933
5794
|
# If the `OPTIONS` is enabled on the resource, you can follow the
|
5934
5795
|
# example here to get that method. Just replace the `GET` of the last
|
@@ -5951,13 +5812,10 @@ module Aws::APIGateway
|
|
5951
5812
|
# Represents a collection of Resource resources.
|
5952
5813
|
#
|
5953
5814
|
# <div class="seeAlso">
|
5954
|
-
# [Create an
|
5815
|
+
# [Create an
|
5816
|
+
# API]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/how-to-create-api.html)
|
5955
5817
|
# </div>
|
5956
5818
|
#
|
5957
|
-
#
|
5958
|
-
#
|
5959
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
5960
|
-
#
|
5961
5819
|
# @!attribute [rw] position
|
5962
5820
|
# @return [String]
|
5963
5821
|
#
|
@@ -5974,13 +5832,10 @@ module Aws::APIGateway
|
|
5974
5832
|
# Represents a REST API.
|
5975
5833
|
#
|
5976
5834
|
# <div class="seeAlso">
|
5977
|
-
# [Create an
|
5835
|
+
# [Create an
|
5836
|
+
# API]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/how-to-create-api.html)
|
5978
5837
|
# </div>
|
5979
5838
|
#
|
5980
|
-
#
|
5981
|
-
#
|
5982
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
5983
|
-
#
|
5984
5839
|
# @!attribute [rw] id
|
5985
5840
|
# The API's identifier. This identifier is unique across all of your
|
5986
5841
|
# APIs in API Gateway.
|
@@ -6059,13 +5914,10 @@ module Aws::APIGateway
|
|
6059
5914
|
# your APIs.
|
6060
5915
|
#
|
6061
5916
|
# <div class="seeAlso">
|
6062
|
-
# [Create an
|
5917
|
+
# [Create an
|
5918
|
+
# API]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/how-to-create-api.html)
|
6063
5919
|
# </div>
|
6064
5920
|
#
|
6065
|
-
#
|
6066
|
-
#
|
6067
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
6068
|
-
#
|
6069
5921
|
# @!attribute [rw] position
|
6070
5922
|
# @return [String]
|
6071
5923
|
#
|
@@ -6179,13 +6031,10 @@ module Aws::APIGateway
|
|
6179
6031
|
# that is callable by users.
|
6180
6032
|
#
|
6181
6033
|
# <div class="seeAlso">
|
6182
|
-
# [Deploy an
|
6034
|
+
# [Deploy an
|
6035
|
+
# API]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/how-to-deploy-api.html)
|
6183
6036
|
# </div>
|
6184
6037
|
#
|
6185
|
-
#
|
6186
|
-
#
|
6187
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html
|
6188
|
-
#
|
6189
6038
|
# @!attribute [rw] deployment_id
|
6190
6039
|
# The identifier of the Deployment that the stage points to.
|
6191
6040
|
# @return [String]
|
@@ -6308,13 +6157,10 @@ module Aws::APIGateway
|
|
6308
6157
|
# resource.
|
6309
6158
|
#
|
6310
6159
|
# <div class="seeAlso">
|
6311
|
-
# [Deploying API in
|
6160
|
+
# [Deploying API in
|
6161
|
+
# Stages]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/stages.html)
|
6312
6162
|
# </div>
|
6313
6163
|
#
|
6314
|
-
#
|
6315
|
-
#
|
6316
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/stages.html
|
6317
|
-
#
|
6318
6164
|
# @!attribute [rw] item
|
6319
6165
|
# The current page of elements from this collection.
|
6320
6166
|
# @return [Array<Types::Stage>]
|
@@ -6371,20 +6217,13 @@ module Aws::APIGateway
|
|
6371
6217
|
# Represents a mapping template used to transform a payload.
|
6372
6218
|
#
|
6373
6219
|
# <div class="seeAlso">
|
6374
|
-
# [Mapping
|
6220
|
+
# [Mapping
|
6221
|
+
# Templates]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/models-mappings.html#models-mappings-mappings)
|
6375
6222
|
# </div>
|
6376
6223
|
#
|
6377
|
-
#
|
6378
|
-
#
|
6379
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html#models-mappings-mappings
|
6380
|
-
#
|
6381
6224
|
# @!attribute [rw] value
|
6382
|
-
# The Apache [Velocity Template Language (VTL)][
|
6383
|
-
# used for the template resource.
|
6384
|
-
#
|
6385
|
-
#
|
6386
|
-
#
|
6387
|
-
# [1]: https://velocity.apache.org/engine/devel/vtl-reference-guide.html
|
6225
|
+
# The Apache [Velocity Template Language (VTL)]([[ApacheVtlUrl]])
|
6226
|
+
# template content used for the template resource.
|
6388
6227
|
# @return [String]
|
6389
6228
|
#
|
6390
6229
|
class Template < Struct.new(
|
@@ -6403,6 +6242,9 @@ module Aws::APIGateway
|
|
6403
6242
|
# headers: {
|
6404
6243
|
# "String" => "String",
|
6405
6244
|
# },
|
6245
|
+
# multi_value_headers: {
|
6246
|
+
# "String" => ["String"],
|
6247
|
+
# },
|
6406
6248
|
# path_with_query_string: "String",
|
6407
6249
|
# body: "String",
|
6408
6250
|
# stage_variables: {
|
@@ -6428,6 +6270,12 @@ module Aws::APIGateway
|
|
6428
6270
|
# or identity source, should be specified.
|
6429
6271
|
# @return [Hash<String,String>]
|
6430
6272
|
#
|
6273
|
+
# @!attribute [rw] multi_value_headers
|
6274
|
+
# \[Optional\] The headers as a map from string to list of values to
|
6275
|
+
# simulate an incoming invocation request. This is where the incoming
|
6276
|
+
# authorization token, or identity source, may be specified.
|
6277
|
+
# @return [Hash<String,Array<String>>]
|
6278
|
+
#
|
6431
6279
|
# @!attribute [rw] path_with_query_string
|
6432
6280
|
# \[Optional\] The URI path, including query string, of the simulated
|
6433
6281
|
# invocation request. Use this to specify path parameters and query
|
@@ -6452,6 +6300,7 @@ module Aws::APIGateway
|
|
6452
6300
|
:rest_api_id,
|
6453
6301
|
:authorizer_id,
|
6454
6302
|
:headers,
|
6303
|
+
:multi_value_headers,
|
6455
6304
|
:path_with_query_string,
|
6456
6305
|
:body,
|
6457
6306
|
:stage_variables,
|
@@ -6487,12 +6336,9 @@ module Aws::APIGateway
|
|
6487
6336
|
# @return [Hash<String,Array<String>>]
|
6488
6337
|
#
|
6489
6338
|
# @!attribute [rw] claims
|
6490
|
-
# The [open identity claims][
|
6491
|
-
# returned from the Cognito Your User Pool
|
6492
|
-
#
|
6493
|
-
#
|
6494
|
-
#
|
6495
|
-
# [1]: https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
6339
|
+
# The [open identity claims]([[OpenIdClaimsUrl]]), with any supported
|
6340
|
+
# custom attributes, returned from the Cognito Your User Pool
|
6341
|
+
# configured for the API.
|
6496
6342
|
# @return [Hash<String,String>]
|
6497
6343
|
#
|
6498
6344
|
class TestInvokeAuthorizerResponse < Struct.new(
|
@@ -6520,6 +6366,9 @@ module Aws::APIGateway
|
|
6520
6366
|
# headers: {
|
6521
6367
|
# "String" => "String",
|
6522
6368
|
# },
|
6369
|
+
# multi_value_headers: {
|
6370
|
+
# "String" => ["String"],
|
6371
|
+
# },
|
6523
6372
|
# client_certificate_id: "String",
|
6524
6373
|
# stage_variables: {
|
6525
6374
|
# "String" => "String",
|
@@ -6553,6 +6402,11 @@ module Aws::APIGateway
|
|
6553
6402
|
# request.
|
6554
6403
|
# @return [Hash<String,String>]
|
6555
6404
|
#
|
6405
|
+
# @!attribute [rw] multi_value_headers
|
6406
|
+
# The headers as a map from string to list of values to simulate an
|
6407
|
+
# incoming invocation request.
|
6408
|
+
# @return [Hash<String,Array<String>>]
|
6409
|
+
#
|
6556
6410
|
# @!attribute [rw] client_certificate_id
|
6557
6411
|
# A ClientCertificate identifier to use in the test invocation. API
|
6558
6412
|
# Gateway will use the certificate when making the HTTPS request to
|
@@ -6571,6 +6425,7 @@ module Aws::APIGateway
|
|
6571
6425
|
:path_with_query_string,
|
6572
6426
|
:body,
|
6573
6427
|
:headers,
|
6428
|
+
:multi_value_headers,
|
6574
6429
|
:client_certificate_id,
|
6575
6430
|
:stage_variables)
|
6576
6431
|
include Aws::Structure
|
@@ -6579,13 +6434,10 @@ module Aws::APIGateway
|
|
6579
6434
|
# Represents the response of the test invoke request in the HTTP method.
|
6580
6435
|
#
|
6581
6436
|
# <div class="seeAlso">
|
6582
|
-
# [Test API using the API Gateway
|
6437
|
+
# [Test API using the API Gateway
|
6438
|
+
# console]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/how-to-test-method.html#how-to-test-method-console)
|
6583
6439
|
# </div>
|
6584
6440
|
#
|
6585
|
-
#
|
6586
|
-
#
|
6587
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-test-method.html#how-to-test-method-console
|
6588
|
-
#
|
6589
6441
|
# @!attribute [rw] status
|
6590
6442
|
# The HTTP status code.
|
6591
6443
|
# @return [Integer]
|
@@ -6598,6 +6450,11 @@ module Aws::APIGateway
|
|
6598
6450
|
# The headers of the HTTP response.
|
6599
6451
|
# @return [Hash<String,String>]
|
6600
6452
|
#
|
6453
|
+
# @!attribute [rw] multi_value_headers
|
6454
|
+
# The headers of the HTTP response as a map from string to list of
|
6455
|
+
# values.
|
6456
|
+
# @return [Hash<String,Array<String>>]
|
6457
|
+
#
|
6601
6458
|
# @!attribute [rw] log
|
6602
6459
|
# The API Gateway execution log for the test invoke request.
|
6603
6460
|
# @return [String]
|
@@ -6610,6 +6467,7 @@ module Aws::APIGateway
|
|
6610
6467
|
:status,
|
6611
6468
|
:body,
|
6612
6469
|
:headers,
|
6470
|
+
:multi_value_headers,
|
6613
6471
|
:log,
|
6614
6472
|
:latency)
|
6615
6473
|
include Aws::Structure
|
@@ -7537,14 +7395,12 @@ module Aws::APIGateway
|
|
7537
7395
|
# <div class="remarks"></div>
|
7538
7396
|
#
|
7539
7397
|
# <div class="seeAlso">
|
7540
|
-
# [Create and Use Usage
|
7398
|
+
# [Create and Use Usage
|
7399
|
+
# Plans]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-api-usage-plans.html),
|
7400
|
+
# [Manage Usage in a Usage
|
7401
|
+
# Plan]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-create-usage-plans-with-console.html#api-gateway-usage-plan-manage-usage)
|
7541
7402
|
# </div>
|
7542
7403
|
#
|
7543
|
-
#
|
7544
|
-
#
|
7545
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
|
7546
|
-
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-usage-plans-with-console.html#api-gateway-usage-plan-manage-usage
|
7547
|
-
#
|
7548
7404
|
# @!attribute [rw] usage_plan_id
|
7549
7405
|
# The plan Id associated with this usage data.
|
7550
7406
|
# @return [String]
|
@@ -7589,13 +7445,10 @@ module Aws::APIGateway
|
|
7589
7445
|
# </div>
|
7590
7446
|
#
|
7591
7447
|
# <div class="seeAlso">
|
7592
|
-
# [Create and Use Usage
|
7448
|
+
# [Create and Use Usage
|
7449
|
+
# Plans]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
|
7593
7450
|
# </div>
|
7594
7451
|
#
|
7595
|
-
#
|
7596
|
-
#
|
7597
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
|
7598
|
-
#
|
7599
7452
|
# @!attribute [rw] id
|
7600
7453
|
# The identifier of a UsagePlan resource.
|
7601
7454
|
# @return [String]
|
@@ -7646,13 +7499,10 @@ module Aws::APIGateway
|
|
7646
7499
|
# </div>
|
7647
7500
|
#
|
7648
7501
|
# " <div class="seeAlso">
|
7649
|
-
# [Create and Use Usage
|
7502
|
+
# [Create and Use Usage
|
7503
|
+
# Plans]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
|
7650
7504
|
# </div>
|
7651
7505
|
#
|
7652
|
-
#
|
7653
|
-
#
|
7654
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
|
7655
|
-
#
|
7656
7506
|
# @!attribute [rw] id
|
7657
7507
|
# The Id of a usage plan key.
|
7658
7508
|
# @return [String]
|
@@ -7682,13 +7532,10 @@ module Aws::APIGateway
|
|
7682
7532
|
# the associated API keys and, possibly, other types of keys.
|
7683
7533
|
#
|
7684
7534
|
# <div class="seeAlso">
|
7685
|
-
# [Create and Use Usage
|
7535
|
+
# [Create and Use Usage
|
7536
|
+
# Plans]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
|
7686
7537
|
# </div>
|
7687
7538
|
#
|
7688
|
-
#
|
7689
|
-
#
|
7690
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
|
7691
|
-
#
|
7692
7539
|
# @!attribute [rw] position
|
7693
7540
|
# @return [String]
|
7694
7541
|
#
|
@@ -7705,13 +7552,10 @@ module Aws::APIGateway
|
|
7705
7552
|
# Represents a collection of usage plans for an AWS account.
|
7706
7553
|
#
|
7707
7554
|
# <div class="seeAlso">
|
7708
|
-
# [Create and Use Usage
|
7555
|
+
# [Create and Use Usage
|
7556
|
+
# Plans]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/api-gateway-api-usage-plans.html)
|
7709
7557
|
# </div>
|
7710
7558
|
#
|
7711
|
-
#
|
7712
|
-
#
|
7713
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
|
7714
|
-
#
|
7715
7559
|
# @!attribute [rw] position
|
7716
7560
|
# @return [String]
|
7717
7561
|
#
|
@@ -7782,15 +7626,12 @@ module Aws::APIGateway
|
|
7782
7626
|
# The collection of VPC links under the caller's account in a region.
|
7783
7627
|
#
|
7784
7628
|
# <div class="seeAlso">
|
7785
|
-
# [Getting Started with Private
|
7786
|
-
# Integrations][
|
7629
|
+
# [Getting Started with Private
|
7630
|
+
# Integrations]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/getting-started-with-private-integration.html),
|
7631
|
+
# [Set up Private
|
7632
|
+
# Integrations]([[AwsDocsUrlPrefix]]/apigateway/latest/developerguide/set-up-private-integration.html)
|
7787
7633
|
# </div>
|
7788
7634
|
#
|
7789
|
-
#
|
7790
|
-
#
|
7791
|
-
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-with-private-integration.html
|
7792
|
-
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-private-integration.html
|
7793
|
-
#
|
7794
7635
|
# @!attribute [rw] position
|
7795
7636
|
# @return [String]
|
7796
7637
|
#
|