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