aws-sdk-apigateway 1.0.0.rc9 → 1.0.0.rc10
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 +408 -105
- data/lib/aws-sdk-apigateway/client_api.rb +110 -0
- data/lib/aws-sdk-apigateway/types.rb +523 -137
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 58f5ffd9d71c64c7d78761c714727f6a3be20063
|
4
|
+
data.tar.gz: 292342d3a3d99406b40ef6936cbffa817ef33e3d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ba1af3b833a3909c6ec8a4514a94912147dc60a5601c009bac30328fccb803bb20ddde0730371845f4b7b8b3f7baa85a080bd99f71668003b65508d8d518a161
|
7
|
+
data.tar.gz: 4a85aaf74af629376624989670a8d8694e2e79aad5148d3a91fcd1df21c5a9d374b7d89a09425031c6b62e8c61578f5688533b46b883ae263f4c30a0d36ffbb4
|
data/lib/aws-sdk-apigateway.rb
CHANGED
@@ -241,7 +241,7 @@ module Aws::APIGateway
|
|
241
241
|
# [1]: http://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html
|
242
242
|
#
|
243
243
|
# @option params [required, String] :rest_api_id
|
244
|
-
# The
|
244
|
+
# The string identifier of the associated RestApi.
|
245
245
|
#
|
246
246
|
# @option params [required, String] :name
|
247
247
|
# \[Required\] The name of the authorizer.
|
@@ -333,7 +333,7 @@ module Aws::APIGateway
|
|
333
333
|
# callers to specify a base path name after the domain name.
|
334
334
|
#
|
335
335
|
# @option params [required, String] :rest_api_id
|
336
|
-
# The
|
336
|
+
# The string identifier of the associated RestApi.
|
337
337
|
#
|
338
338
|
# @option params [String] :stage
|
339
339
|
# The name of the API's stage that you want to use for this mapping.
|
@@ -372,7 +372,7 @@ module Aws::APIGateway
|
|
372
372
|
# callable over the internet.
|
373
373
|
#
|
374
374
|
# @option params [required, String] :rest_api_id
|
375
|
-
# The
|
375
|
+
# The string identifier of the associated RestApi.
|
376
376
|
#
|
377
377
|
# @option params [String] :stage_name
|
378
378
|
# The name of the Stage resource for the Deployment resource to create.
|
@@ -436,8 +436,7 @@ module Aws::APIGateway
|
|
436
436
|
end
|
437
437
|
|
438
438
|
# @option params [required, String] :rest_api_id
|
439
|
-
# \[Required\] The identifier of
|
440
|
-
# documentation part.
|
439
|
+
# \[Required\] The string identifier of the associated RestApi.
|
441
440
|
#
|
442
441
|
# @option params [required, Types::DocumentationPartLocation] :location
|
443
442
|
# \[Required\] The location of the targeted API entity of the
|
@@ -487,8 +486,7 @@ module Aws::APIGateway
|
|
487
486
|
end
|
488
487
|
|
489
488
|
# @option params [required, String] :rest_api_id
|
490
|
-
# \[Required\]
|
491
|
-
# documentation version.
|
489
|
+
# \[Required\] The string identifier of the associated RestApi.
|
492
490
|
#
|
493
491
|
# @option params [required, String] :documentation_version
|
494
492
|
# \[Required\] The version identifier of the new snapshot.
|
@@ -647,8 +645,7 @@ module Aws::APIGateway
|
|
647
645
|
# Creates a ReqeustValidator of a given RestApi.
|
648
646
|
#
|
649
647
|
# @option params [required, String] :rest_api_id
|
650
|
-
#
|
651
|
-
# RequestValidator is created.
|
648
|
+
# The string identifier of the associated RestApi.
|
652
649
|
#
|
653
650
|
# @option params [String] :name
|
654
651
|
# The name of the to-be-created RequestValidator.
|
@@ -695,7 +692,7 @@ module Aws::APIGateway
|
|
695
692
|
# Creates a Resource resource.
|
696
693
|
#
|
697
694
|
# @option params [required, String] :rest_api_id
|
698
|
-
# The identifier of the RestApi
|
695
|
+
# The string identifier of the associated RestApi.
|
699
696
|
#
|
700
697
|
# @option params [required, String] :parent_id
|
701
698
|
# The parent resource's identifier.
|
@@ -832,8 +829,7 @@ module Aws::APIGateway
|
|
832
829
|
# for the API.
|
833
830
|
#
|
834
831
|
# @option params [required, String] :rest_api_id
|
835
|
-
# The identifier of the RestApi
|
836
|
-
# create.
|
832
|
+
# The string identifier of the associated RestApi.
|
837
833
|
#
|
838
834
|
# @option params [required, String] :stage_name
|
839
835
|
# The name for the Stage resource.
|
@@ -1067,7 +1063,7 @@ module Aws::APIGateway
|
|
1067
1063
|
# [1]: http://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html
|
1068
1064
|
#
|
1069
1065
|
# @option params [required, String] :rest_api_id
|
1070
|
-
# The
|
1066
|
+
# The string identifier of the associated RestApi.
|
1071
1067
|
#
|
1072
1068
|
# @option params [required, String] :authorizer_id
|
1073
1069
|
# The identifier of the Authorizer resource.
|
@@ -1136,8 +1132,7 @@ module Aws::APIGateway
|
|
1136
1132
|
# if there are no Stage resources associated with it.
|
1137
1133
|
#
|
1138
1134
|
# @option params [required, String] :rest_api_id
|
1139
|
-
# The identifier of the RestApi
|
1140
|
-
# delete.
|
1135
|
+
# The string identifier of the associated RestApi.
|
1141
1136
|
#
|
1142
1137
|
# @option params [required, String] :deployment_id
|
1143
1138
|
# The identifier of the Deployment resource to delete.
|
@@ -1159,8 +1154,7 @@ module Aws::APIGateway
|
|
1159
1154
|
end
|
1160
1155
|
|
1161
1156
|
# @option params [required, String] :rest_api_id
|
1162
|
-
# \[Required\]
|
1163
|
-
# documentation part.
|
1157
|
+
# \[Required\] The string identifier of the associated RestApi.
|
1164
1158
|
#
|
1165
1159
|
# @option params [required, String] :documentation_part_id
|
1166
1160
|
# \[Required\] The identifier of the to-be-deleted documentation part.
|
@@ -1182,8 +1176,7 @@ module Aws::APIGateway
|
|
1182
1176
|
end
|
1183
1177
|
|
1184
1178
|
# @option params [required, String] :rest_api_id
|
1185
|
-
# \[Required\] The identifier of
|
1186
|
-
# snapshot.
|
1179
|
+
# \[Required\] The string identifier of the associated RestApi.
|
1187
1180
|
#
|
1188
1181
|
# @option params [required, String] :documentation_version
|
1189
1182
|
# \[Required\] The version identifier of a to-be-deleted documentation
|
@@ -1225,10 +1218,55 @@ module Aws::APIGateway
|
|
1225
1218
|
req.send_request(options)
|
1226
1219
|
end
|
1227
1220
|
|
1221
|
+
# Clears any customization of a GatewayResponse of a specified response
|
1222
|
+
# type on the given RestApi and resets it with the default settings.
|
1223
|
+
#
|
1224
|
+
# @option params [required, String] :rest_api_id
|
1225
|
+
# The string identifier of the associated RestApi.
|
1226
|
+
#
|
1227
|
+
# @option params [required, String] :response_type
|
1228
|
+
# The response type of the associated GatewayResponse. Valid values are
|
1229
|
+
# * ACCESS\_DENIED
|
1230
|
+
# * API\_CONFIGURATION\_ERROR
|
1231
|
+
# * AUTHORIZER\_FAILURE
|
1232
|
+
# * AUTHORIZER\_CONFIGURATION\_ERROR
|
1233
|
+
# * BAD\_REQUEST\_PARAMETERS
|
1234
|
+
# * BAD\_REQUEST\_BODY
|
1235
|
+
# * DEFAULT\_4XX
|
1236
|
+
# * DEFAULT\_5XX
|
1237
|
+
# * EXPIRED\_TOKEN
|
1238
|
+
# * INVALID\_SIGNATURE
|
1239
|
+
# * INTEGRATION\_FAILURE
|
1240
|
+
# * INTEGRATION\_TIMEOUT
|
1241
|
+
# * INVALID\_API\_KEY
|
1242
|
+
# * MISSING\_AUTHENTICATION\_TOKEN
|
1243
|
+
# * QUOTA\_EXCEEDED
|
1244
|
+
# * REQUEST\_TOO\_LARGE
|
1245
|
+
# * RESOURCE\_NOT\_FOUND
|
1246
|
+
# * THROTTLED
|
1247
|
+
# * UNAUTHORIZED
|
1248
|
+
# * UNSUPPORTED\_MEDIA\_TYPES
|
1249
|
+
#
|
1250
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1251
|
+
#
|
1252
|
+
# @example Request syntax with placeholder values
|
1253
|
+
#
|
1254
|
+
# resp = client.delete_gateway_response({
|
1255
|
+
# rest_api_id: "String", # required
|
1256
|
+
# response_type: "DEFAULT_4XX", # required, accepts DEFAULT_4XX, DEFAULT_5XX, RESOURCE_NOT_FOUND, UNAUTHORIZED, INVALID_API_KEY, ACCESS_DENIED, AUTHORIZER_FAILURE, AUTHORIZER_CONFIGURATION_ERROR, INVALID_SIGNATURE, EXPIRED_TOKEN, MISSING_AUTHENTICATION_TOKEN, INTEGRATION_FAILURE, INTEGRATION_TIMEOUT, API_CONFIGURATION_ERROR, UNSUPPORTED_MEDIA_TYPE, BAD_REQUEST_PARAMETERS, BAD_REQUEST_BODY, REQUEST_TOO_LARGE, THROTTLED, QUOTA_EXCEEDED
|
1257
|
+
# })
|
1258
|
+
#
|
1259
|
+
# @overload delete_gateway_response(params = {})
|
1260
|
+
# @param [Hash] params ({})
|
1261
|
+
def delete_gateway_response(params = {}, options = {})
|
1262
|
+
req = build_request(:delete_gateway_response, params)
|
1263
|
+
req.send_request(options)
|
1264
|
+
end
|
1265
|
+
|
1228
1266
|
# Represents a delete integration.
|
1229
1267
|
#
|
1230
1268
|
# @option params [required, String] :rest_api_id
|
1231
|
-
#
|
1269
|
+
# The string identifier of the associated RestApi.
|
1232
1270
|
#
|
1233
1271
|
# @option params [required, String] :resource_id
|
1234
1272
|
# Specifies a delete integration request's resource identifier.
|
@@ -1256,7 +1294,7 @@ module Aws::APIGateway
|
|
1256
1294
|
# Represents a delete integration response.
|
1257
1295
|
#
|
1258
1296
|
# @option params [required, String] :rest_api_id
|
1259
|
-
#
|
1297
|
+
# The string identifier of the associated RestApi.
|
1260
1298
|
#
|
1261
1299
|
# @option params [required, String] :resource_id
|
1262
1300
|
# Specifies a delete integration response request's resource
|
@@ -1289,7 +1327,7 @@ module Aws::APIGateway
|
|
1289
1327
|
# Deletes an existing Method resource.
|
1290
1328
|
#
|
1291
1329
|
# @option params [required, String] :rest_api_id
|
1292
|
-
# The
|
1330
|
+
# The string identifier of the associated RestApi.
|
1293
1331
|
#
|
1294
1332
|
# @option params [required, String] :resource_id
|
1295
1333
|
# The Resource identifier for the Method resource.
|
@@ -1317,7 +1355,7 @@ module Aws::APIGateway
|
|
1317
1355
|
# Deletes an existing MethodResponse resource.
|
1318
1356
|
#
|
1319
1357
|
# @option params [required, String] :rest_api_id
|
1320
|
-
# The
|
1358
|
+
# The string identifier of the associated RestApi.
|
1321
1359
|
#
|
1322
1360
|
# @option params [required, String] :resource_id
|
1323
1361
|
# The Resource identifier for the MethodResponse resource.
|
@@ -1349,7 +1387,7 @@ module Aws::APIGateway
|
|
1349
1387
|
# Deletes a model.
|
1350
1388
|
#
|
1351
1389
|
# @option params [required, String] :rest_api_id
|
1352
|
-
# The
|
1390
|
+
# The string identifier of the associated RestApi.
|
1353
1391
|
#
|
1354
1392
|
# @option params [required, String] :model_name
|
1355
1393
|
# The name of the model to delete.
|
@@ -1373,8 +1411,7 @@ module Aws::APIGateway
|
|
1373
1411
|
# Deletes a RequestValidator of a given RestApi.
|
1374
1412
|
#
|
1375
1413
|
# @option params [required, String] :rest_api_id
|
1376
|
-
#
|
1377
|
-
# RequestValidator is deleted.
|
1414
|
+
# The string identifier of the associated RestApi.
|
1378
1415
|
#
|
1379
1416
|
# @option params [required, String] :request_validator_id
|
1380
1417
|
# \[Required\] The identifier of the RequestValidator to be deleted.
|
@@ -1398,7 +1435,7 @@ module Aws::APIGateway
|
|
1398
1435
|
# Deletes a Resource resource.
|
1399
1436
|
#
|
1400
1437
|
# @option params [required, String] :rest_api_id
|
1401
|
-
# The
|
1438
|
+
# The string identifier of the associated RestApi.
|
1402
1439
|
#
|
1403
1440
|
# @option params [required, String] :resource_id
|
1404
1441
|
# The identifier of the Resource resource.
|
@@ -1422,7 +1459,7 @@ module Aws::APIGateway
|
|
1422
1459
|
# Deletes the specified API.
|
1423
1460
|
#
|
1424
1461
|
# @option params [required, String] :rest_api_id
|
1425
|
-
# The
|
1462
|
+
# The string identifier of the associated RestApi.
|
1426
1463
|
#
|
1427
1464
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1428
1465
|
#
|
@@ -1442,8 +1479,7 @@ module Aws::APIGateway
|
|
1442
1479
|
# Deletes a Stage resource.
|
1443
1480
|
#
|
1444
1481
|
# @option params [required, String] :rest_api_id
|
1445
|
-
# The identifier of the RestApi
|
1446
|
-
# delete.
|
1482
|
+
# The string identifier of the associated RestApi.
|
1447
1483
|
#
|
1448
1484
|
# @option params [required, String] :stage_name
|
1449
1485
|
# The name of the Stage resource to delete.
|
@@ -1514,7 +1550,7 @@ module Aws::APIGateway
|
|
1514
1550
|
# Flushes all authorizer cache entries on a stage.
|
1515
1551
|
#
|
1516
1552
|
# @option params [required, String] :rest_api_id
|
1517
|
-
# The
|
1553
|
+
# The string identifier of the associated RestApi.
|
1518
1554
|
#
|
1519
1555
|
# @option params [required, String] :stage_name
|
1520
1556
|
# The name of the stage to flush.
|
@@ -1538,7 +1574,7 @@ module Aws::APIGateway
|
|
1538
1574
|
# Flushes a stage's cache.
|
1539
1575
|
#
|
1540
1576
|
# @option params [required, String] :rest_api_id
|
1541
|
-
# The
|
1577
|
+
# The string identifier of the associated RestApi.
|
1542
1578
|
#
|
1543
1579
|
# @option params [required, String] :stage_name
|
1544
1580
|
# The name of the stage to flush its cache.
|
@@ -1672,7 +1708,7 @@ module Aws::APIGateway
|
|
1672
1708
|
# The current pagination position in the paged result set.
|
1673
1709
|
#
|
1674
1710
|
# @option params [Integer] :limit
|
1675
|
-
# The maximum number of
|
1711
|
+
# The maximum number of returned results per page.
|
1676
1712
|
#
|
1677
1713
|
# @option params [String] :name_query
|
1678
1714
|
# The name of queried API keys.
|
@@ -1736,7 +1772,7 @@ module Aws::APIGateway
|
|
1736
1772
|
# [1]: http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html
|
1737
1773
|
#
|
1738
1774
|
# @option params [required, String] :rest_api_id
|
1739
|
-
# The
|
1775
|
+
# The string identifier of the associated RestApi.
|
1740
1776
|
#
|
1741
1777
|
# @option params [required, String] :authorizer_id
|
1742
1778
|
# The identifier of the Authorizer resource.
|
@@ -1793,7 +1829,7 @@ module Aws::APIGateway
|
|
1793
1829
|
# [1]: http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html
|
1794
1830
|
#
|
1795
1831
|
# @option params [required, String] :rest_api_id
|
1796
|
-
# The
|
1832
|
+
# The string identifier of the associated RestApi.
|
1797
1833
|
#
|
1798
1834
|
# @option params [String] :position
|
1799
1835
|
# The current pagination position in the paged result set.
|
@@ -1989,8 +2025,7 @@ module Aws::APIGateway
|
|
1989
2025
|
# Gets information about a Deployment resource.
|
1990
2026
|
#
|
1991
2027
|
# @option params [required, String] :rest_api_id
|
1992
|
-
# The identifier of the RestApi
|
1993
|
-
# get information about.
|
2028
|
+
# The string identifier of the associated RestApi.
|
1994
2029
|
#
|
1995
2030
|
# @option params [required, String] :deployment_id
|
1996
2031
|
# The identifier of the Deployment resource to get information about.
|
@@ -2043,8 +2078,7 @@ module Aws::APIGateway
|
|
2043
2078
|
# Gets information about a Deployments collection.
|
2044
2079
|
#
|
2045
2080
|
# @option params [required, String] :rest_api_id
|
2046
|
-
# The identifier of the RestApi
|
2047
|
-
# Deployment resources to get information about.
|
2081
|
+
# The string identifier of the associated RestApi.
|
2048
2082
|
#
|
2049
2083
|
# @option params [String] :position
|
2050
2084
|
# The current pagination position in the paged result set.
|
@@ -2086,11 +2120,10 @@ module Aws::APIGateway
|
|
2086
2120
|
end
|
2087
2121
|
|
2088
2122
|
# @option params [required, String] :rest_api_id
|
2089
|
-
# \[Required\] The identifier of
|
2090
|
-
# documentation part.
|
2123
|
+
# \[Required\] The string identifier of the associated RestApi.
|
2091
2124
|
#
|
2092
2125
|
# @option params [required, String] :documentation_part_id
|
2093
|
-
# \[Required\] The identifier of the
|
2126
|
+
# \[Required\] The string identifier of the associated RestApi.
|
2094
2127
|
#
|
2095
2128
|
# @return [Types::DocumentationPart] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2096
2129
|
#
|
@@ -2123,8 +2156,7 @@ module Aws::APIGateway
|
|
2123
2156
|
end
|
2124
2157
|
|
2125
2158
|
# @option params [required, String] :rest_api_id
|
2126
|
-
# \[Required\] The identifier of the
|
2127
|
-
# documentation parts.
|
2159
|
+
# \[Required\] The string identifier of the associated RestApi.
|
2128
2160
|
#
|
2129
2161
|
# @option params [String] :type
|
2130
2162
|
# The type of API entities of the to-be-retrieved documentation parts.
|
@@ -2177,8 +2209,7 @@ module Aws::APIGateway
|
|
2177
2209
|
end
|
2178
2210
|
|
2179
2211
|
# @option params [required, String] :rest_api_id
|
2180
|
-
# \[Required\] The identifier of the
|
2181
|
-
# documentation snapshot.
|
2212
|
+
# \[Required\] The string identifier of the associated RestApi.
|
2182
2213
|
#
|
2183
2214
|
# @option params [required, String] :documentation_version
|
2184
2215
|
# \[Required\] The version identifier of the to-be-retrieved
|
@@ -2211,8 +2242,7 @@ module Aws::APIGateway
|
|
2211
2242
|
end
|
2212
2243
|
|
2213
2244
|
# @option params [required, String] :rest_api_id
|
2214
|
-
# \[Required\] The identifier of
|
2215
|
-
# documentation versions.
|
2245
|
+
# \[Required\] The string identifier of the associated RestApi.
|
2216
2246
|
#
|
2217
2247
|
# @option params [String] :position
|
2218
2248
|
# The current pagination position in the paged result set.
|
@@ -2324,7 +2354,7 @@ module Aws::APIGateway
|
|
2324
2354
|
# Exports a deployed version of a RestApi in a specified format.
|
2325
2355
|
#
|
2326
2356
|
# @option params [required, String] :rest_api_id
|
2327
|
-
# The identifier of the RestApi
|
2357
|
+
# The string identifier of the associated RestApi.
|
2328
2358
|
#
|
2329
2359
|
# @option params [required, String] :stage_name
|
2330
2360
|
# The name of the Stage that will be exported.
|
@@ -2379,10 +2409,121 @@ module Aws::APIGateway
|
|
2379
2409
|
req.send_request(options)
|
2380
2410
|
end
|
2381
2411
|
|
2412
|
+
# Gets a GatewayResponse of a specified response type on the given
|
2413
|
+
# RestApi.
|
2414
|
+
#
|
2415
|
+
# @option params [required, String] :rest_api_id
|
2416
|
+
# The string identifier of the associated RestApi.
|
2417
|
+
#
|
2418
|
+
# @option params [required, String] :response_type
|
2419
|
+
# The response type of the associated GatewayResponse. Valid values are
|
2420
|
+
# * ACCESS\_DENIED
|
2421
|
+
# * API\_CONFIGURATION\_ERROR
|
2422
|
+
# * AUTHORIZER\_FAILURE
|
2423
|
+
# * AUTHORIZER\_CONFIGURATION\_ERROR
|
2424
|
+
# * BAD\_REQUEST\_PARAMETERS
|
2425
|
+
# * BAD\_REQUEST\_BODY
|
2426
|
+
# * DEFAULT\_4XX
|
2427
|
+
# * DEFAULT\_5XX
|
2428
|
+
# * EXPIRED\_TOKEN
|
2429
|
+
# * INVALID\_SIGNATURE
|
2430
|
+
# * INTEGRATION\_FAILURE
|
2431
|
+
# * INTEGRATION\_TIMEOUT
|
2432
|
+
# * INVALID\_API\_KEY
|
2433
|
+
# * MISSING\_AUTHENTICATION\_TOKEN
|
2434
|
+
# * QUOTA\_EXCEEDED
|
2435
|
+
# * REQUEST\_TOO\_LARGE
|
2436
|
+
# * RESOURCE\_NOT\_FOUND
|
2437
|
+
# * THROTTLED
|
2438
|
+
# * UNAUTHORIZED
|
2439
|
+
# * UNSUPPORTED\_MEDIA\_TYPES
|
2440
|
+
#
|
2441
|
+
# @return [Types::GatewayResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2442
|
+
#
|
2443
|
+
# * {Types::GatewayResponse#response_type #response_type} => String
|
2444
|
+
# * {Types::GatewayResponse#status_code #status_code} => String
|
2445
|
+
# * {Types::GatewayResponse#response_parameters #response_parameters} => Hash<String,String>
|
2446
|
+
# * {Types::GatewayResponse#response_templates #response_templates} => Hash<String,String>
|
2447
|
+
# * {Types::GatewayResponse#default_response #default_response} => Boolean
|
2448
|
+
#
|
2449
|
+
# @example Request syntax with placeholder values
|
2450
|
+
#
|
2451
|
+
# resp = client.get_gateway_response({
|
2452
|
+
# rest_api_id: "String", # required
|
2453
|
+
# response_type: "DEFAULT_4XX", # required, accepts DEFAULT_4XX, DEFAULT_5XX, RESOURCE_NOT_FOUND, UNAUTHORIZED, INVALID_API_KEY, ACCESS_DENIED, AUTHORIZER_FAILURE, AUTHORIZER_CONFIGURATION_ERROR, INVALID_SIGNATURE, EXPIRED_TOKEN, MISSING_AUTHENTICATION_TOKEN, INTEGRATION_FAILURE, INTEGRATION_TIMEOUT, API_CONFIGURATION_ERROR, UNSUPPORTED_MEDIA_TYPE, BAD_REQUEST_PARAMETERS, BAD_REQUEST_BODY, REQUEST_TOO_LARGE, THROTTLED, QUOTA_EXCEEDED
|
2454
|
+
# })
|
2455
|
+
#
|
2456
|
+
# @example Response structure
|
2457
|
+
#
|
2458
|
+
# resp.response_type #=> String, one of "DEFAULT_4XX", "DEFAULT_5XX", "RESOURCE_NOT_FOUND", "UNAUTHORIZED", "INVALID_API_KEY", "ACCESS_DENIED", "AUTHORIZER_FAILURE", "AUTHORIZER_CONFIGURATION_ERROR", "INVALID_SIGNATURE", "EXPIRED_TOKEN", "MISSING_AUTHENTICATION_TOKEN", "INTEGRATION_FAILURE", "INTEGRATION_TIMEOUT", "API_CONFIGURATION_ERROR", "UNSUPPORTED_MEDIA_TYPE", "BAD_REQUEST_PARAMETERS", "BAD_REQUEST_BODY", "REQUEST_TOO_LARGE", "THROTTLED", "QUOTA_EXCEEDED"
|
2459
|
+
# resp.status_code #=> String
|
2460
|
+
# resp.response_parameters #=> Hash
|
2461
|
+
# resp.response_parameters["String"] #=> String
|
2462
|
+
# resp.response_templates #=> Hash
|
2463
|
+
# resp.response_templates["String"] #=> String
|
2464
|
+
# resp.default_response #=> Boolean
|
2465
|
+
#
|
2466
|
+
# @overload get_gateway_response(params = {})
|
2467
|
+
# @param [Hash] params ({})
|
2468
|
+
def get_gateway_response(params = {}, options = {})
|
2469
|
+
req = build_request(:get_gateway_response, params)
|
2470
|
+
req.send_request(options)
|
2471
|
+
end
|
2472
|
+
|
2473
|
+
# Gets the GatewayResponses collection on the given RestApi. If an API
|
2474
|
+
# developer has not added any definitions for gateway responses, the
|
2475
|
+
# result will be the Amazon API Gateway-generated default
|
2476
|
+
# GatewayResponses collection for the supported response types.
|
2477
|
+
#
|
2478
|
+
# @option params [required, String] :rest_api_id
|
2479
|
+
# The string identifier of the associated RestApi.
|
2480
|
+
#
|
2481
|
+
# @option params [String] :position
|
2482
|
+
# The current pagination position in the paged result set. The
|
2483
|
+
# GatewayResponse collection does not support pagination and the
|
2484
|
+
# position does not apply here.
|
2485
|
+
#
|
2486
|
+
# @option params [Integer] :limit
|
2487
|
+
# The maximum number of returned results per page. The GatewayResponses
|
2488
|
+
# collection does not support pagination and the limit does not apply
|
2489
|
+
# here.
|
2490
|
+
#
|
2491
|
+
# @return [Types::GatewayResponses] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2492
|
+
#
|
2493
|
+
# * {Types::GatewayResponses#position #position} => String
|
2494
|
+
# * {Types::GatewayResponses#items #items} => Array<Types::GatewayResponse>
|
2495
|
+
#
|
2496
|
+
# @example Request syntax with placeholder values
|
2497
|
+
#
|
2498
|
+
# resp = client.get_gateway_responses({
|
2499
|
+
# rest_api_id: "String", # required
|
2500
|
+
# position: "String",
|
2501
|
+
# limit: 1,
|
2502
|
+
# })
|
2503
|
+
#
|
2504
|
+
# @example Response structure
|
2505
|
+
#
|
2506
|
+
# resp.position #=> String
|
2507
|
+
# resp.items #=> Array
|
2508
|
+
# resp.items[0].response_type #=> String, one of "DEFAULT_4XX", "DEFAULT_5XX", "RESOURCE_NOT_FOUND", "UNAUTHORIZED", "INVALID_API_KEY", "ACCESS_DENIED", "AUTHORIZER_FAILURE", "AUTHORIZER_CONFIGURATION_ERROR", "INVALID_SIGNATURE", "EXPIRED_TOKEN", "MISSING_AUTHENTICATION_TOKEN", "INTEGRATION_FAILURE", "INTEGRATION_TIMEOUT", "API_CONFIGURATION_ERROR", "UNSUPPORTED_MEDIA_TYPE", "BAD_REQUEST_PARAMETERS", "BAD_REQUEST_BODY", "REQUEST_TOO_LARGE", "THROTTLED", "QUOTA_EXCEEDED"
|
2509
|
+
# resp.items[0].status_code #=> String
|
2510
|
+
# resp.items[0].response_parameters #=> Hash
|
2511
|
+
# resp.items[0].response_parameters["String"] #=> String
|
2512
|
+
# resp.items[0].response_templates #=> Hash
|
2513
|
+
# resp.items[0].response_templates["String"] #=> String
|
2514
|
+
# resp.items[0].default_response #=> Boolean
|
2515
|
+
#
|
2516
|
+
# @overload get_gateway_responses(params = {})
|
2517
|
+
# @param [Hash] params ({})
|
2518
|
+
def get_gateway_responses(params = {}, options = {})
|
2519
|
+
req = build_request(:get_gateway_responses, params)
|
2520
|
+
req.send_request(options)
|
2521
|
+
end
|
2522
|
+
|
2382
2523
|
# Represents a get integration.
|
2383
2524
|
#
|
2384
2525
|
# @option params [required, String] :rest_api_id
|
2385
|
-
#
|
2526
|
+
# The string identifier of the associated RestApi.
|
2386
2527
|
#
|
2387
2528
|
# @option params [required, String] :resource_id
|
2388
2529
|
# Specifies a get integration request's resource identifier
|
@@ -2446,7 +2587,7 @@ module Aws::APIGateway
|
|
2446
2587
|
# Represents a get integration response.
|
2447
2588
|
#
|
2448
2589
|
# @option params [required, String] :rest_api_id
|
2449
|
-
#
|
2590
|
+
# The string identifier of the associated RestApi.
|
2450
2591
|
#
|
2451
2592
|
# @option params [required, String] :resource_id
|
2452
2593
|
# Specifies a get integration response request's resource identifier.
|
@@ -2494,7 +2635,7 @@ module Aws::APIGateway
|
|
2494
2635
|
# Describe an existing Method resource.
|
2495
2636
|
#
|
2496
2637
|
# @option params [required, String] :rest_api_id
|
2497
|
-
# The
|
2638
|
+
# The string identifier of the associated RestApi.
|
2498
2639
|
#
|
2499
2640
|
# @option params [required, String] :resource_id
|
2500
2641
|
# The Resource identifier for the Method resource.
|
@@ -2573,7 +2714,7 @@ module Aws::APIGateway
|
|
2573
2714
|
# Describes a MethodResponse resource.
|
2574
2715
|
#
|
2575
2716
|
# @option params [required, String] :rest_api_id
|
2576
|
-
# The
|
2717
|
+
# The string identifier of the associated RestApi.
|
2577
2718
|
#
|
2578
2719
|
# @option params [required, String] :resource_id
|
2579
2720
|
# The Resource identifier for the MethodResponse resource.
|
@@ -2662,7 +2803,7 @@ module Aws::APIGateway
|
|
2662
2803
|
# payload into the structure of a model.
|
2663
2804
|
#
|
2664
2805
|
# @option params [required, String] :rest_api_id
|
2665
|
-
# The
|
2806
|
+
# The string identifier of the associated RestApi.
|
2666
2807
|
#
|
2667
2808
|
# @option params [required, String] :model_name
|
2668
2809
|
# The name of the model for which to generate a template.
|
@@ -2692,7 +2833,7 @@ module Aws::APIGateway
|
|
2692
2833
|
# Describes existing Models defined for a RestApi resource.
|
2693
2834
|
#
|
2694
2835
|
# @option params [required, String] :rest_api_id
|
2695
|
-
# The
|
2836
|
+
# The string identifier of the associated RestApi.
|
2696
2837
|
#
|
2697
2838
|
# @option params [String] :position
|
2698
2839
|
# The current pagination position in the paged result set.
|
@@ -2734,8 +2875,7 @@ module Aws::APIGateway
|
|
2734
2875
|
# Gets a RequestValidator of a given RestApi.
|
2735
2876
|
#
|
2736
2877
|
# @option params [required, String] :rest_api_id
|
2737
|
-
#
|
2738
|
-
# RequestValidator belongs.
|
2878
|
+
# The string identifier of the associated RestApi.
|
2739
2879
|
#
|
2740
2880
|
# @option params [required, String] :request_validator_id
|
2741
2881
|
# \[Required\] The identifier of the RequestValidator to be retrieved.
|
@@ -2771,8 +2911,7 @@ module Aws::APIGateway
|
|
2771
2911
|
# Gets the RequestValidators collection of a given RestApi.
|
2772
2912
|
#
|
2773
2913
|
# @option params [required, String] :rest_api_id
|
2774
|
-
#
|
2775
|
-
# RequestValidators collection belongs.
|
2914
|
+
# The string identifier of the associated RestApi.
|
2776
2915
|
#
|
2777
2916
|
# @option params [String] :position
|
2778
2917
|
# The current pagination position in the paged result set.
|
@@ -2812,7 +2951,7 @@ module Aws::APIGateway
|
|
2812
2951
|
# Lists information about a resource.
|
2813
2952
|
#
|
2814
2953
|
# @option params [required, String] :rest_api_id
|
2815
|
-
# The
|
2954
|
+
# The string identifier of the associated RestApi.
|
2816
2955
|
#
|
2817
2956
|
# @option params [required, String] :resource_id
|
2818
2957
|
# The identifier for the Resource resource.
|
@@ -2897,7 +3036,7 @@ module Aws::APIGateway
|
|
2897
3036
|
# Lists information about a collection of Resource resources.
|
2898
3037
|
#
|
2899
3038
|
# @option params [required, String] :rest_api_id
|
2900
|
-
# The
|
3039
|
+
# The string identifier of the associated RestApi.
|
2901
3040
|
#
|
2902
3041
|
# @option params [String] :position
|
2903
3042
|
# The current pagination position in the paged result set.
|
@@ -3068,7 +3207,7 @@ module Aws::APIGateway
|
|
3068
3207
|
# Generates a client SDK for a RestApi and Stage.
|
3069
3208
|
#
|
3070
3209
|
# @option params [required, String] :rest_api_id
|
3071
|
-
# The identifier of the RestApi
|
3210
|
+
# The string identifier of the associated RestApi.
|
3072
3211
|
#
|
3073
3212
|
# @option params [required, String] :stage_name
|
3074
3213
|
# The name of the Stage that the SDK will use.
|
@@ -3191,8 +3330,7 @@ module Aws::APIGateway
|
|
3191
3330
|
# Gets information about a Stage resource.
|
3192
3331
|
#
|
3193
3332
|
# @option params [required, String] :rest_api_id
|
3194
|
-
# The identifier of the RestApi
|
3195
|
-
# information about.
|
3333
|
+
# The string identifier of the associated RestApi.
|
3196
3334
|
#
|
3197
3335
|
# @option params [required, String] :stage_name
|
3198
3336
|
# The name of the Stage resource to get information about.
|
@@ -3255,7 +3393,7 @@ module Aws::APIGateway
|
|
3255
3393
|
# Gets information about one or more Stage resources.
|
3256
3394
|
#
|
3257
3395
|
# @option params [required, String] :rest_api_id
|
3258
|
-
# The
|
3396
|
+
# The string identifier of the associated RestApi.
|
3259
3397
|
#
|
3260
3398
|
# @option params [String] :deployment_id
|
3261
3399
|
# The stages' deployment identifiers.
|
@@ -3586,8 +3724,7 @@ module Aws::APIGateway
|
|
3586
3724
|
end
|
3587
3725
|
|
3588
3726
|
# @option params [required, String] :rest_api_id
|
3589
|
-
# \[Required\] The identifier of
|
3590
|
-
# documentation parts.
|
3727
|
+
# \[Required\] The string identifier of the associated RestApi.
|
3591
3728
|
#
|
3592
3729
|
# @option params [String] :mode
|
3593
3730
|
# A query parameter to indicate whether to overwrite (`OVERWRITE`) any
|
@@ -3641,11 +3778,16 @@ module Aws::APIGateway
|
|
3641
3778
|
# value is `false`.
|
3642
3779
|
#
|
3643
3780
|
# @option params [Hash<String,String>] :parameters
|
3644
|
-
# Custom header parameters as part of the request.
|
3781
|
+
# Custom header parameters as part of the request. For example, to
|
3782
|
+
# exclude DocumentationParts from an imported API, set
|
3783
|
+
# `ignore=documentation` as a `parameters` value, as in the AWS CLI
|
3784
|
+
# command of `aws apigateway import-rest-api --parameters
|
3785
|
+
# ignore=documentation --body 'file:///path/to/imported-api-body.json`.
|
3645
3786
|
#
|
3646
3787
|
# @option params [required, String, IO] :body
|
3647
3788
|
# The POST request body containing external API definitions. Currently,
|
3648
|
-
# only Swagger definition JSON files are supported.
|
3789
|
+
# only Swagger definition JSON files are supported. The maximum size of
|
3790
|
+
# the API definition file is 2MB.
|
3649
3791
|
#
|
3650
3792
|
# @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3651
3793
|
#
|
@@ -3686,10 +3828,89 @@ module Aws::APIGateway
|
|
3686
3828
|
req.send_request(options)
|
3687
3829
|
end
|
3688
3830
|
|
3689
|
-
#
|
3831
|
+
# Creates a customization of a GatewayResponse of a specified response
|
3832
|
+
# type and status code on the given RestApi.
|
3690
3833
|
#
|
3691
3834
|
# @option params [required, String] :rest_api_id
|
3692
|
-
#
|
3835
|
+
# The string identifier of the associated RestApi.
|
3836
|
+
#
|
3837
|
+
# @option params [required, String] :response_type
|
3838
|
+
# The response type of the associated GatewayResponse. Valid values are
|
3839
|
+
# * ACCESS\_DENIED
|
3840
|
+
# * API\_CONFIGURATION\_ERROR
|
3841
|
+
# * AUTHORIZER\_FAILURE
|
3842
|
+
# * AUTHORIZER\_CONFIGURATION\_ERROR
|
3843
|
+
# * BAD\_REQUEST\_PARAMETERS
|
3844
|
+
# * BAD\_REQUEST\_BODY
|
3845
|
+
# * DEFAULT\_4XX
|
3846
|
+
# * DEFAULT\_5XX
|
3847
|
+
# * EXPIRED\_TOKEN
|
3848
|
+
# * INVALID\_SIGNATURE
|
3849
|
+
# * INTEGRATION\_FAILURE
|
3850
|
+
# * INTEGRATION\_TIMEOUT
|
3851
|
+
# * INVALID\_API\_KEY
|
3852
|
+
# * MISSING\_AUTHENTICATION\_TOKEN
|
3853
|
+
# * QUOTA\_EXCEEDED
|
3854
|
+
# * REQUEST\_TOO\_LARGE
|
3855
|
+
# * RESOURCE\_NOT\_FOUND
|
3856
|
+
# * THROTTLED
|
3857
|
+
# * UNAUTHORIZED
|
3858
|
+
# * UNSUPPORTED\_MEDIA\_TYPES
|
3859
|
+
#
|
3860
|
+
# @option params [String] :status_code
|
3861
|
+
# The HTTP status code of the GatewayResponse.
|
3862
|
+
#
|
3863
|
+
# @option params [Hash<String,String>] :response_parameters
|
3864
|
+
# Response parameters (paths, query strings and headers) of the
|
3865
|
+
# GatewayResponse as a string-to-string map of key-value pairs.
|
3866
|
+
#
|
3867
|
+
# @option params [Hash<String,String>] :response_templates
|
3868
|
+
# Response templates of the GatewayResponse as a string-to-string map of
|
3869
|
+
# key-value pairs.
|
3870
|
+
#
|
3871
|
+
# @return [Types::GatewayResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3872
|
+
#
|
3873
|
+
# * {Types::GatewayResponse#response_type #response_type} => String
|
3874
|
+
# * {Types::GatewayResponse#status_code #status_code} => String
|
3875
|
+
# * {Types::GatewayResponse#response_parameters #response_parameters} => Hash<String,String>
|
3876
|
+
# * {Types::GatewayResponse#response_templates #response_templates} => Hash<String,String>
|
3877
|
+
# * {Types::GatewayResponse#default_response #default_response} => Boolean
|
3878
|
+
#
|
3879
|
+
# @example Request syntax with placeholder values
|
3880
|
+
#
|
3881
|
+
# resp = client.put_gateway_response({
|
3882
|
+
# rest_api_id: "String", # required
|
3883
|
+
# response_type: "DEFAULT_4XX", # required, accepts DEFAULT_4XX, DEFAULT_5XX, RESOURCE_NOT_FOUND, UNAUTHORIZED, INVALID_API_KEY, ACCESS_DENIED, AUTHORIZER_FAILURE, AUTHORIZER_CONFIGURATION_ERROR, INVALID_SIGNATURE, EXPIRED_TOKEN, MISSING_AUTHENTICATION_TOKEN, INTEGRATION_FAILURE, INTEGRATION_TIMEOUT, API_CONFIGURATION_ERROR, UNSUPPORTED_MEDIA_TYPE, BAD_REQUEST_PARAMETERS, BAD_REQUEST_BODY, REQUEST_TOO_LARGE, THROTTLED, QUOTA_EXCEEDED
|
3884
|
+
# status_code: "StatusCode",
|
3885
|
+
# response_parameters: {
|
3886
|
+
# "String" => "String",
|
3887
|
+
# },
|
3888
|
+
# response_templates: {
|
3889
|
+
# "String" => "String",
|
3890
|
+
# },
|
3891
|
+
# })
|
3892
|
+
#
|
3893
|
+
# @example Response structure
|
3894
|
+
#
|
3895
|
+
# resp.response_type #=> String, one of "DEFAULT_4XX", "DEFAULT_5XX", "RESOURCE_NOT_FOUND", "UNAUTHORIZED", "INVALID_API_KEY", "ACCESS_DENIED", "AUTHORIZER_FAILURE", "AUTHORIZER_CONFIGURATION_ERROR", "INVALID_SIGNATURE", "EXPIRED_TOKEN", "MISSING_AUTHENTICATION_TOKEN", "INTEGRATION_FAILURE", "INTEGRATION_TIMEOUT", "API_CONFIGURATION_ERROR", "UNSUPPORTED_MEDIA_TYPE", "BAD_REQUEST_PARAMETERS", "BAD_REQUEST_BODY", "REQUEST_TOO_LARGE", "THROTTLED", "QUOTA_EXCEEDED"
|
3896
|
+
# resp.status_code #=> String
|
3897
|
+
# resp.response_parameters #=> Hash
|
3898
|
+
# resp.response_parameters["String"] #=> String
|
3899
|
+
# resp.response_templates #=> Hash
|
3900
|
+
# resp.response_templates["String"] #=> String
|
3901
|
+
# resp.default_response #=> Boolean
|
3902
|
+
#
|
3903
|
+
# @overload put_gateway_response(params = {})
|
3904
|
+
# @param [Hash] params ({})
|
3905
|
+
def put_gateway_response(params = {}, options = {})
|
3906
|
+
req = build_request(:put_gateway_response, params)
|
3907
|
+
req.send_request(options)
|
3908
|
+
end
|
3909
|
+
|
3910
|
+
# Sets up a method's integration.
|
3911
|
+
#
|
3912
|
+
# @option params [required, String] :rest_api_id
|
3913
|
+
# The string identifier of the associated RestApi.
|
3693
3914
|
#
|
3694
3915
|
# @option params [required, String] :resource_id
|
3695
3916
|
# Specifies a put integration request's resource ID.
|
@@ -3705,12 +3926,21 @@ module Aws::APIGateway
|
|
3705
3926
|
# HTTP or AWS, this field is required.
|
3706
3927
|
#
|
3707
3928
|
# @option params [String] :uri
|
3708
|
-
# Specifies
|
3709
|
-
#
|
3710
|
-
#
|
3711
|
-
#
|
3712
|
-
#
|
3713
|
-
#
|
3929
|
+
# Specifies the integration's Uniform Resource Identifier (URI). For
|
3930
|
+
# HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL
|
3931
|
+
# according to the [RFC-3986 specification][1]. For AWS integrations,
|
3932
|
+
# the URI should be of the form
|
3933
|
+
# `arn:aws:apigateway:\{region\}:\{subdomain.service|service\}:\{path|action\}/\{service_api\}`.
|
3934
|
+
# `Region`, `subdomain` and `service` are used to determine the right
|
3935
|
+
# endpoint. For AWS services that use the `Action=` query string
|
3936
|
+
# parameter, `service_api` should be a valid action for the desired
|
3937
|
+
# service. For RESTful AWS service APIs, `path` is used to indicate that
|
3938
|
+
# the remaining substring in the URI should be treated as the path to
|
3939
|
+
# the resource, including the initial `/`.
|
3940
|
+
#
|
3941
|
+
#
|
3942
|
+
#
|
3943
|
+
# [1]: https://en.wikipedia.org/wiki/Uniform_Resource_Identifier
|
3714
3944
|
#
|
3715
3945
|
# @option params [String] :credentials
|
3716
3946
|
# Specifies whether credentials are required for a put integration.
|
@@ -3842,7 +4072,7 @@ module Aws::APIGateway
|
|
3842
4072
|
# Represents a put integration.
|
3843
4073
|
#
|
3844
4074
|
# @option params [required, String] :rest_api_id
|
3845
|
-
#
|
4075
|
+
# The string identifier of the associated RestApi.
|
3846
4076
|
#
|
3847
4077
|
# @option params [required, String] :resource_id
|
3848
4078
|
# Specifies a put integration response request's resource identifier.
|
@@ -3933,7 +4163,7 @@ module Aws::APIGateway
|
|
3933
4163
|
# Add a method to an existing Resource resource.
|
3934
4164
|
#
|
3935
4165
|
# @option params [required, String] :rest_api_id
|
3936
|
-
# The
|
4166
|
+
# The string identifier of the associated RestApi.
|
3937
4167
|
#
|
3938
4168
|
# @option params [required, String] :resource_id
|
3939
4169
|
# The Resource identifier for the new Method resource.
|
@@ -4066,7 +4296,7 @@ module Aws::APIGateway
|
|
4066
4296
|
# Adds a MethodResponse to an existing Method resource.
|
4067
4297
|
#
|
4068
4298
|
# @option params [required, String] :rest_api_id
|
4069
|
-
# The
|
4299
|
+
# The string identifier of the associated RestApi.
|
4070
4300
|
#
|
4071
4301
|
# @option params [required, String] :resource_id
|
4072
4302
|
# The Resource identifier for the Method resource.
|
@@ -4140,7 +4370,7 @@ module Aws::APIGateway
|
|
4140
4370
|
# or overwriting the existing API.
|
4141
4371
|
#
|
4142
4372
|
# @option params [required, String] :rest_api_id
|
4143
|
-
# The identifier of the RestApi
|
4373
|
+
# The string identifier of the associated RestApi.
|
4144
4374
|
#
|
4145
4375
|
# @option params [String] :mode
|
4146
4376
|
# The `mode` query parameter to specify the update mode. Valid values
|
@@ -4153,11 +4383,16 @@ module Aws::APIGateway
|
|
4153
4383
|
# value is `false`.
|
4154
4384
|
#
|
4155
4385
|
# @option params [Hash<String,String>] :parameters
|
4156
|
-
# Custom
|
4386
|
+
# Custom header parameters as part of the request. For example, to
|
4387
|
+
# exclude DocumentationParts from an imported API, set
|
4388
|
+
# `ignore=documentation` as a `parameters` value, as in the AWS CLI
|
4389
|
+
# command of `aws apigateway import-rest-api --parameters
|
4390
|
+
# ignore=documentation --body 'file:///path/to/imported-api-body.json`.
|
4157
4391
|
#
|
4158
4392
|
# @option params [required, String, IO] :body
|
4159
4393
|
# The PUT request body containing external API definitions. Currently,
|
4160
|
-
# only Swagger definition JSON files are supported.
|
4394
|
+
# only Swagger definition JSON files are supported. The maximum size of
|
4395
|
+
# the API definition file is 2MB.
|
4161
4396
|
#
|
4162
4397
|
# @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4163
4398
|
#
|
@@ -4212,7 +4447,7 @@ module Aws::APIGateway
|
|
4212
4447
|
# [1]: http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html
|
4213
4448
|
#
|
4214
4449
|
# @option params [required, String] :rest_api_id
|
4215
|
-
#
|
4450
|
+
# The string identifier of the associated RestApi.
|
4216
4451
|
#
|
4217
4452
|
# @option params [required, String] :authorizer_id
|
4218
4453
|
# Specifies a test invoke authorizer request's Authorizer ID.
|
@@ -4290,7 +4525,7 @@ module Aws::APIGateway
|
|
4290
4525
|
# parameters, and an incoming request body.
|
4291
4526
|
#
|
4292
4527
|
# @option params [required, String] :rest_api_id
|
4293
|
-
#
|
4528
|
+
# The string identifier of the associated RestApi.
|
4294
4529
|
#
|
4295
4530
|
# @option params [required, String] :resource_id
|
4296
4531
|
# Specifies a test invoke method request's resource ID.
|
@@ -4467,7 +4702,7 @@ module Aws::APIGateway
|
|
4467
4702
|
# [1]: http://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html
|
4468
4703
|
#
|
4469
4704
|
# @option params [required, String] :rest_api_id
|
4470
|
-
# The
|
4705
|
+
# The string identifier of the associated RestApi.
|
4471
4706
|
#
|
4472
4707
|
# @option params [required, String] :authorizer_id
|
4473
4708
|
# The identifier of the Authorizer resource.
|
@@ -4620,8 +4855,7 @@ module Aws::APIGateway
|
|
4620
4855
|
# Changes information about a Deployment resource.
|
4621
4856
|
#
|
4622
4857
|
# @option params [required, String] :rest_api_id
|
4623
|
-
# The
|
4624
|
-
# resource to change information about.
|
4858
|
+
# The string identifier of the associated RestApi.
|
4625
4859
|
#
|
4626
4860
|
# @option params [required, String] :deployment_id
|
4627
4861
|
# The replacement identifier for the Deployment resource to change
|
@@ -4671,8 +4905,7 @@ module Aws::APIGateway
|
|
4671
4905
|
end
|
4672
4906
|
|
4673
4907
|
# @option params [required, String] :rest_api_id
|
4674
|
-
# \[Required\] The identifier of
|
4675
|
-
# documentation part.
|
4908
|
+
# \[Required\] The string identifier of the associated RestApi.
|
4676
4909
|
#
|
4677
4910
|
# @option params [required, String] :documentation_part_id
|
4678
4911
|
# \[Required\] The identifier of the to-be-updated documentation part.
|
@@ -4720,8 +4953,7 @@ module Aws::APIGateway
|
|
4720
4953
|
end
|
4721
4954
|
|
4722
4955
|
# @option params [required, String] :rest_api_id
|
4723
|
-
# \[Required\] The identifier of
|
4724
|
-
# documentation version.
|
4956
|
+
# \[Required\] The string identifier of the associated RestApi..
|
4725
4957
|
#
|
4726
4958
|
# @option params [required, String] :documentation_version
|
4727
4959
|
# \[Required\] The version identifier of the to-be-updated documentation
|
@@ -4811,10 +5043,83 @@ module Aws::APIGateway
|
|
4811
5043
|
req.send_request(options)
|
4812
5044
|
end
|
4813
5045
|
|
5046
|
+
# Updates a GatewayResponse of a specified response type on the given
|
5047
|
+
# RestApi.
|
5048
|
+
#
|
5049
|
+
# @option params [required, String] :rest_api_id
|
5050
|
+
# The string identifier of the associated RestApi.
|
5051
|
+
#
|
5052
|
+
# @option params [required, String] :response_type
|
5053
|
+
# The response type of the associated GatewayResponse. Valid values are
|
5054
|
+
# * ACCESS\_DENIED
|
5055
|
+
# * API\_CONFIGURATION\_ERROR
|
5056
|
+
# * AUTHORIZER\_FAILURE
|
5057
|
+
# * AUTHORIZER\_CONFIGURATION\_ERROR
|
5058
|
+
# * BAD\_REQUEST\_PARAMETERS
|
5059
|
+
# * BAD\_REQUEST\_BODY
|
5060
|
+
# * DEFAULT\_4XX
|
5061
|
+
# * DEFAULT\_5XX
|
5062
|
+
# * EXPIRED\_TOKEN
|
5063
|
+
# * INVALID\_SIGNATURE
|
5064
|
+
# * INTEGRATION\_FAILURE
|
5065
|
+
# * INTEGRATION\_TIMEOUT
|
5066
|
+
# * INVALID\_API\_KEY
|
5067
|
+
# * MISSING\_AUTHENTICATION\_TOKEN
|
5068
|
+
# * QUOTA\_EXCEEDED
|
5069
|
+
# * REQUEST\_TOO\_LARGE
|
5070
|
+
# * RESOURCE\_NOT\_FOUND
|
5071
|
+
# * THROTTLED
|
5072
|
+
# * UNAUTHORIZED
|
5073
|
+
# * UNSUPPORTED\_MEDIA\_TYPES
|
5074
|
+
#
|
5075
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
5076
|
+
# A list of update operations to be applied to the specified resource
|
5077
|
+
# and in the order specified in this list.
|
5078
|
+
#
|
5079
|
+
# @return [Types::GatewayResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5080
|
+
#
|
5081
|
+
# * {Types::GatewayResponse#response_type #response_type} => String
|
5082
|
+
# * {Types::GatewayResponse#status_code #status_code} => String
|
5083
|
+
# * {Types::GatewayResponse#response_parameters #response_parameters} => Hash<String,String>
|
5084
|
+
# * {Types::GatewayResponse#response_templates #response_templates} => Hash<String,String>
|
5085
|
+
# * {Types::GatewayResponse#default_response #default_response} => Boolean
|
5086
|
+
#
|
5087
|
+
# @example Request syntax with placeholder values
|
5088
|
+
#
|
5089
|
+
# resp = client.update_gateway_response({
|
5090
|
+
# rest_api_id: "String", # required
|
5091
|
+
# response_type: "DEFAULT_4XX", # required, accepts DEFAULT_4XX, DEFAULT_5XX, RESOURCE_NOT_FOUND, UNAUTHORIZED, INVALID_API_KEY, ACCESS_DENIED, AUTHORIZER_FAILURE, AUTHORIZER_CONFIGURATION_ERROR, INVALID_SIGNATURE, EXPIRED_TOKEN, MISSING_AUTHENTICATION_TOKEN, INTEGRATION_FAILURE, INTEGRATION_TIMEOUT, API_CONFIGURATION_ERROR, UNSUPPORTED_MEDIA_TYPE, BAD_REQUEST_PARAMETERS, BAD_REQUEST_BODY, REQUEST_TOO_LARGE, THROTTLED, QUOTA_EXCEEDED
|
5092
|
+
# patch_operations: [
|
5093
|
+
# {
|
5094
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
5095
|
+
# path: "String",
|
5096
|
+
# value: "String",
|
5097
|
+
# from: "String",
|
5098
|
+
# },
|
5099
|
+
# ],
|
5100
|
+
# })
|
5101
|
+
#
|
5102
|
+
# @example Response structure
|
5103
|
+
#
|
5104
|
+
# resp.response_type #=> String, one of "DEFAULT_4XX", "DEFAULT_5XX", "RESOURCE_NOT_FOUND", "UNAUTHORIZED", "INVALID_API_KEY", "ACCESS_DENIED", "AUTHORIZER_FAILURE", "AUTHORIZER_CONFIGURATION_ERROR", "INVALID_SIGNATURE", "EXPIRED_TOKEN", "MISSING_AUTHENTICATION_TOKEN", "INTEGRATION_FAILURE", "INTEGRATION_TIMEOUT", "API_CONFIGURATION_ERROR", "UNSUPPORTED_MEDIA_TYPE", "BAD_REQUEST_PARAMETERS", "BAD_REQUEST_BODY", "REQUEST_TOO_LARGE", "THROTTLED", "QUOTA_EXCEEDED"
|
5105
|
+
# resp.status_code #=> String
|
5106
|
+
# resp.response_parameters #=> Hash
|
5107
|
+
# resp.response_parameters["String"] #=> String
|
5108
|
+
# resp.response_templates #=> Hash
|
5109
|
+
# resp.response_templates["String"] #=> String
|
5110
|
+
# resp.default_response #=> Boolean
|
5111
|
+
#
|
5112
|
+
# @overload update_gateway_response(params = {})
|
5113
|
+
# @param [Hash] params ({})
|
5114
|
+
def update_gateway_response(params = {}, options = {})
|
5115
|
+
req = build_request(:update_gateway_response, params)
|
5116
|
+
req.send_request(options)
|
5117
|
+
end
|
5118
|
+
|
4814
5119
|
# Represents an update integration.
|
4815
5120
|
#
|
4816
5121
|
# @option params [required, String] :rest_api_id
|
4817
|
-
#
|
5122
|
+
# The string identifier of the associated RestApi.
|
4818
5123
|
#
|
4819
5124
|
# @option params [required, String] :resource_id
|
4820
5125
|
# Represents an update integration request's resource identifier.
|
@@ -4890,7 +5195,7 @@ module Aws::APIGateway
|
|
4890
5195
|
# Represents an update integration response.
|
4891
5196
|
#
|
4892
5197
|
# @option params [required, String] :rest_api_id
|
4893
|
-
#
|
5198
|
+
# The string identifier of the associated RestApi.
|
4894
5199
|
#
|
4895
5200
|
# @option params [required, String] :resource_id
|
4896
5201
|
# Specifies an update integration response request's resource
|
@@ -4951,7 +5256,7 @@ module Aws::APIGateway
|
|
4951
5256
|
# Updates an existing Method resource.
|
4952
5257
|
#
|
4953
5258
|
# @option params [required, String] :rest_api_id
|
4954
|
-
# The
|
5259
|
+
# The string identifier of the associated RestApi.
|
4955
5260
|
#
|
4956
5261
|
# @option params [required, String] :resource_id
|
4957
5262
|
# The Resource identifier for the Method resource.
|
@@ -5042,7 +5347,7 @@ module Aws::APIGateway
|
|
5042
5347
|
# Updates an existing MethodResponse resource.
|
5043
5348
|
#
|
5044
5349
|
# @option params [required, String] :rest_api_id
|
5045
|
-
# The
|
5350
|
+
# The string identifier of the associated RestApi.
|
5046
5351
|
#
|
5047
5352
|
# @option params [required, String] :resource_id
|
5048
5353
|
# The Resource identifier for the MethodResponse resource.
|
@@ -5098,7 +5403,7 @@ module Aws::APIGateway
|
|
5098
5403
|
# Changes information about a model.
|
5099
5404
|
#
|
5100
5405
|
# @option params [required, String] :rest_api_id
|
5101
|
-
# The
|
5406
|
+
# The string identifier of the associated RestApi.
|
5102
5407
|
#
|
5103
5408
|
# @option params [required, String] :model_name
|
5104
5409
|
# The name of the model to update.
|
@@ -5148,8 +5453,7 @@ module Aws::APIGateway
|
|
5148
5453
|
# Updates a RequestValidator of a given RestApi.
|
5149
5454
|
#
|
5150
5455
|
# @option params [required, String] :rest_api_id
|
5151
|
-
#
|
5152
|
-
# RequestValidator is updated.
|
5456
|
+
# The string identifier of the associated RestApi.
|
5153
5457
|
#
|
5154
5458
|
# @option params [required, String] :request_validator_id
|
5155
5459
|
# \[Required\] The identifier of RequestValidator to be updated.
|
@@ -5197,7 +5501,7 @@ module Aws::APIGateway
|
|
5197
5501
|
# Changes information about a Resource resource.
|
5198
5502
|
#
|
5199
5503
|
# @option params [required, String] :rest_api_id
|
5200
|
-
# The
|
5504
|
+
# The string identifier of the associated RestApi.
|
5201
5505
|
#
|
5202
5506
|
# @option params [required, String] :resource_id
|
5203
5507
|
# The identifier of the Resource resource.
|
@@ -5284,7 +5588,7 @@ module Aws::APIGateway
|
|
5284
5588
|
# Changes information about the specified API.
|
5285
5589
|
#
|
5286
5590
|
# @option params [required, String] :rest_api_id
|
5287
|
-
# The
|
5591
|
+
# The string identifier of the associated RestApi.
|
5288
5592
|
#
|
5289
5593
|
# @option params [Array<Types::PatchOperation>] :patch_operations
|
5290
5594
|
# A list of update operations to be applied to the specified resource
|
@@ -5336,8 +5640,7 @@ module Aws::APIGateway
|
|
5336
5640
|
# Changes information about a Stage resource.
|
5337
5641
|
#
|
5338
5642
|
# @option params [required, String] :rest_api_id
|
5339
|
-
# The identifier of the RestApi
|
5340
|
-
# change information about.
|
5643
|
+
# The string identifier of the associated RestApi.
|
5341
5644
|
#
|
5342
5645
|
# @option params [required, String] :stage_name
|
5343
5646
|
# The name of the Stage resource to change information about.
|
@@ -5409,7 +5712,7 @@ module Aws::APIGateway
|
|
5409
5712
|
req.send_request(options)
|
5410
5713
|
end
|
5411
5714
|
|
5412
|
-
# Grants a temporary extension to the
|
5715
|
+
# Grants a temporary extension to the remaining quota of a usage plan
|
5413
5716
|
# associated with a specified API key.
|
5414
5717
|
#
|
5415
5718
|
# @option params [required, String] :usage_plan_id
|
@@ -5532,7 +5835,7 @@ module Aws::APIGateway
|
|
5532
5835
|
params: params,
|
5533
5836
|
config: config)
|
5534
5837
|
context[:gem_name] = 'aws-sdk-apigateway'
|
5535
|
-
context[:gem_version] = '1.0.0.
|
5838
|
+
context[:gem_version] = '1.0.0.rc10'
|
5536
5839
|
Seahorse::Client::Request.new(handlers, context)
|
5537
5840
|
end
|
5538
5841
|
|