aws-sdk-apigateway 1.16.0 → 1.17.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 +23 -23
- data/lib/aws-sdk-apigateway/types.rb +98 -98
- 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: 8c8b328d744567738b6888bd12728a799ef704d9
|
|
4
|
+
data.tar.gz: eb2e6ba26f6423f856075e19dd10cd6b84f23302
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c523607acf00987ca6f0f069adc22f9ae18e27aec4dd9e8054f5185f7d7ff30602d87e6516d34dfb522d74c4e17f63f60636837d2630da95de46cda9b2cf5e09
|
|
7
|
+
data.tar.gz: 7d8ed3999748172459134980647026baaee0fb1fb77716ec953cac1a3acb7f73f05c7ebbc47f58acddb32d09954e13a8ba5ce01f20b7aa4c089852c5bcb79f00
|
data/lib/aws-sdk-apigateway.rb
CHANGED
|
@@ -186,7 +186,7 @@ module Aws::APIGateway
|
|
|
186
186
|
#
|
|
187
187
|
#
|
|
188
188
|
#
|
|
189
|
-
# [1]:
|
|
189
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html
|
|
190
190
|
#
|
|
191
191
|
# @option params [String] :name
|
|
192
192
|
# The name of the ApiKey.
|
|
@@ -269,7 +269,7 @@ module Aws::APIGateway
|
|
|
269
269
|
#
|
|
270
270
|
#
|
|
271
271
|
#
|
|
272
|
-
# [1]:
|
|
272
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html
|
|
273
273
|
#
|
|
274
274
|
# @option params [required, String] :rest_api_id
|
|
275
275
|
# \[Required\] The string identifier of the associated RestApi.
|
|
@@ -291,7 +291,7 @@ module Aws::APIGateway
|
|
|
291
291
|
# For a `TOKEN` or `REQUEST` authorizer, this is not defined.
|
|
292
292
|
#
|
|
293
293
|
# @option params [String] :auth_type
|
|
294
|
-
# Optional customer-defined field, used in
|
|
294
|
+
# Optional customer-defined field, used in OpenAPI imports and exports
|
|
295
295
|
# without functional impact.
|
|
296
296
|
#
|
|
297
297
|
# @option params [String] :authorizer_uri
|
|
@@ -540,7 +540,7 @@ module Aws::APIGateway
|
|
|
540
540
|
# @option params [required, String] :properties
|
|
541
541
|
# \[Required\] The new documentation content map of the targeted API
|
|
542
542
|
# entity. Enclosed key-value pairs are API-specific, but only
|
|
543
|
-
#
|
|
543
|
+
# OpenAPI-compliant key-value pairs can be exported and, hence,
|
|
544
544
|
# published.
|
|
545
545
|
#
|
|
546
546
|
# @return [Types::DocumentationPart] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -1332,7 +1332,7 @@ module Aws::APIGateway
|
|
|
1332
1332
|
#
|
|
1333
1333
|
#
|
|
1334
1334
|
#
|
|
1335
|
-
# [1]:
|
|
1335
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html
|
|
1336
1336
|
#
|
|
1337
1337
|
# @option params [required, String] :rest_api_id
|
|
1338
1338
|
# \[Required\] The string identifier of the associated RestApi.
|
|
@@ -2071,7 +2071,7 @@ module Aws::APIGateway
|
|
|
2071
2071
|
#
|
|
2072
2072
|
#
|
|
2073
2073
|
#
|
|
2074
|
-
# [1]:
|
|
2074
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html
|
|
2075
2075
|
#
|
|
2076
2076
|
# @option params [required, String] :rest_api_id
|
|
2077
2077
|
# \[Required\] The string identifier of the associated RestApi.
|
|
@@ -2128,7 +2128,7 @@ module Aws::APIGateway
|
|
|
2128
2128
|
#
|
|
2129
2129
|
#
|
|
2130
2130
|
#
|
|
2131
|
-
# [1]:
|
|
2131
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html
|
|
2132
2132
|
#
|
|
2133
2133
|
# @option params [required, String] :rest_api_id
|
|
2134
2134
|
# \[Required\] The string identifier of the associated RestApi.
|
|
@@ -2696,15 +2696,15 @@ module Aws::APIGateway
|
|
|
2696
2696
|
# \[Required\] The name of the Stage that will be exported.
|
|
2697
2697
|
#
|
|
2698
2698
|
# @option params [required, String] :export_type
|
|
2699
|
-
# \[Required\] The type of export.
|
|
2700
|
-
#
|
|
2699
|
+
# \[Required\] The type of export. Acceptable values are 'oas30' for
|
|
2700
|
+
# OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
|
|
2701
2701
|
#
|
|
2702
2702
|
# @option params [Hash<String,String>] :parameters
|
|
2703
2703
|
# A key-value map of query string parameters that specify properties of
|
|
2704
2704
|
# the export, depending on the requested `exportType`. For `exportType`
|
|
2705
|
-
# `swagger`, any combination of the following parameters are
|
|
2706
|
-
# `extensions='integrations'` or `extensions='apigateway'`
|
|
2707
|
-
# 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.
|
|
2708
2708
|
# `extensions='authorizers'` will export the API with
|
|
2709
2709
|
# x-amazon-apigateway-authorizer extensions. `postman` will export the
|
|
2710
2710
|
# API with Postman extensions, allowing for import to the Postman tool
|
|
@@ -2712,8 +2712,8 @@ module Aws::APIGateway
|
|
|
2712
2712
|
# @option params [String] :accepts
|
|
2713
2713
|
# The content-type of the export, for example `application/json`.
|
|
2714
2714
|
# Currently `application/json` and `application/yaml` are supported for
|
|
2715
|
-
# `exportType` of `swagger`. This should be specified in the
|
|
2716
|
-
# header for direct API requests.
|
|
2715
|
+
# `exportType` of`oas30` and `swagger`. This should be specified in the
|
|
2716
|
+
# `Accept` header for direct API requests.
|
|
2717
2717
|
#
|
|
2718
2718
|
# @return [Types::ExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2719
2719
|
#
|
|
@@ -4220,7 +4220,7 @@ module Aws::APIGateway
|
|
|
4220
4220
|
#
|
|
4221
4221
|
#
|
|
4222
4222
|
#
|
|
4223
|
-
# [1]:
|
|
4223
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-file-format.html
|
|
4224
4224
|
#
|
|
4225
4225
|
# @option params [required, String] :format
|
|
4226
4226
|
# A query parameter to specify the input format to imported API keys.
|
|
@@ -4272,7 +4272,7 @@ module Aws::APIGateway
|
|
|
4272
4272
|
#
|
|
4273
4273
|
# @option params [required, String, IO] :body
|
|
4274
4274
|
# \[Required\] Raw byte array representing the to-be-imported
|
|
4275
|
-
# documentation parts. To import from
|
|
4275
|
+
# documentation parts. To import from an OpenAPI file, this is a JSON
|
|
4276
4276
|
# object.
|
|
4277
4277
|
#
|
|
4278
4278
|
# @return [Types::DocumentationPartIds] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -4340,7 +4340,7 @@ module Aws::APIGateway
|
|
|
4340
4340
|
#
|
|
4341
4341
|
# @option params [required, String, IO] :body
|
|
4342
4342
|
# \[Required\] The POST request body containing external API
|
|
4343
|
-
# definitions. Currently, only
|
|
4343
|
+
# definitions. Currently, only OpenAPI definition JSON/YAML files are
|
|
4344
4344
|
# supported. The maximum size of the API definition file is 2MB.
|
|
4345
4345
|
#
|
|
4346
4346
|
# @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -4533,7 +4533,7 @@ module Aws::APIGateway
|
|
|
4533
4533
|
#
|
|
4534
4534
|
#
|
|
4535
4535
|
#
|
|
4536
|
-
# [1]:
|
|
4536
|
+
# [1]: https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id
|
|
4537
4537
|
#
|
|
4538
4538
|
# @option params [String] :credentials
|
|
4539
4539
|
# Specifies whether credentials are required for a put integration.
|
|
@@ -4800,7 +4800,7 @@ module Aws::APIGateway
|
|
|
4800
4800
|
#
|
|
4801
4801
|
#
|
|
4802
4802
|
#
|
|
4803
|
-
# [1]:
|
|
4803
|
+
# [1]: https://petstore-demo-endpoint.execute-api.com/petstore/pets
|
|
4804
4804
|
#
|
|
4805
4805
|
# @option params [Hash<String,Boolean>] :request_parameters
|
|
4806
4806
|
# A key-value map defining required or optional method request
|
|
@@ -5018,7 +5018,7 @@ module Aws::APIGateway
|
|
|
5018
5018
|
#
|
|
5019
5019
|
# @option params [required, String, IO] :body
|
|
5020
5020
|
# \[Required\] The PUT request body containing external API definitions.
|
|
5021
|
-
# Currently, only
|
|
5021
|
+
# Currently, only OpenAPI definition JSON/YAML files are supported. The
|
|
5022
5022
|
# maximum size of the API definition file is 2MB.
|
|
5023
5023
|
#
|
|
5024
5024
|
# @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -5110,7 +5110,7 @@ module Aws::APIGateway
|
|
|
5110
5110
|
#
|
|
5111
5111
|
#
|
|
5112
5112
|
#
|
|
5113
|
-
# [1]:
|
|
5113
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html
|
|
5114
5114
|
#
|
|
5115
5115
|
# @option params [required, String] :rest_api_id
|
|
5116
5116
|
# \[Required\] The string identifier of the associated RestApi.
|
|
@@ -5392,7 +5392,7 @@ module Aws::APIGateway
|
|
|
5392
5392
|
#
|
|
5393
5393
|
#
|
|
5394
5394
|
#
|
|
5395
|
-
# [1]:
|
|
5395
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html
|
|
5396
5396
|
#
|
|
5397
5397
|
# @option params [required, String] :rest_api_id
|
|
5398
5398
|
# \[Required\] The string identifier of the associated RestApi.
|
|
@@ -6641,7 +6641,7 @@ module Aws::APIGateway
|
|
|
6641
6641
|
params: params,
|
|
6642
6642
|
config: config)
|
|
6643
6643
|
context[:gem_name] = 'aws-sdk-apigateway'
|
|
6644
|
-
context[:gem_version] = '1.
|
|
6644
|
+
context[:gem_version] = '1.17.0'
|
|
6645
6645
|
Seahorse::Client::Request.new(handlers, context)
|
|
6646
6646
|
end
|
|
6647
6647
|
|
|
@@ -18,7 +18,7 @@ module Aws::APIGateway
|
|
|
18
18
|
#
|
|
19
19
|
#
|
|
20
20
|
#
|
|
21
|
-
# [1]:
|
|
21
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference
|
|
22
22
|
# @return [String]
|
|
23
23
|
#
|
|
24
24
|
# @!attribute [rw] destination_arn
|
|
@@ -58,7 +58,7 @@ module Aws::APIGateway
|
|
|
58
58
|
# The successful response returns a `200 OK` status code and a payload
|
|
59
59
|
# similar to the following:
|
|
60
60
|
#
|
|
61
|
-
# \{ "_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 \} \}
|
|
62
62
|
#
|
|
63
63
|
# In addition to making the REST API call directly, you can use the AWS
|
|
64
64
|
# CLI and an AWS SDK to access this resource.
|
|
@@ -71,10 +71,10 @@ module Aws::APIGateway
|
|
|
71
71
|
#
|
|
72
72
|
#
|
|
73
73
|
#
|
|
74
|
-
# [1]:
|
|
75
|
-
# [2]:
|
|
76
|
-
# [3]:
|
|
77
|
-
# [4]:
|
|
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
78
|
#
|
|
79
79
|
# @!attribute [rw] cloudwatch_role_arn
|
|
80
80
|
# The ARN of an Amazon CloudWatch role for the current Account.
|
|
@@ -112,7 +112,7 @@ module Aws::APIGateway
|
|
|
112
112
|
#
|
|
113
113
|
#
|
|
114
114
|
#
|
|
115
|
-
# [1]:
|
|
115
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html
|
|
116
116
|
#
|
|
117
117
|
# @!attribute [rw] id
|
|
118
118
|
# The identifier of the API Key.
|
|
@@ -190,7 +190,7 @@ module Aws::APIGateway
|
|
|
190
190
|
#
|
|
191
191
|
#
|
|
192
192
|
#
|
|
193
|
-
# [1]:
|
|
193
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html
|
|
194
194
|
#
|
|
195
195
|
# @!attribute [rw] warnings
|
|
196
196
|
# A list of warning messages logged during the import of API keys when
|
|
@@ -257,7 +257,7 @@ module Aws::APIGateway
|
|
|
257
257
|
#
|
|
258
258
|
#
|
|
259
259
|
#
|
|
260
|
-
# [1]:
|
|
260
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html
|
|
261
261
|
#
|
|
262
262
|
# @!attribute [rw] id
|
|
263
263
|
# The identifier for the authorizer resource.
|
|
@@ -282,7 +282,7 @@ module Aws::APIGateway
|
|
|
282
282
|
# @return [Array<String>]
|
|
283
283
|
#
|
|
284
284
|
# @!attribute [rw] auth_type
|
|
285
|
-
# Optional customer-defined field, used in
|
|
285
|
+
# Optional customer-defined field, used in OpenAPI imports and exports
|
|
286
286
|
# without functional impact.
|
|
287
287
|
# @return [String]
|
|
288
288
|
#
|
|
@@ -370,7 +370,7 @@ module Aws::APIGateway
|
|
|
370
370
|
#
|
|
371
371
|
#
|
|
372
372
|
#
|
|
373
|
-
# [1]:
|
|
373
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html
|
|
374
374
|
#
|
|
375
375
|
# @!attribute [rw] position
|
|
376
376
|
# @return [String]
|
|
@@ -399,7 +399,7 @@ module Aws::APIGateway
|
|
|
399
399
|
#
|
|
400
400
|
#
|
|
401
401
|
#
|
|
402
|
-
# [1]:
|
|
402
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html
|
|
403
403
|
#
|
|
404
404
|
# @!attribute [rw] base_path
|
|
405
405
|
# The base path name that callers of the API must provide as part of
|
|
@@ -429,7 +429,7 @@ module Aws::APIGateway
|
|
|
429
429
|
#
|
|
430
430
|
#
|
|
431
431
|
#
|
|
432
|
-
# [1]:
|
|
432
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html
|
|
433
433
|
#
|
|
434
434
|
# @!attribute [rw] position
|
|
435
435
|
# @return [String]
|
|
@@ -501,7 +501,7 @@ module Aws::APIGateway
|
|
|
501
501
|
#
|
|
502
502
|
#
|
|
503
503
|
#
|
|
504
|
-
# [1]:
|
|
504
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html
|
|
505
505
|
#
|
|
506
506
|
# @!attribute [rw] client_certificate_id
|
|
507
507
|
# The identifier of the client certificate.
|
|
@@ -542,7 +542,7 @@ module Aws::APIGateway
|
|
|
542
542
|
#
|
|
543
543
|
#
|
|
544
544
|
#
|
|
545
|
-
# [1]:
|
|
545
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html
|
|
546
546
|
#
|
|
547
547
|
# @!attribute [rw] position
|
|
548
548
|
# @return [String]
|
|
@@ -661,7 +661,7 @@ module Aws::APIGateway
|
|
|
661
661
|
# @return [Array<String>]
|
|
662
662
|
#
|
|
663
663
|
# @!attribute [rw] auth_type
|
|
664
|
-
# Optional customer-defined field, used in
|
|
664
|
+
# Optional customer-defined field, used in OpenAPI imports and exports
|
|
665
665
|
# without functional impact.
|
|
666
666
|
# @return [String]
|
|
667
667
|
#
|
|
@@ -895,7 +895,7 @@ module Aws::APIGateway
|
|
|
895
895
|
# @!attribute [rw] properties
|
|
896
896
|
# \[Required\] The new documentation content map of the targeted API
|
|
897
897
|
# entity. Enclosed key-value pairs are API-specific, but only
|
|
898
|
-
#
|
|
898
|
+
# OpenAPI-compliant key-value pairs can be exported and, hence,
|
|
899
899
|
# published.
|
|
900
900
|
# @return [String]
|
|
901
901
|
#
|
|
@@ -2008,7 +2008,7 @@ module Aws::APIGateway
|
|
|
2008
2008
|
#
|
|
2009
2009
|
#
|
|
2010
2010
|
#
|
|
2011
|
-
# [1]:
|
|
2011
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-deployment.html
|
|
2012
2012
|
# [2]: https://aws.amazon.com/tools/
|
|
2013
2013
|
#
|
|
2014
2014
|
# @!attribute [rw] id
|
|
@@ -2092,8 +2092,8 @@ module Aws::APIGateway
|
|
|
2092
2092
|
#
|
|
2093
2093
|
#
|
|
2094
2094
|
#
|
|
2095
|
-
# [1]:
|
|
2096
|
-
# [2]:
|
|
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
2097
|
# [3]: https://aws.amazon.com/tools/
|
|
2098
2098
|
#
|
|
2099
2099
|
# @!attribute [rw] position
|
|
@@ -2122,8 +2122,8 @@ module Aws::APIGateway
|
|
|
2122
2122
|
#
|
|
2123
2123
|
# The content map is a JSON string of API-specific key-value pairs.
|
|
2124
2124
|
# Although an API can use any shape for the content map, only the
|
|
2125
|
-
#
|
|
2126
|
-
# 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
|
|
2127
2127
|
# file.
|
|
2128
2128
|
#
|
|
2129
2129
|
# </div>
|
|
@@ -2134,7 +2134,7 @@ module Aws::APIGateway
|
|
|
2134
2134
|
#
|
|
2135
2135
|
#
|
|
2136
2136
|
#
|
|
2137
|
-
# [1]:
|
|
2137
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
|
2138
2138
|
#
|
|
2139
2139
|
# @!attribute [rw] id
|
|
2140
2140
|
# The DocumentationPart identifier, generated by API Gateway when the
|
|
@@ -2154,12 +2154,12 @@ module Aws::APIGateway
|
|
|
2154
2154
|
# A content map of API-specific key-value pairs describing the
|
|
2155
2155
|
# targeted API entity. The map must be encoded as a JSON string, e.g.,
|
|
2156
2156
|
# `"\{ "description": "The API does ..." \}"`. Only
|
|
2157
|
-
#
|
|
2157
|
+
# OpenAPI-compliant documentation-related fields from the
|
|
2158
2158
|
# <literal>properties</literal>
|
|
2159
2159
|
#
|
|
2160
2160
|
# map are exported and, hence, published as part of the API entity
|
|
2161
2161
|
# definitions, while the original documentation parts are exported in
|
|
2162
|
-
# a
|
|
2162
|
+
# a OpenAPI extension of `x-amazon-apigateway-documentation`.
|
|
2163
2163
|
# @return [String]
|
|
2164
2164
|
#
|
|
2165
2165
|
class DocumentationPart < Struct.new(
|
|
@@ -2173,7 +2173,7 @@ module Aws::APIGateway
|
|
|
2173
2173
|
#
|
|
2174
2174
|
# <div class="remarks">
|
|
2175
2175
|
# This is used to return the result when documentation parts in an
|
|
2176
|
-
# external (e.g.,
|
|
2176
|
+
# external (e.g., OpenAPI) file are imported into API Gateway
|
|
2177
2177
|
# </div>
|
|
2178
2178
|
#
|
|
2179
2179
|
# <div class="seeAlso">
|
|
@@ -2183,8 +2183,8 @@ module Aws::APIGateway
|
|
|
2183
2183
|
#
|
|
2184
2184
|
#
|
|
2185
2185
|
#
|
|
2186
|
-
# [1]:
|
|
2187
|
-
# [2]:
|
|
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
2188
|
#
|
|
2189
2189
|
# @!attribute [rw] ids
|
|
2190
2190
|
# A list of the returned documentation part identifiers.
|
|
@@ -2283,7 +2283,7 @@ module Aws::APIGateway
|
|
|
2283
2283
|
#
|
|
2284
2284
|
#
|
|
2285
2285
|
#
|
|
2286
|
-
# [1]:
|
|
2286
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
|
2287
2287
|
#
|
|
2288
2288
|
# @!attribute [rw] position
|
|
2289
2289
|
# @return [String]
|
|
@@ -2303,7 +2303,7 @@ module Aws::APIGateway
|
|
|
2303
2303
|
# <div class="remarks" markdown="1">
|
|
2304
2304
|
# Publishing API documentation involves creating a documentation version
|
|
2305
2305
|
# associated with an API stage and exporting the versioned documentation
|
|
2306
|
-
# to an external (e.g.,
|
|
2306
|
+
# to an external (e.g., OpenAPI) file.
|
|
2307
2307
|
#
|
|
2308
2308
|
# </div>
|
|
2309
2309
|
#
|
|
@@ -2313,7 +2313,7 @@ module Aws::APIGateway
|
|
|
2313
2313
|
#
|
|
2314
2314
|
#
|
|
2315
2315
|
#
|
|
2316
|
-
# [1]:
|
|
2316
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
|
2317
2317
|
#
|
|
2318
2318
|
# @!attribute [rw] version
|
|
2319
2319
|
# The version identifier of the API documentation snapshot.
|
|
@@ -2348,7 +2348,7 @@ module Aws::APIGateway
|
|
|
2348
2348
|
#
|
|
2349
2349
|
#
|
|
2350
2350
|
#
|
|
2351
|
-
# [1]:
|
|
2351
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
|
2352
2352
|
#
|
|
2353
2353
|
# @!attribute [rw] position
|
|
2354
2354
|
# @return [String]
|
|
@@ -2386,7 +2386,7 @@ module Aws::APIGateway
|
|
|
2386
2386
|
#
|
|
2387
2387
|
#
|
|
2388
2388
|
#
|
|
2389
|
-
# [1]:
|
|
2389
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html
|
|
2390
2390
|
#
|
|
2391
2391
|
# @!attribute [rw] domain_name
|
|
2392
2392
|
# The custom domain name as an API host name, for example,
|
|
@@ -2425,7 +2425,7 @@ module Aws::APIGateway
|
|
|
2425
2425
|
#
|
|
2426
2426
|
#
|
|
2427
2427
|
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html
|
|
2428
|
-
# [2]:
|
|
2428
|
+
# [2]: https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region
|
|
2429
2429
|
# @return [String]
|
|
2430
2430
|
#
|
|
2431
2431
|
# @!attribute [rw] regional_certificate_name
|
|
@@ -2449,7 +2449,7 @@ module Aws::APIGateway
|
|
|
2449
2449
|
#
|
|
2450
2450
|
#
|
|
2451
2451
|
#
|
|
2452
|
-
# [1]:
|
|
2452
|
+
# [1]: https://aws.amazon.com/documentation/cloudfront/
|
|
2453
2453
|
# @return [String]
|
|
2454
2454
|
#
|
|
2455
2455
|
# @!attribute [rw] distribution_hosted_zone_id
|
|
@@ -2461,7 +2461,7 @@ module Aws::APIGateway
|
|
|
2461
2461
|
#
|
|
2462
2462
|
#
|
|
2463
2463
|
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html
|
|
2464
|
-
# [2]:
|
|
2464
|
+
# [2]: https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region
|
|
2465
2465
|
# @return [String]
|
|
2466
2466
|
#
|
|
2467
2467
|
# @!attribute [rw] endpoint_configuration
|
|
@@ -2492,7 +2492,7 @@ module Aws::APIGateway
|
|
|
2492
2492
|
#
|
|
2493
2493
|
#
|
|
2494
2494
|
#
|
|
2495
|
-
# [1]:
|
|
2495
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html
|
|
2496
2496
|
#
|
|
2497
2497
|
# @!attribute [rw] position
|
|
2498
2498
|
# @return [String]
|
|
@@ -2637,8 +2637,8 @@ module Aws::APIGateway
|
|
|
2637
2637
|
#
|
|
2638
2638
|
#
|
|
2639
2639
|
#
|
|
2640
|
-
# [1]:
|
|
2641
|
-
# [2]:
|
|
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
2642
|
#
|
|
2643
2643
|
# @!attribute [rw] response_type
|
|
2644
2644
|
# The response type of the associated GatewayResponse. Valid values
|
|
@@ -2731,8 +2731,8 @@ module Aws::APIGateway
|
|
|
2731
2731
|
#
|
|
2732
2732
|
#
|
|
2733
2733
|
#
|
|
2734
|
-
# [1]:
|
|
2735
|
-
# [2]:
|
|
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
2736
|
#
|
|
2737
2737
|
# @!attribute [rw] position
|
|
2738
2738
|
# @return [String]
|
|
@@ -3283,15 +3283,15 @@ module Aws::APIGateway
|
|
|
3283
3283
|
# @return [String]
|
|
3284
3284
|
#
|
|
3285
3285
|
# @!attribute [rw] export_type
|
|
3286
|
-
# \[Required\] The type of export.
|
|
3287
|
-
#
|
|
3286
|
+
# \[Required\] The type of export. Acceptable values are 'oas30' for
|
|
3287
|
+
# OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
|
|
3288
3288
|
# @return [String]
|
|
3289
3289
|
#
|
|
3290
3290
|
# @!attribute [rw] parameters
|
|
3291
3291
|
# A key-value map of query string parameters that specify properties
|
|
3292
3292
|
# of the export, depending on the requested `exportType`. For
|
|
3293
|
-
# `exportType` `swagger`, any combination of the following
|
|
3294
|
-
# are supported: `extensions='integrations'` or
|
|
3293
|
+
# `exportType` `oas30` and `swagger`, any combination of the following
|
|
3294
|
+
# parameters are supported: `extensions='integrations'` or
|
|
3295
3295
|
# `extensions='apigateway'` will export the API with
|
|
3296
3296
|
# x-amazon-apigateway-integration extensions.
|
|
3297
3297
|
# `extensions='authorizers'` will export the API with
|
|
@@ -3302,8 +3302,8 @@ module Aws::APIGateway
|
|
|
3302
3302
|
# @!attribute [rw] accepts
|
|
3303
3303
|
# The content-type of the export, for example `application/json`.
|
|
3304
3304
|
# Currently `application/json` and `application/yaml` are supported
|
|
3305
|
-
# for `exportType` of `swagger`. This should be specified
|
|
3306
|
-
# `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.
|
|
3307
3307
|
# @return [String]
|
|
3308
3308
|
#
|
|
3309
3309
|
class GetExportRequest < Struct.new(
|
|
@@ -4207,7 +4207,7 @@ module Aws::APIGateway
|
|
|
4207
4207
|
#
|
|
4208
4208
|
#
|
|
4209
4209
|
#
|
|
4210
|
-
# [1]:
|
|
4210
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-file-format.html
|
|
4211
4211
|
# @return [String]
|
|
4212
4212
|
#
|
|
4213
4213
|
# @!attribute [rw] format
|
|
@@ -4227,7 +4227,7 @@ module Aws::APIGateway
|
|
|
4227
4227
|
include Aws::Structure
|
|
4228
4228
|
end
|
|
4229
4229
|
|
|
4230
|
-
# Import documentation parts from an external (e.g.,
|
|
4230
|
+
# Import documentation parts from an external (e.g., OpenAPI) definition
|
|
4231
4231
|
# file.
|
|
4232
4232
|
#
|
|
4233
4233
|
# @note When making an API call, you may pass ImportDocumentationPartsRequest
|
|
@@ -4258,7 +4258,7 @@ module Aws::APIGateway
|
|
|
4258
4258
|
#
|
|
4259
4259
|
# @!attribute [rw] body
|
|
4260
4260
|
# \[Required\] Raw byte array representing the to-be-imported
|
|
4261
|
-
# documentation parts. To import from
|
|
4261
|
+
# documentation parts. To import from an OpenAPI file, this is a JSON
|
|
4262
4262
|
# object.
|
|
4263
4263
|
# @return [String]
|
|
4264
4264
|
#
|
|
@@ -4321,7 +4321,7 @@ module Aws::APIGateway
|
|
|
4321
4321
|
#
|
|
4322
4322
|
# @!attribute [rw] body
|
|
4323
4323
|
# \[Required\] The POST request body containing external API
|
|
4324
|
-
# definitions. Currently, only
|
|
4324
|
+
# definitions. Currently, only OpenAPI definition JSON/YAML files are
|
|
4325
4325
|
# supported. The maximum size of the API definition file is 2MB.
|
|
4326
4326
|
# @return [String]
|
|
4327
4327
|
#
|
|
@@ -4345,7 +4345,7 @@ module Aws::APIGateway
|
|
|
4345
4345
|
#
|
|
4346
4346
|
#
|
|
4347
4347
|
#
|
|
4348
|
-
# [1]:
|
|
4348
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
|
4349
4349
|
#
|
|
4350
4350
|
# @!attribute [rw] type
|
|
4351
4351
|
# Specifies an API method integration type. The valid value is one of
|
|
@@ -4430,7 +4430,7 @@ module Aws::APIGateway
|
|
|
4430
4430
|
#
|
|
4431
4431
|
#
|
|
4432
4432
|
#
|
|
4433
|
-
# [1]:
|
|
4433
|
+
# [1]: https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id
|
|
4434
4434
|
# @return [String]
|
|
4435
4435
|
#
|
|
4436
4436
|
# @!attribute [rw] credentials
|
|
@@ -4539,7 +4539,7 @@ module Aws::APIGateway
|
|
|
4539
4539
|
# The successful response returns `200 OK` status and a payload as
|
|
4540
4540
|
# follows:
|
|
4541
4541
|
#
|
|
4542
|
-
# \{ "_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" \}
|
|
4543
4543
|
#
|
|
4544
4544
|
#
|
|
4545
4545
|
#
|
|
@@ -4551,7 +4551,7 @@ module Aws::APIGateway
|
|
|
4551
4551
|
#
|
|
4552
4552
|
#
|
|
4553
4553
|
#
|
|
4554
|
-
# [1]:
|
|
4554
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
|
4555
4555
|
# @return [Hash<String,Types::IntegrationResponse>]
|
|
4556
4556
|
#
|
|
4557
4557
|
class Integration < Struct.new(
|
|
@@ -4582,7 +4582,7 @@ module Aws::APIGateway
|
|
|
4582
4582
|
#
|
|
4583
4583
|
#
|
|
4584
4584
|
#
|
|
4585
|
-
# [1]:
|
|
4585
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
|
4586
4586
|
#
|
|
4587
4587
|
# @!attribute [rw] status_code
|
|
4588
4588
|
# Specifies the status code that is used to map the integration
|
|
@@ -4676,7 +4676,7 @@ module Aws::APIGateway
|
|
|
4676
4676
|
# The successful response returns a `200 OK` status code and a payload
|
|
4677
4677
|
# similar to the following:
|
|
4678
4678
|
#
|
|
4679
|
-
# \{ "_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" \} \} \}
|
|
4680
4680
|
#
|
|
4681
4681
|
# In the example above, the response template for the `200 OK` response
|
|
4682
4682
|
# maps the JSON output from the `ListStreams` action in the back end to
|
|
@@ -4694,8 +4694,8 @@ module Aws::APIGateway
|
|
|
4694
4694
|
#
|
|
4695
4695
|
#
|
|
4696
4696
|
#
|
|
4697
|
-
# [1]:
|
|
4698
|
-
# [2]:
|
|
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
4699
|
#
|
|
4700
4700
|
# @!attribute [rw] http_method
|
|
4701
4701
|
# The method's HTTP verb.
|
|
@@ -4729,7 +4729,7 @@ module Aws::APIGateway
|
|
|
4729
4729
|
#
|
|
4730
4730
|
#
|
|
4731
4731
|
#
|
|
4732
|
-
# [1]:
|
|
4732
|
+
# [1]: https://petstore-demo-endpoint.execute-api.com/petstore/pets
|
|
4733
4733
|
# @return [String]
|
|
4734
4734
|
#
|
|
4735
4735
|
# @!attribute [rw] request_parameters
|
|
@@ -4773,7 +4773,7 @@ module Aws::APIGateway
|
|
|
4773
4773
|
# The successful response returns a `200 OK` status code and a payload
|
|
4774
4774
|
# similar to the following:
|
|
4775
4775
|
#
|
|
4776
|
-
# \{ "_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" \}
|
|
4777
4777
|
#
|
|
4778
4778
|
#
|
|
4779
4779
|
#
|
|
@@ -4785,7 +4785,7 @@ module Aws::APIGateway
|
|
|
4785
4785
|
#
|
|
4786
4786
|
#
|
|
4787
4787
|
#
|
|
4788
|
-
# [1]:
|
|
4788
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-method-response.html
|
|
4789
4789
|
# @return [Hash<String,Types::MethodResponse>]
|
|
4790
4790
|
#
|
|
4791
4791
|
# @!attribute [rw] method_integration
|
|
@@ -4809,7 +4809,7 @@ module Aws::APIGateway
|
|
|
4809
4809
|
# The successful response returns a `200 OK` status code and a payload
|
|
4810
4810
|
# similar to the following:
|
|
4811
4811
|
#
|
|
4812
|
-
# \{ "_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" \} \} \}
|
|
4813
4813
|
#
|
|
4814
4814
|
#
|
|
4815
4815
|
#
|
|
@@ -4821,7 +4821,7 @@ module Aws::APIGateway
|
|
|
4821
4821
|
#
|
|
4822
4822
|
#
|
|
4823
4823
|
#
|
|
4824
|
-
# [1]:
|
|
4824
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-integration.html
|
|
4825
4825
|
# @return [Types::Integration]
|
|
4826
4826
|
#
|
|
4827
4827
|
# @!attribute [rw] authorization_scopes
|
|
@@ -4873,7 +4873,7 @@ module Aws::APIGateway
|
|
|
4873
4873
|
# The successful response returns `200 OK` status and a payload as
|
|
4874
4874
|
# follows:
|
|
4875
4875
|
#
|
|
4876
|
-
# \{ "_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" \}
|
|
4877
4877
|
#
|
|
4878
4878
|
#
|
|
4879
4879
|
#
|
|
@@ -4885,7 +4885,7 @@ module Aws::APIGateway
|
|
|
4885
4885
|
#
|
|
4886
4886
|
#
|
|
4887
4887
|
#
|
|
4888
|
-
# [1]:
|
|
4888
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
|
4889
4889
|
#
|
|
4890
4890
|
# @!attribute [rw] status_code
|
|
4891
4891
|
# The method response's status code.
|
|
@@ -5051,7 +5051,7 @@ module Aws::APIGateway
|
|
|
5051
5051
|
#
|
|
5052
5052
|
#
|
|
5053
5053
|
#
|
|
5054
|
-
# [1]:
|
|
5054
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html
|
|
5055
5055
|
#
|
|
5056
5056
|
# @!attribute [rw] id
|
|
5057
5057
|
# The identifier for the model resource.
|
|
@@ -5099,7 +5099,7 @@ module Aws::APIGateway
|
|
|
5099
5099
|
#
|
|
5100
5100
|
#
|
|
5101
5101
|
#
|
|
5102
|
-
# [1]:
|
|
5102
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html
|
|
5103
5103
|
#
|
|
5104
5104
|
# @!attribute [rw] position
|
|
5105
5105
|
# @return [String]
|
|
@@ -5163,7 +5163,7 @@ module Aws::APIGateway
|
|
|
5163
5163
|
#
|
|
5164
5164
|
#
|
|
5165
5165
|
#
|
|
5166
|
-
# [1]:
|
|
5166
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json
|
|
5167
5167
|
# @return [String]
|
|
5168
5168
|
#
|
|
5169
5169
|
# @!attribute [rw] from
|
|
@@ -5351,7 +5351,7 @@ module Aws::APIGateway
|
|
|
5351
5351
|
#
|
|
5352
5352
|
#
|
|
5353
5353
|
#
|
|
5354
|
-
# [1]:
|
|
5354
|
+
# [1]: https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id
|
|
5355
5355
|
# @return [String]
|
|
5356
5356
|
#
|
|
5357
5357
|
# @!attribute [rw] credentials
|
|
@@ -5596,7 +5596,7 @@ module Aws::APIGateway
|
|
|
5596
5596
|
#
|
|
5597
5597
|
#
|
|
5598
5598
|
#
|
|
5599
|
-
# [1]:
|
|
5599
|
+
# [1]: https://petstore-demo-endpoint.execute-api.com/petstore/pets
|
|
5600
5600
|
# @return [String]
|
|
5601
5601
|
#
|
|
5602
5602
|
# @!attribute [rw] request_parameters
|
|
@@ -5761,7 +5761,7 @@ module Aws::APIGateway
|
|
|
5761
5761
|
#
|
|
5762
5762
|
# @!attribute [rw] body
|
|
5763
5763
|
# \[Required\] The PUT request body containing external API
|
|
5764
|
-
# definitions. Currently, only
|
|
5764
|
+
# definitions. Currently, only OpenAPI definition JSON/YAML files are
|
|
5765
5765
|
# supported. The maximum size of the API definition file is 2MB.
|
|
5766
5766
|
# @return [String]
|
|
5767
5767
|
#
|
|
@@ -5810,7 +5810,7 @@ module Aws::APIGateway
|
|
|
5810
5810
|
# A set of validation rules for incoming Method requests.
|
|
5811
5811
|
#
|
|
5812
5812
|
# <div class="remarks" markdown="1">
|
|
5813
|
-
# In
|
|
5813
|
+
# In OpenAPI, a RequestValidator of an API is defined by the
|
|
5814
5814
|
# [x-amazon-apigateway-request-validators.requestValidator][1] object.
|
|
5815
5815
|
# It the referenced using the [x-amazon-apigateway-request-validator][2]
|
|
5816
5816
|
# property.
|
|
@@ -5823,9 +5823,9 @@ module Aws::APIGateway
|
|
|
5823
5823
|
#
|
|
5824
5824
|
#
|
|
5825
5825
|
#
|
|
5826
|
-
# [1]:
|
|
5827
|
-
# [2]:
|
|
5828
|
-
# [3]:
|
|
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
5829
|
#
|
|
5830
5830
|
# @!attribute [rw] id
|
|
5831
5831
|
# The identifier of this RequestValidator.
|
|
@@ -5856,7 +5856,7 @@ module Aws::APIGateway
|
|
|
5856
5856
|
# A collection of RequestValidator resources of a given RestApi.
|
|
5857
5857
|
#
|
|
5858
5858
|
# <div class="remarks" markdown="1">
|
|
5859
|
-
# In
|
|
5859
|
+
# In OpenAPI, the RequestValidators of an API is defined by the
|
|
5860
5860
|
# [x-amazon-apigateway-request-validators][1] extension.
|
|
5861
5861
|
#
|
|
5862
5862
|
# </div>
|
|
@@ -5867,8 +5867,8 @@ module Aws::APIGateway
|
|
|
5867
5867
|
#
|
|
5868
5868
|
#
|
|
5869
5869
|
#
|
|
5870
|
-
# [1]:
|
|
5871
|
-
# [2]:
|
|
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
5872
|
#
|
|
5873
5873
|
# @!attribute [rw] position
|
|
5874
5874
|
# @return [String]
|
|
@@ -5891,7 +5891,7 @@ module Aws::APIGateway
|
|
|
5891
5891
|
#
|
|
5892
5892
|
#
|
|
5893
5893
|
#
|
|
5894
|
-
# [1]:
|
|
5894
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
|
5895
5895
|
#
|
|
5896
5896
|
# @!attribute [rw] id
|
|
5897
5897
|
# The resource's identifier.
|
|
@@ -5928,7 +5928,7 @@ module Aws::APIGateway
|
|
|
5928
5928
|
#
|
|
5929
5929
|
# ##### Response
|
|
5930
5930
|
#
|
|
5931
|
-
# \{ "_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" \} \} \}
|
|
5932
5932
|
#
|
|
5933
5933
|
# If the `OPTIONS` is enabled on the resource, you can follow the
|
|
5934
5934
|
# example here to get that method. Just replace the `GET` of the last
|
|
@@ -5956,7 +5956,7 @@ module Aws::APIGateway
|
|
|
5956
5956
|
#
|
|
5957
5957
|
#
|
|
5958
5958
|
#
|
|
5959
|
-
# [1]:
|
|
5959
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
|
5960
5960
|
#
|
|
5961
5961
|
# @!attribute [rw] position
|
|
5962
5962
|
# @return [String]
|
|
@@ -5979,7 +5979,7 @@ module Aws::APIGateway
|
|
|
5979
5979
|
#
|
|
5980
5980
|
#
|
|
5981
5981
|
#
|
|
5982
|
-
# [1]:
|
|
5982
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
|
5983
5983
|
#
|
|
5984
5984
|
# @!attribute [rw] id
|
|
5985
5985
|
# The API's identifier. This identifier is unique across all of your
|
|
@@ -6064,7 +6064,7 @@ module Aws::APIGateway
|
|
|
6064
6064
|
#
|
|
6065
6065
|
#
|
|
6066
6066
|
#
|
|
6067
|
-
# [1]:
|
|
6067
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html
|
|
6068
6068
|
#
|
|
6069
6069
|
# @!attribute [rw] position
|
|
6070
6070
|
# @return [String]
|
|
@@ -6184,7 +6184,7 @@ module Aws::APIGateway
|
|
|
6184
6184
|
#
|
|
6185
6185
|
#
|
|
6186
6186
|
#
|
|
6187
|
-
# [1]:
|
|
6187
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.html
|
|
6188
6188
|
#
|
|
6189
6189
|
# @!attribute [rw] deployment_id
|
|
6190
6190
|
# The identifier of the Deployment that the stage points to.
|
|
@@ -6313,7 +6313,7 @@ module Aws::APIGateway
|
|
|
6313
6313
|
#
|
|
6314
6314
|
#
|
|
6315
6315
|
#
|
|
6316
|
-
# [1]:
|
|
6316
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/stages.html
|
|
6317
6317
|
#
|
|
6318
6318
|
# @!attribute [rw] item
|
|
6319
6319
|
# The current page of elements from this collection.
|
|
@@ -6376,7 +6376,7 @@ module Aws::APIGateway
|
|
|
6376
6376
|
#
|
|
6377
6377
|
#
|
|
6378
6378
|
#
|
|
6379
|
-
# [1]:
|
|
6379
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html#models-mappings-mappings
|
|
6380
6380
|
#
|
|
6381
6381
|
# @!attribute [rw] value
|
|
6382
6382
|
# The Apache [Velocity Template Language (VTL)][1] template content
|
|
@@ -6384,7 +6384,7 @@ module Aws::APIGateway
|
|
|
6384
6384
|
#
|
|
6385
6385
|
#
|
|
6386
6386
|
#
|
|
6387
|
-
# [1]:
|
|
6387
|
+
# [1]: https://velocity.apache.org/engine/devel/vtl-reference-guide.html
|
|
6388
6388
|
# @return [String]
|
|
6389
6389
|
#
|
|
6390
6390
|
class Template < Struct.new(
|
|
@@ -6492,7 +6492,7 @@ module Aws::APIGateway
|
|
|
6492
6492
|
#
|
|
6493
6493
|
#
|
|
6494
6494
|
#
|
|
6495
|
-
# [1]:
|
|
6495
|
+
# [1]: https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
|
6496
6496
|
# @return [Hash<String,String>]
|
|
6497
6497
|
#
|
|
6498
6498
|
class TestInvokeAuthorizerResponse < Struct.new(
|
|
@@ -6584,7 +6584,7 @@ module Aws::APIGateway
|
|
|
6584
6584
|
#
|
|
6585
6585
|
#
|
|
6586
6586
|
#
|
|
6587
|
-
# [1]:
|
|
6587
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-test-method.html#how-to-test-method-console
|
|
6588
6588
|
#
|
|
6589
6589
|
# @!attribute [rw] status
|
|
6590
6590
|
# The HTTP status code.
|
|
@@ -7542,8 +7542,8 @@ module Aws::APIGateway
|
|
|
7542
7542
|
#
|
|
7543
7543
|
#
|
|
7544
7544
|
#
|
|
7545
|
-
# [1]:
|
|
7546
|
-
# [2]:
|
|
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
7547
|
#
|
|
7548
7548
|
# @!attribute [rw] usage_plan_id
|
|
7549
7549
|
# The plan Id associated with this usage data.
|
|
@@ -7594,7 +7594,7 @@ module Aws::APIGateway
|
|
|
7594
7594
|
#
|
|
7595
7595
|
#
|
|
7596
7596
|
#
|
|
7597
|
-
# [1]:
|
|
7597
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
|
|
7598
7598
|
#
|
|
7599
7599
|
# @!attribute [rw] id
|
|
7600
7600
|
# The identifier of a UsagePlan resource.
|
|
@@ -7651,7 +7651,7 @@ module Aws::APIGateway
|
|
|
7651
7651
|
#
|
|
7652
7652
|
#
|
|
7653
7653
|
#
|
|
7654
|
-
# [1]:
|
|
7654
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
|
|
7655
7655
|
#
|
|
7656
7656
|
# @!attribute [rw] id
|
|
7657
7657
|
# The Id of a usage plan key.
|
|
@@ -7687,7 +7687,7 @@ module Aws::APIGateway
|
|
|
7687
7687
|
#
|
|
7688
7688
|
#
|
|
7689
7689
|
#
|
|
7690
|
-
# [1]:
|
|
7690
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
|
|
7691
7691
|
#
|
|
7692
7692
|
# @!attribute [rw] position
|
|
7693
7693
|
# @return [String]
|
|
@@ -7710,7 +7710,7 @@ module Aws::APIGateway
|
|
|
7710
7710
|
#
|
|
7711
7711
|
#
|
|
7712
7712
|
#
|
|
7713
|
-
# [1]:
|
|
7713
|
+
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
|
|
7714
7714
|
#
|
|
7715
7715
|
# @!attribute [rw] position
|
|
7716
7716
|
# @return [String]
|
|
@@ -7788,8 +7788,8 @@ module Aws::APIGateway
|
|
|
7788
7788
|
#
|
|
7789
7789
|
#
|
|
7790
7790
|
#
|
|
7791
|
-
# [1]:
|
|
7792
|
-
# [2]:
|
|
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
7793
|
#
|
|
7794
7794
|
# @!attribute [rw] position
|
|
7795
7795
|
# @return [String]
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: aws-sdk-apigateway
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.17.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Amazon Web Services
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2018-09-
|
|
11
|
+
date: 2018-09-27 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: aws-sdk-core
|