aws-sdk-apigateway 1.0.0.rc9 → 1.0.0.rc10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-apigateway.rb +1 -1
- data/lib/aws-sdk-apigateway/client.rb +408 -105
- data/lib/aws-sdk-apigateway/client_api.rb +110 -0
- data/lib/aws-sdk-apigateway/types.rb +523 -137
- metadata +4 -4
@@ -53,6 +53,7 @@ module Aws::APIGateway
|
|
53
53
|
DeleteDocumentationPartRequest = Shapes::StructureShape.new(name: 'DeleteDocumentationPartRequest')
|
54
54
|
DeleteDocumentationVersionRequest = Shapes::StructureShape.new(name: 'DeleteDocumentationVersionRequest')
|
55
55
|
DeleteDomainNameRequest = Shapes::StructureShape.new(name: 'DeleteDomainNameRequest')
|
56
|
+
DeleteGatewayResponseRequest = Shapes::StructureShape.new(name: 'DeleteGatewayResponseRequest')
|
56
57
|
DeleteIntegrationRequest = Shapes::StructureShape.new(name: 'DeleteIntegrationRequest')
|
57
58
|
DeleteIntegrationResponseRequest = Shapes::StructureShape.new(name: 'DeleteIntegrationResponseRequest')
|
58
59
|
DeleteMethodRequest = Shapes::StructureShape.new(name: 'DeleteMethodRequest')
|
@@ -80,6 +81,9 @@ module Aws::APIGateway
|
|
80
81
|
ExportResponse = Shapes::StructureShape.new(name: 'ExportResponse')
|
81
82
|
FlushStageAuthorizersCacheRequest = Shapes::StructureShape.new(name: 'FlushStageAuthorizersCacheRequest')
|
82
83
|
FlushStageCacheRequest = Shapes::StructureShape.new(name: 'FlushStageCacheRequest')
|
84
|
+
GatewayResponse = Shapes::StructureShape.new(name: 'GatewayResponse')
|
85
|
+
GatewayResponseType = Shapes::StringShape.new(name: 'GatewayResponseType')
|
86
|
+
GatewayResponses = Shapes::StructureShape.new(name: 'GatewayResponses')
|
83
87
|
GenerateClientCertificateRequest = Shapes::StructureShape.new(name: 'GenerateClientCertificateRequest')
|
84
88
|
GetAccountRequest = Shapes::StructureShape.new(name: 'GetAccountRequest')
|
85
89
|
GetApiKeyRequest = Shapes::StructureShape.new(name: 'GetApiKeyRequest')
|
@@ -99,6 +103,8 @@ module Aws::APIGateway
|
|
99
103
|
GetDomainNameRequest = Shapes::StructureShape.new(name: 'GetDomainNameRequest')
|
100
104
|
GetDomainNamesRequest = Shapes::StructureShape.new(name: 'GetDomainNamesRequest')
|
101
105
|
GetExportRequest = Shapes::StructureShape.new(name: 'GetExportRequest')
|
106
|
+
GetGatewayResponseRequest = Shapes::StructureShape.new(name: 'GetGatewayResponseRequest')
|
107
|
+
GetGatewayResponsesRequest = Shapes::StructureShape.new(name: 'GetGatewayResponsesRequest')
|
102
108
|
GetIntegrationRequest = Shapes::StructureShape.new(name: 'GetIntegrationRequest')
|
103
109
|
GetIntegrationResponseRequest = Shapes::StructureShape.new(name: 'GetIntegrationResponseRequest')
|
104
110
|
GetMethodRequest = Shapes::StructureShape.new(name: 'GetMethodRequest')
|
@@ -140,6 +146,7 @@ module Aws::APIGateway
|
|
140
146
|
ListOfDocumentationPart = Shapes::ListShape.new(name: 'ListOfDocumentationPart')
|
141
147
|
ListOfDocumentationVersion = Shapes::ListShape.new(name: 'ListOfDocumentationVersion')
|
142
148
|
ListOfDomainName = Shapes::ListShape.new(name: 'ListOfDomainName')
|
149
|
+
ListOfGatewayResponse = Shapes::ListShape.new(name: 'ListOfGatewayResponse')
|
143
150
|
ListOfLong = Shapes::ListShape.new(name: 'ListOfLong')
|
144
151
|
ListOfModel = Shapes::ListShape.new(name: 'ListOfModel')
|
145
152
|
ListOfPatchOperation = Shapes::ListShape.new(name: 'ListOfPatchOperation')
|
@@ -178,6 +185,7 @@ module Aws::APIGateway
|
|
178
185
|
PatchOperation = Shapes::StructureShape.new(name: 'PatchOperation')
|
179
186
|
PathToMapOfMethodSnapshot = Shapes::MapShape.new(name: 'PathToMapOfMethodSnapshot')
|
180
187
|
ProviderARN = Shapes::StringShape.new(name: 'ProviderARN')
|
188
|
+
PutGatewayResponseRequest = Shapes::StructureShape.new(name: 'PutGatewayResponseRequest')
|
181
189
|
PutIntegrationRequest = Shapes::StructureShape.new(name: 'PutIntegrationRequest')
|
182
190
|
PutIntegrationResponseRequest = Shapes::StructureShape.new(name: 'PutIntegrationResponseRequest')
|
183
191
|
PutMethodRequest = Shapes::StructureShape.new(name: 'PutMethodRequest')
|
@@ -221,6 +229,7 @@ module Aws::APIGateway
|
|
221
229
|
UpdateDocumentationPartRequest = Shapes::StructureShape.new(name: 'UpdateDocumentationPartRequest')
|
222
230
|
UpdateDocumentationVersionRequest = Shapes::StructureShape.new(name: 'UpdateDocumentationVersionRequest')
|
223
231
|
UpdateDomainNameRequest = Shapes::StructureShape.new(name: 'UpdateDomainNameRequest')
|
232
|
+
UpdateGatewayResponseRequest = Shapes::StructureShape.new(name: 'UpdateGatewayResponseRequest')
|
224
233
|
UpdateIntegrationRequest = Shapes::StructureShape.new(name: 'UpdateIntegrationRequest')
|
225
234
|
UpdateIntegrationResponseRequest = Shapes::StructureShape.new(name: 'UpdateIntegrationResponseRequest')
|
226
235
|
UpdateMethodRequest = Shapes::StructureShape.new(name: 'UpdateMethodRequest')
|
@@ -435,6 +444,10 @@ module Aws::APIGateway
|
|
435
444
|
DeleteDomainNameRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "domain_name"))
|
436
445
|
DeleteDomainNameRequest.struct_class = Types::DeleteDomainNameRequest
|
437
446
|
|
447
|
+
DeleteGatewayResponseRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
448
|
+
DeleteGatewayResponseRequest.add_member(:response_type, Shapes::ShapeRef.new(shape: GatewayResponseType, required: true, location: "uri", location_name: "response_type"))
|
449
|
+
DeleteGatewayResponseRequest.struct_class = Types::DeleteGatewayResponseRequest
|
450
|
+
|
438
451
|
DeleteIntegrationRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
439
452
|
DeleteIntegrationRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "resource_id"))
|
440
453
|
DeleteIntegrationRequest.add_member(:http_method, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "http_method"))
|
@@ -548,6 +561,17 @@ module Aws::APIGateway
|
|
548
561
|
FlushStageCacheRequest.add_member(:stage_name, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "stage_name"))
|
549
562
|
FlushStageCacheRequest.struct_class = Types::FlushStageCacheRequest
|
550
563
|
|
564
|
+
GatewayResponse.add_member(:response_type, Shapes::ShapeRef.new(shape: GatewayResponseType, location_name: "responseType"))
|
565
|
+
GatewayResponse.add_member(:status_code, Shapes::ShapeRef.new(shape: StatusCode, location_name: "statusCode"))
|
566
|
+
GatewayResponse.add_member(:response_parameters, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "responseParameters"))
|
567
|
+
GatewayResponse.add_member(:response_templates, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "responseTemplates"))
|
568
|
+
GatewayResponse.add_member(:default_response, Shapes::ShapeRef.new(shape: Boolean, location_name: "defaultResponse"))
|
569
|
+
GatewayResponse.struct_class = Types::GatewayResponse
|
570
|
+
|
571
|
+
GatewayResponses.add_member(:position, Shapes::ShapeRef.new(shape: String, location_name: "position"))
|
572
|
+
GatewayResponses.add_member(:items, Shapes::ShapeRef.new(shape: ListOfGatewayResponse, location_name: "item"))
|
573
|
+
GatewayResponses.struct_class = Types::GatewayResponses
|
574
|
+
|
551
575
|
GenerateClientCertificateRequest.add_member(:description, Shapes::ShapeRef.new(shape: String, location_name: "description"))
|
552
576
|
GenerateClientCertificateRequest.struct_class = Types::GenerateClientCertificateRequest
|
553
577
|
|
@@ -634,6 +658,15 @@ module Aws::APIGateway
|
|
634
658
|
GetExportRequest.add_member(:accepts, Shapes::ShapeRef.new(shape: String, location: "header", location_name: "Accept"))
|
635
659
|
GetExportRequest.struct_class = Types::GetExportRequest
|
636
660
|
|
661
|
+
GetGatewayResponseRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
662
|
+
GetGatewayResponseRequest.add_member(:response_type, Shapes::ShapeRef.new(shape: GatewayResponseType, required: true, location: "uri", location_name: "response_type"))
|
663
|
+
GetGatewayResponseRequest.struct_class = Types::GetGatewayResponseRequest
|
664
|
+
|
665
|
+
GetGatewayResponsesRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
666
|
+
GetGatewayResponsesRequest.add_member(:position, Shapes::ShapeRef.new(shape: String, location: "querystring", location_name: "position"))
|
667
|
+
GetGatewayResponsesRequest.add_member(:limit, Shapes::ShapeRef.new(shape: NullableInteger, location: "querystring", location_name: "limit"))
|
668
|
+
GetGatewayResponsesRequest.struct_class = Types::GetGatewayResponsesRequest
|
669
|
+
|
637
670
|
GetIntegrationRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
638
671
|
GetIntegrationRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "resource_id"))
|
639
672
|
GetIntegrationRequest.add_member(:http_method, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "http_method"))
|
@@ -806,6 +839,8 @@ module Aws::APIGateway
|
|
806
839
|
|
807
840
|
ListOfDomainName.member = Shapes::ShapeRef.new(shape: DomainName)
|
808
841
|
|
842
|
+
ListOfGatewayResponse.member = Shapes::ShapeRef.new(shape: GatewayResponse)
|
843
|
+
|
809
844
|
ListOfLong.member = Shapes::ShapeRef.new(shape: Long)
|
810
845
|
|
811
846
|
ListOfModel.member = Shapes::ShapeRef.new(shape: Model)
|
@@ -917,6 +952,13 @@ module Aws::APIGateway
|
|
917
952
|
PathToMapOfMethodSnapshot.key = Shapes::ShapeRef.new(shape: String)
|
918
953
|
PathToMapOfMethodSnapshot.value = Shapes::ShapeRef.new(shape: MapOfMethodSnapshot)
|
919
954
|
|
955
|
+
PutGatewayResponseRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
956
|
+
PutGatewayResponseRequest.add_member(:response_type, Shapes::ShapeRef.new(shape: GatewayResponseType, required: true, location: "uri", location_name: "response_type"))
|
957
|
+
PutGatewayResponseRequest.add_member(:status_code, Shapes::ShapeRef.new(shape: StatusCode, location_name: "statusCode"))
|
958
|
+
PutGatewayResponseRequest.add_member(:response_parameters, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "responseParameters"))
|
959
|
+
PutGatewayResponseRequest.add_member(:response_templates, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "responseTemplates"))
|
960
|
+
PutGatewayResponseRequest.struct_class = Types::PutGatewayResponseRequest
|
961
|
+
|
920
962
|
PutIntegrationRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
921
963
|
PutIntegrationRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "resource_id"))
|
922
964
|
PutIntegrationRequest.add_member(:http_method, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "http_method"))
|
@@ -1137,6 +1179,11 @@ module Aws::APIGateway
|
|
1137
1179
|
UpdateDomainNameRequest.add_member(:patch_operations, Shapes::ShapeRef.new(shape: ListOfPatchOperation, location_name: "patchOperations"))
|
1138
1180
|
UpdateDomainNameRequest.struct_class = Types::UpdateDomainNameRequest
|
1139
1181
|
|
1182
|
+
UpdateGatewayResponseRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
1183
|
+
UpdateGatewayResponseRequest.add_member(:response_type, Shapes::ShapeRef.new(shape: GatewayResponseType, required: true, location: "uri", location_name: "response_type"))
|
1184
|
+
UpdateGatewayResponseRequest.add_member(:patch_operations, Shapes::ShapeRef.new(shape: ListOfPatchOperation, location_name: "patchOperations"))
|
1185
|
+
UpdateGatewayResponseRequest.struct_class = Types::UpdateGatewayResponseRequest
|
1186
|
+
|
1140
1187
|
UpdateIntegrationRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
1141
1188
|
UpdateIntegrationRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "resource_id"))
|
1142
1189
|
UpdateIntegrationRequest.add_member(:http_method, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "http_method"))
|
@@ -1524,6 +1571,19 @@ module Aws::APIGateway
|
|
1524
1571
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1525
1572
|
end)
|
1526
1573
|
|
1574
|
+
api.add_operation(:delete_gateway_response, Seahorse::Model::Operation.new.tap do |o|
|
1575
|
+
o.name = "DeleteGatewayResponse"
|
1576
|
+
o.http_method = "DELETE"
|
1577
|
+
o.http_request_uri = "/restapis/{restapi_id}/gatewayresponses/{response_type}"
|
1578
|
+
o.input = Shapes::ShapeRef.new(shape: DeleteGatewayResponseRequest)
|
1579
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1580
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
1581
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1582
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1583
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1584
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1585
|
+
end)
|
1586
|
+
|
1527
1587
|
api.add_operation(:delete_integration, Seahorse::Model::Operation.new.tap do |o|
|
1528
1588
|
o.name = "DeleteIntegration"
|
1529
1589
|
o.http_method = "DELETE"
|
@@ -1929,6 +1989,30 @@ module Aws::APIGateway
|
|
1929
1989
|
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
1930
1990
|
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1931
1991
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1992
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1993
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1994
|
+
end)
|
1995
|
+
|
1996
|
+
api.add_operation(:get_gateway_response, Seahorse::Model::Operation.new.tap do |o|
|
1997
|
+
o.name = "GetGatewayResponse"
|
1998
|
+
o.http_method = "GET"
|
1999
|
+
o.http_request_uri = "/restapis/{restapi_id}/gatewayresponses/{response_type}"
|
2000
|
+
o.input = Shapes::ShapeRef.new(shape: GetGatewayResponseRequest)
|
2001
|
+
o.output = Shapes::ShapeRef.new(shape: GatewayResponse)
|
2002
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
2003
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
2004
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
2005
|
+
end)
|
2006
|
+
|
2007
|
+
api.add_operation(:get_gateway_responses, Seahorse::Model::Operation.new.tap do |o|
|
2008
|
+
o.name = "GetGatewayResponses"
|
2009
|
+
o.http_method = "GET"
|
2010
|
+
o.http_request_uri = "/restapis/{restapi_id}/gatewayresponses"
|
2011
|
+
o.input = Shapes::ShapeRef.new(shape: GetGatewayResponsesRequest)
|
2012
|
+
o.output = Shapes::ShapeRef.new(shape: GatewayResponses)
|
2013
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
2014
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
2015
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1932
2016
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1933
2017
|
end)
|
1934
2018
|
|
@@ -2106,6 +2190,7 @@ module Aws::APIGateway
|
|
2106
2190
|
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
2107
2191
|
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
2108
2192
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
2193
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
2109
2194
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
2110
2195
|
end)
|
2111
2196
|
|
@@ -2271,6 +2356,19 @@ module Aws::APIGateway
|
|
2271
2356
|
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
2272
2357
|
end)
|
2273
2358
|
|
2359
|
+
api.add_operation(:put_gateway_response, Seahorse::Model::Operation.new.tap do |o|
|
2360
|
+
o.name = "PutGatewayResponse"
|
2361
|
+
o.http_method = "PUT"
|
2362
|
+
o.http_request_uri = "/restapis/{restapi_id}/gatewayresponses/{response_type}"
|
2363
|
+
o.input = Shapes::ShapeRef.new(shape: PutGatewayResponseRequest)
|
2364
|
+
o.output = Shapes::ShapeRef.new(shape: GatewayResponse)
|
2365
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
2366
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
2367
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
2368
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
2369
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
2370
|
+
end)
|
2371
|
+
|
2274
2372
|
api.add_operation(:put_integration, Seahorse::Model::Operation.new.tap do |o|
|
2275
2373
|
o.name = "PutIntegration"
|
2276
2374
|
o.http_method = "PUT"
|
@@ -2479,6 +2577,18 @@ module Aws::APIGateway
|
|
2479
2577
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
2480
2578
|
end)
|
2481
2579
|
|
2580
|
+
api.add_operation(:update_gateway_response, Seahorse::Model::Operation.new.tap do |o|
|
2581
|
+
o.name = "UpdateGatewayResponse"
|
2582
|
+
o.http_method = "PATCH"
|
2583
|
+
o.http_request_uri = "/restapis/{restapi_id}/gatewayresponses/{response_type}"
|
2584
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateGatewayResponseRequest)
|
2585
|
+
o.output = Shapes::ShapeRef.new(shape: GatewayResponse)
|
2586
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
2587
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
2588
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
2589
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
2590
|
+
end)
|
2591
|
+
|
2482
2592
|
api.add_operation(:update_integration, Seahorse::Model::Operation.new.tap do |o|
|
2483
2593
|
o.name = "UpdateIntegration"
|
2484
2594
|
o.http_method = "PATCH"
|
@@ -178,8 +178,7 @@ module Aws::APIGateway
|
|
178
178
|
# @return [String]
|
179
179
|
#
|
180
180
|
# @!attribute [rw] items
|
181
|
-
# The current page of
|
182
|
-
# resources.
|
181
|
+
# The current page of elements from this collection.
|
183
182
|
# @return [Array<Types::ApiKey>]
|
184
183
|
#
|
185
184
|
class ApiKeys < Struct.new(
|
@@ -325,7 +324,7 @@ module Aws::APIGateway
|
|
325
324
|
# @return [String]
|
326
325
|
#
|
327
326
|
# @!attribute [rw] items
|
328
|
-
#
|
327
|
+
# The current page of elements from this collection.
|
329
328
|
# @return [Array<Types::Authorizer>]
|
330
329
|
#
|
331
330
|
class Authorizers < Struct.new(
|
@@ -356,11 +355,11 @@ module Aws::APIGateway
|
|
356
355
|
# @return [String]
|
357
356
|
#
|
358
357
|
# @!attribute [rw] rest_api_id
|
359
|
-
# The
|
358
|
+
# The string identifier of the associated RestApi.
|
360
359
|
# @return [String]
|
361
360
|
#
|
362
361
|
# @!attribute [rw] stage
|
363
|
-
# The name of the
|
362
|
+
# The name of the associated stage.
|
364
363
|
# @return [String]
|
365
364
|
#
|
366
365
|
class BasePathMapping < Struct.new(
|
@@ -384,8 +383,7 @@ module Aws::APIGateway
|
|
384
383
|
# @return [String]
|
385
384
|
#
|
386
385
|
# @!attribute [rw] items
|
387
|
-
# The current page of
|
388
|
-
# of base path mapping resources.
|
386
|
+
# The current page of elements from this collection.
|
389
387
|
# @return [Array<Types::BasePathMapping>]
|
390
388
|
#
|
391
389
|
class BasePathMappings < Struct.new(
|
@@ -456,8 +454,7 @@ module Aws::APIGateway
|
|
456
454
|
# @return [String]
|
457
455
|
#
|
458
456
|
# @!attribute [rw] items
|
459
|
-
# The current page of
|
460
|
-
# collection of ClientCertificate resources.
|
457
|
+
# The current page of elements from this collection.
|
461
458
|
# @return [Array<Types::ClientCertificate>]
|
462
459
|
#
|
463
460
|
class ClientCertificates < Struct.new(
|
@@ -547,7 +544,7 @@ module Aws::APIGateway
|
|
547
544
|
# }
|
548
545
|
#
|
549
546
|
# @!attribute [rw] rest_api_id
|
550
|
-
# The
|
547
|
+
# The string identifier of the associated RestApi.
|
551
548
|
# @return [String]
|
552
549
|
#
|
553
550
|
# @!attribute [rw] name
|
@@ -626,7 +623,7 @@ module Aws::APIGateway
|
|
626
623
|
# @return [String]
|
627
624
|
#
|
628
625
|
# @!attribute [rw] rest_api_id
|
629
|
-
# The
|
626
|
+
# The string identifier of the associated RestApi.
|
630
627
|
# @return [String]
|
631
628
|
#
|
632
629
|
# @!attribute [rw] stage
|
@@ -661,8 +658,7 @@ module Aws::APIGateway
|
|
661
658
|
# }
|
662
659
|
#
|
663
660
|
# @!attribute [rw] rest_api_id
|
664
|
-
# The
|
665
|
-
# create.
|
661
|
+
# The string identifier of the associated RestApi.
|
666
662
|
# @return [String]
|
667
663
|
#
|
668
664
|
# @!attribute [rw] stage_name
|
@@ -725,8 +721,7 @@ module Aws::APIGateway
|
|
725
721
|
# }
|
726
722
|
#
|
727
723
|
# @!attribute [rw] rest_api_id
|
728
|
-
# \[Required\] The identifier of
|
729
|
-
# documentation part.
|
724
|
+
# \[Required\] The string identifier of the associated RestApi.
|
730
725
|
# @return [String]
|
731
726
|
#
|
732
727
|
# @!attribute [rw] location
|
@@ -761,8 +756,7 @@ module Aws::APIGateway
|
|
761
756
|
# }
|
762
757
|
#
|
763
758
|
# @!attribute [rw] rest_api_id
|
764
|
-
# \[Required\]
|
765
|
-
# documentation version.
|
759
|
+
# \[Required\] The string identifier of the associated RestApi.
|
766
760
|
# @return [String]
|
767
761
|
#
|
768
762
|
# @!attribute [rw] documentation_version
|
@@ -901,8 +895,7 @@ module Aws::APIGateway
|
|
901
895
|
# }
|
902
896
|
#
|
903
897
|
# @!attribute [rw] rest_api_id
|
904
|
-
#
|
905
|
-
# RequestValidator is created.
|
898
|
+
# The string identifier of the associated RestApi.
|
906
899
|
# @return [String]
|
907
900
|
#
|
908
901
|
# @!attribute [rw] name
|
@@ -940,7 +933,7 @@ module Aws::APIGateway
|
|
940
933
|
# }
|
941
934
|
#
|
942
935
|
# @!attribute [rw] rest_api_id
|
943
|
-
# The identifier of the RestApi
|
936
|
+
# The string identifier of the associated RestApi.
|
944
937
|
# @return [String]
|
945
938
|
#
|
946
939
|
# @!attribute [rw] parent_id
|
@@ -1020,8 +1013,7 @@ module Aws::APIGateway
|
|
1020
1013
|
# }
|
1021
1014
|
#
|
1022
1015
|
# @!attribute [rw] rest_api_id
|
1023
|
-
# The identifier of the RestApi
|
1024
|
-
# create.
|
1016
|
+
# The string identifier of the associated RestApi.
|
1025
1017
|
# @return [String]
|
1026
1018
|
#
|
1027
1019
|
# @!attribute [rw] stage_name
|
@@ -1184,7 +1176,7 @@ module Aws::APIGateway
|
|
1184
1176
|
# }
|
1185
1177
|
#
|
1186
1178
|
# @!attribute [rw] rest_api_id
|
1187
|
-
# The
|
1179
|
+
# The string identifier of the associated RestApi.
|
1188
1180
|
# @return [String]
|
1189
1181
|
#
|
1190
1182
|
# @!attribute [rw] authorizer_id
|
@@ -1250,8 +1242,7 @@ module Aws::APIGateway
|
|
1250
1242
|
# }
|
1251
1243
|
#
|
1252
1244
|
# @!attribute [rw] rest_api_id
|
1253
|
-
# The identifier of the RestApi
|
1254
|
-
# to delete.
|
1245
|
+
# The string identifier of the associated RestApi.
|
1255
1246
|
# @return [String]
|
1256
1247
|
#
|
1257
1248
|
# @!attribute [rw] deployment_id
|
@@ -1275,8 +1266,7 @@ module Aws::APIGateway
|
|
1275
1266
|
# }
|
1276
1267
|
#
|
1277
1268
|
# @!attribute [rw] rest_api_id
|
1278
|
-
# \[Required\]
|
1279
|
-
# documentation part.
|
1269
|
+
# \[Required\] The string identifier of the associated RestApi.
|
1280
1270
|
# @return [String]
|
1281
1271
|
#
|
1282
1272
|
# @!attribute [rw] documentation_part_id
|
@@ -1300,8 +1290,7 @@ module Aws::APIGateway
|
|
1300
1290
|
# }
|
1301
1291
|
#
|
1302
1292
|
# @!attribute [rw] rest_api_id
|
1303
|
-
# \[Required\] The identifier of
|
1304
|
-
# documentation snapshot.
|
1293
|
+
# \[Required\] The string identifier of the associated RestApi.
|
1305
1294
|
# @return [String]
|
1306
1295
|
#
|
1307
1296
|
# @!attribute [rw] documentation_version
|
@@ -1333,6 +1322,51 @@ module Aws::APIGateway
|
|
1333
1322
|
include Aws::Structure
|
1334
1323
|
end
|
1335
1324
|
|
1325
|
+
# Clears any customization of a GatewayResponse of a specified response
|
1326
|
+
# type on the given RestApi and resets it with the default settings.
|
1327
|
+
#
|
1328
|
+
# @note When making an API call, you may pass DeleteGatewayResponseRequest
|
1329
|
+
# data as a hash:
|
1330
|
+
#
|
1331
|
+
# {
|
1332
|
+
# rest_api_id: "String", # required
|
1333
|
+
# 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
|
1334
|
+
# }
|
1335
|
+
#
|
1336
|
+
# @!attribute [rw] rest_api_id
|
1337
|
+
# The string identifier of the associated RestApi.
|
1338
|
+
# @return [String]
|
1339
|
+
#
|
1340
|
+
# @!attribute [rw] response_type
|
1341
|
+
# The response type of the associated GatewayResponse. Valid values
|
1342
|
+
# are * ACCESS\_DENIED
|
1343
|
+
# * API\_CONFIGURATION\_ERROR
|
1344
|
+
# * AUTHORIZER\_FAILURE
|
1345
|
+
# * AUTHORIZER\_CONFIGURATION\_ERROR
|
1346
|
+
# * BAD\_REQUEST\_PARAMETERS
|
1347
|
+
# * BAD\_REQUEST\_BODY
|
1348
|
+
# * DEFAULT\_4XX
|
1349
|
+
# * DEFAULT\_5XX
|
1350
|
+
# * EXPIRED\_TOKEN
|
1351
|
+
# * INVALID\_SIGNATURE
|
1352
|
+
# * INTEGRATION\_FAILURE
|
1353
|
+
# * INTEGRATION\_TIMEOUT
|
1354
|
+
# * INVALID\_API\_KEY
|
1355
|
+
# * MISSING\_AUTHENTICATION\_TOKEN
|
1356
|
+
# * QUOTA\_EXCEEDED
|
1357
|
+
# * REQUEST\_TOO\_LARGE
|
1358
|
+
# * RESOURCE\_NOT\_FOUND
|
1359
|
+
# * THROTTLED
|
1360
|
+
# * UNAUTHORIZED
|
1361
|
+
# * UNSUPPORTED\_MEDIA\_TYPES
|
1362
|
+
# @return [String]
|
1363
|
+
#
|
1364
|
+
class DeleteGatewayResponseRequest < Struct.new(
|
1365
|
+
:rest_api_id,
|
1366
|
+
:response_type)
|
1367
|
+
include Aws::Structure
|
1368
|
+
end
|
1369
|
+
|
1336
1370
|
# Represents a delete integration request.
|
1337
1371
|
#
|
1338
1372
|
# @note When making an API call, you may pass DeleteIntegrationRequest
|
@@ -1345,7 +1379,7 @@ module Aws::APIGateway
|
|
1345
1379
|
# }
|
1346
1380
|
#
|
1347
1381
|
# @!attribute [rw] rest_api_id
|
1348
|
-
#
|
1382
|
+
# The string identifier of the associated RestApi.
|
1349
1383
|
# @return [String]
|
1350
1384
|
#
|
1351
1385
|
# @!attribute [rw] resource_id
|
@@ -1376,7 +1410,7 @@ module Aws::APIGateway
|
|
1376
1410
|
# }
|
1377
1411
|
#
|
1378
1412
|
# @!attribute [rw] rest_api_id
|
1379
|
-
#
|
1413
|
+
# The string identifier of the associated RestApi.
|
1380
1414
|
# @return [String]
|
1381
1415
|
#
|
1382
1416
|
# @!attribute [rw] resource_id
|
@@ -1412,7 +1446,7 @@ module Aws::APIGateway
|
|
1412
1446
|
# }
|
1413
1447
|
#
|
1414
1448
|
# @!attribute [rw] rest_api_id
|
1415
|
-
# The
|
1449
|
+
# The string identifier of the associated RestApi.
|
1416
1450
|
# @return [String]
|
1417
1451
|
#
|
1418
1452
|
# @!attribute [rw] resource_id
|
@@ -1443,7 +1477,7 @@ module Aws::APIGateway
|
|
1443
1477
|
# }
|
1444
1478
|
#
|
1445
1479
|
# @!attribute [rw] rest_api_id
|
1446
|
-
# The
|
1480
|
+
# The string identifier of the associated RestApi.
|
1447
1481
|
# @return [String]
|
1448
1482
|
#
|
1449
1483
|
# @!attribute [rw] resource_id
|
@@ -1477,7 +1511,7 @@ module Aws::APIGateway
|
|
1477
1511
|
# }
|
1478
1512
|
#
|
1479
1513
|
# @!attribute [rw] rest_api_id
|
1480
|
-
# The
|
1514
|
+
# The string identifier of the associated RestApi.
|
1481
1515
|
# @return [String]
|
1482
1516
|
#
|
1483
1517
|
# @!attribute [rw] model_name
|
@@ -1501,8 +1535,7 @@ module Aws::APIGateway
|
|
1501
1535
|
# }
|
1502
1536
|
#
|
1503
1537
|
# @!attribute [rw] rest_api_id
|
1504
|
-
#
|
1505
|
-
# RequestValidator is deleted.
|
1538
|
+
# The string identifier of the associated RestApi.
|
1506
1539
|
# @return [String]
|
1507
1540
|
#
|
1508
1541
|
# @!attribute [rw] request_validator_id
|
@@ -1526,7 +1559,7 @@ module Aws::APIGateway
|
|
1526
1559
|
# }
|
1527
1560
|
#
|
1528
1561
|
# @!attribute [rw] rest_api_id
|
1529
|
-
# The
|
1562
|
+
# The string identifier of the associated RestApi.
|
1530
1563
|
# @return [String]
|
1531
1564
|
#
|
1532
1565
|
# @!attribute [rw] resource_id
|
@@ -1549,7 +1582,7 @@ module Aws::APIGateway
|
|
1549
1582
|
# }
|
1550
1583
|
#
|
1551
1584
|
# @!attribute [rw] rest_api_id
|
1552
|
-
# The
|
1585
|
+
# The string identifier of the associated RestApi.
|
1553
1586
|
# @return [String]
|
1554
1587
|
#
|
1555
1588
|
class DeleteRestApiRequest < Struct.new(
|
@@ -1568,8 +1601,7 @@ module Aws::APIGateway
|
|
1568
1601
|
# }
|
1569
1602
|
#
|
1570
1603
|
# @!attribute [rw] rest_api_id
|
1571
|
-
# The identifier of the RestApi
|
1572
|
-
# delete.
|
1604
|
+
# The string identifier of the associated RestApi.
|
1573
1605
|
# @return [String]
|
1574
1606
|
#
|
1575
1607
|
# @!attribute [rw] stage_name
|
@@ -1609,7 +1641,7 @@ module Aws::APIGateway
|
|
1609
1641
|
include Aws::Structure
|
1610
1642
|
end
|
1611
1643
|
|
1612
|
-
# The DELETE request to delete a
|
1644
|
+
# The DELETE request to delete a usage plan of a given plan Id.
|
1613
1645
|
#
|
1614
1646
|
# @note When making an API call, you may pass DeleteUsagePlanRequest
|
1615
1647
|
# data as a hash:
|
@@ -1698,8 +1730,7 @@ module Aws::APIGateway
|
|
1698
1730
|
# @return [String]
|
1699
1731
|
#
|
1700
1732
|
# @!attribute [rw] items
|
1701
|
-
# The current page of
|
1702
|
-
# deployment resources.
|
1733
|
+
# The current page of elements from this collection.
|
1703
1734
|
# @return [Array<Types::Deployment>]
|
1704
1735
|
#
|
1705
1736
|
class Deployments < Struct.new(
|
@@ -1888,8 +1919,7 @@ module Aws::APIGateway
|
|
1888
1919
|
# @return [String]
|
1889
1920
|
#
|
1890
1921
|
# @!attribute [rw] items
|
1891
|
-
# The current page of
|
1892
|
-
# DocumentationParts collection.
|
1922
|
+
# The current page of elements from this collection.
|
1893
1923
|
# @return [Array<Types::DocumentationPart>]
|
1894
1924
|
#
|
1895
1925
|
class DocumentationParts < Struct.new(
|
@@ -1954,8 +1984,7 @@ module Aws::APIGateway
|
|
1954
1984
|
# @return [String]
|
1955
1985
|
#
|
1956
1986
|
# @!attribute [rw] items
|
1957
|
-
# The current page of
|
1958
|
-
# DocumentationVersions collection of an API.
|
1987
|
+
# The current page of elements from this collection.
|
1959
1988
|
# @return [Array<Types::DocumentationVersion>]
|
1960
1989
|
#
|
1961
1990
|
class DocumentationVersions < Struct.new(
|
@@ -2024,8 +2053,7 @@ module Aws::APIGateway
|
|
2024
2053
|
# @return [String]
|
2025
2054
|
#
|
2026
2055
|
# @!attribute [rw] items
|
2027
|
-
# The current page of
|
2028
|
-
# DomainName resources.
|
2056
|
+
# The current page of elements from this collection.
|
2029
2057
|
# @return [Array<Types::DomainName>]
|
2030
2058
|
#
|
2031
2059
|
class DomainNames < Struct.new(
|
@@ -2068,7 +2096,7 @@ module Aws::APIGateway
|
|
2068
2096
|
# }
|
2069
2097
|
#
|
2070
2098
|
# @!attribute [rw] rest_api_id
|
2071
|
-
# The
|
2099
|
+
# The string identifier of the associated RestApi.
|
2072
2100
|
# @return [String]
|
2073
2101
|
#
|
2074
2102
|
# @!attribute [rw] stage_name
|
@@ -2092,7 +2120,7 @@ module Aws::APIGateway
|
|
2092
2120
|
# }
|
2093
2121
|
#
|
2094
2122
|
# @!attribute [rw] rest_api_id
|
2095
|
-
# The
|
2123
|
+
# The string identifier of the associated RestApi.
|
2096
2124
|
# @return [String]
|
2097
2125
|
#
|
2098
2126
|
# @!attribute [rw] stage_name
|
@@ -2105,6 +2133,152 @@ module Aws::APIGateway
|
|
2105
2133
|
include Aws::Structure
|
2106
2134
|
end
|
2107
2135
|
|
2136
|
+
# A gateway response of a given response type and status code, with
|
2137
|
+
# optional response parameters and mapping templates.
|
2138
|
+
#
|
2139
|
+
# <div class="remarks">
|
2140
|
+
# For more information about valid gateway response types, see [Gateway
|
2141
|
+
# Response Types Supported by Amazon API Gateway][1]
|
2142
|
+
# <div class="example" markdown="1">
|
2143
|
+
# #### Example: Get a Gateway Response of a given response type
|
2144
|
+
#
|
2145
|
+
# ##### Request
|
2146
|
+
#
|
2147
|
+
# This example shows how to get a gateway response of the
|
2148
|
+
# `MISSING_AUTHNETICATION_TOKEN` type.
|
2149
|
+
#
|
2150
|
+
# GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential=\{access-key-id\}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45
|
2151
|
+
#
|
2152
|
+
# The response type is specified as a URL path.
|
2153
|
+
#
|
2154
|
+
# ##### Response
|
2155
|
+
#
|
2156
|
+
# The successful operation returns the `200 OK` status code and a
|
2157
|
+
# payload similar to the following:
|
2158
|
+
#
|
2159
|
+
# \{ "_links": \{ "curies": \{ "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-\{rel\}.html", "name": "gatewayresponse", "templated": true \}, "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" \}, "gatewayresponse:delete": \{ "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" \} \}, "defaultResponse": false, "responseParameters": \{ "gatewayresponse.header.x-request-path": "method.request.path.petId", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-query": "method.request.querystring.q", "gatewayresponse.header.x-request-header": "method.request.header.Accept" \}, "responseTemplates": \{ "application/json": "\{\n "message": $context.error.messageString,\n "type": "$context.error.responseType",\n "stage": "$context.stage",\n "resourcePath": "$context.resourcePath",\n "stageVariables.a": "$stageVariables.a",\n "statusCode": "'404'"\n\}" \}, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "404" \}
|
2160
|
+
#
|
2161
|
+
#
|
2162
|
+
#
|
2163
|
+
# </div>
|
2164
|
+
# </div>
|
2165
|
+
#
|
2166
|
+
# <div class="seeAlso">
|
2167
|
+
# [Customize Gateway Responses][2]
|
2168
|
+
# </div>
|
2169
|
+
#
|
2170
|
+
#
|
2171
|
+
#
|
2172
|
+
# [1]: http://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html
|
2173
|
+
# [2]: http://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html
|
2174
|
+
#
|
2175
|
+
# @!attribute [rw] response_type
|
2176
|
+
# The response type of the associated GatewayResponse. Valid values
|
2177
|
+
# are * ACCESS\_DENIED
|
2178
|
+
# * API\_CONFIGURATION\_ERROR
|
2179
|
+
# * AUTHORIZER\_FAILURE
|
2180
|
+
# * AUTHORIZER\_CONFIGURATION\_ERROR
|
2181
|
+
# * BAD\_REQUEST\_PARAMETERS
|
2182
|
+
# * BAD\_REQUEST\_BODY
|
2183
|
+
# * DEFAULT\_4XX
|
2184
|
+
# * DEFAULT\_5XX
|
2185
|
+
# * EXPIRED\_TOKEN
|
2186
|
+
# * INVALID\_SIGNATURE
|
2187
|
+
# * INTEGRATION\_FAILURE
|
2188
|
+
# * INTEGRATION\_TIMEOUT
|
2189
|
+
# * INVALID\_API\_KEY
|
2190
|
+
# * MISSING\_AUTHENTICATION\_TOKEN
|
2191
|
+
# * QUOTA\_EXCEEDED
|
2192
|
+
# * REQUEST\_TOO\_LARGE
|
2193
|
+
# * RESOURCE\_NOT\_FOUND
|
2194
|
+
# * THROTTLED
|
2195
|
+
# * UNAUTHORIZED
|
2196
|
+
# * UNSUPPORTED\_MEDIA\_TYPES
|
2197
|
+
# @return [String]
|
2198
|
+
#
|
2199
|
+
# @!attribute [rw] status_code
|
2200
|
+
# The HTTP status code for this GatewayResponse.
|
2201
|
+
# @return [String]
|
2202
|
+
#
|
2203
|
+
# @!attribute [rw] response_parameters
|
2204
|
+
# Response parameters (paths, query strings and headers) of the
|
2205
|
+
# GatewayResponse as a string-to-string map of key-value pairs.
|
2206
|
+
# @return [Hash<String,String>]
|
2207
|
+
#
|
2208
|
+
# @!attribute [rw] response_templates
|
2209
|
+
# Response templates of the GatewayResponse as a string-to-string map
|
2210
|
+
# of key-value pairs.
|
2211
|
+
# @return [Hash<String,String>]
|
2212
|
+
#
|
2213
|
+
# @!attribute [rw] default_response
|
2214
|
+
# A Boolean flag to indicate whether this GatewayResponse is the
|
2215
|
+
# default gateway response (`true`) or not (`false`). A default
|
2216
|
+
# gateway response is one generated by Amazon API Gateway without any
|
2217
|
+
# customization by an API developer.
|
2218
|
+
# @return [Boolean]
|
2219
|
+
#
|
2220
|
+
class GatewayResponse < Struct.new(
|
2221
|
+
:response_type,
|
2222
|
+
:status_code,
|
2223
|
+
:response_parameters,
|
2224
|
+
:response_templates,
|
2225
|
+
:default_response)
|
2226
|
+
include Aws::Structure
|
2227
|
+
end
|
2228
|
+
|
2229
|
+
# The collection of the GatewayResponse instances of a RestApi as a
|
2230
|
+
# `responseType`-to-GatewayResponse object map of key-value pairs. As
|
2231
|
+
# such, pagination is not supported for querying this collection.
|
2232
|
+
#
|
2233
|
+
# <div class="remarks">
|
2234
|
+
# For more information about valid gateway response types, see [Gateway
|
2235
|
+
# Response Types Supported by Amazon API Gateway][1]
|
2236
|
+
# <div class="example" markdown="1">
|
2237
|
+
# #### Example: Get the collection of gateway responses of an API
|
2238
|
+
#
|
2239
|
+
# ##### Request
|
2240
|
+
#
|
2241
|
+
# This example request shows how to retrieve the GatewayResponses
|
2242
|
+
# collection from an API.
|
2243
|
+
#
|
2244
|
+
# GET /restapis/o81lxisefl/gatewayresponses HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T220604Z Authorization: AWS4-HMAC-SHA256 Credential=\{access-key-id\}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=59b42fe54a76a5de8adf2c67baa6d39206f8e9ad49a1d77ccc6a5da3103a398a Cache-Control: no-cache Postman-Token: 5637af27-dc29-fc5c-9dfe-0645d52cb515
|
2245
|
+
#
|
2246
|
+
#
|
2247
|
+
#
|
2248
|
+
# ##### Response
|
2249
|
+
#
|
2250
|
+
# The successful operation returns the `200 OK` status code and a
|
2251
|
+
# payload similar to the following:
|
2252
|
+
#
|
2253
|
+
# \{ "_links": \{ "curies": \{ "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-\{rel\}.html", "name": "gatewayresponse", "templated": true \}, "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses" \}, "first": \{ "href": "/restapis/o81lxisefl/gatewayresponses" \}, "gatewayresponse:by-type": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "item": [ \{ "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" \}, \{ "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" \} ] \}, "_embedded": \{ "item": [ \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "INTEGRATION_FAILURE", "statusCode": "504" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "RESOURCE_NOT_FOUND", "statusCode": "404" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "REQUEST_TOO_LARGE", "statusCode": "413" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "THROTTLED", "statusCode": "429" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "UNSUPPORTED_MEDIA_TYPE", "statusCode": "415" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "AUTHORIZER_CONFIGURATION_ERROR", "statusCode": "500" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "DEFAULT_5XX" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "DEFAULT_4XX" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "BAD_REQUEST_PARAMETERS", "statusCode": "400" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "BAD_REQUEST_BODY", "statusCode": "400" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "EXPIRED_TOKEN", "statusCode": "403" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "ACCESS_DENIED", "statusCode": "403" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "INVALID_API_KEY", "statusCode": "403" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "UNAUTHORIZED", "statusCode": "401" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "API_CONFIGURATION_ERROR", "statusCode": "500" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "QUOTA_EXCEEDED", "statusCode": "429" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "INTEGRATION_TIMEOUT", "statusCode": "504" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "403" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "INVALID_SIGNATURE", "statusCode": "403" \}, \{ "_links": \{ "self": \{ "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" \}, "gatewayresponse:put": \{ "href": "/restapis/o81lxisefl/gatewayresponses/\{response_type\}", "templated": true \}, "gatewayresponse:update": \{ "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" \} \}, "defaultResponse": true, "responseParameters": \{\}, "responseTemplates": \{ "application/json": "\{"message":$context.error.messageString\}" \}, "responseType": "AUTHORIZER_FAILURE", "statusCode": "500" \} ] \} \}
|
2254
|
+
#
|
2255
|
+
#
|
2256
|
+
#
|
2257
|
+
# </div>
|
2258
|
+
# </div>
|
2259
|
+
#
|
2260
|
+
# <div class="seeAlso">
|
2261
|
+
# [Customize Gateway Responses][2]
|
2262
|
+
# </div>
|
2263
|
+
#
|
2264
|
+
#
|
2265
|
+
#
|
2266
|
+
# [1]: http://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html
|
2267
|
+
# [2]: http://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html
|
2268
|
+
#
|
2269
|
+
# @!attribute [rw] position
|
2270
|
+
# @return [String]
|
2271
|
+
#
|
2272
|
+
# @!attribute [rw] items
|
2273
|
+
# Returns the entire collection, because of no pagination support.
|
2274
|
+
# @return [Array<Types::GatewayResponse>]
|
2275
|
+
#
|
2276
|
+
class GatewayResponses < Struct.new(
|
2277
|
+
:position,
|
2278
|
+
:items)
|
2279
|
+
include Aws::Structure
|
2280
|
+
end
|
2281
|
+
|
2108
2282
|
# A request to generate a ClientCertificate resource.
|
2109
2283
|
#
|
2110
2284
|
# @note When making an API call, you may pass GenerateClientCertificateRequest
|
@@ -2173,7 +2347,7 @@ module Aws::APIGateway
|
|
2173
2347
|
# @return [String]
|
2174
2348
|
#
|
2175
2349
|
# @!attribute [rw] limit
|
2176
|
-
# The maximum number of
|
2350
|
+
# The maximum number of returned results per page.
|
2177
2351
|
# @return [Integer]
|
2178
2352
|
#
|
2179
2353
|
# @!attribute [rw] name_query
|
@@ -2210,7 +2384,7 @@ module Aws::APIGateway
|
|
2210
2384
|
# }
|
2211
2385
|
#
|
2212
2386
|
# @!attribute [rw] rest_api_id
|
2213
|
-
# The
|
2387
|
+
# The string identifier of the associated RestApi.
|
2214
2388
|
# @return [String]
|
2215
2389
|
#
|
2216
2390
|
# @!attribute [rw] authorizer_id
|
@@ -2235,7 +2409,7 @@ module Aws::APIGateway
|
|
2235
2409
|
# }
|
2236
2410
|
#
|
2237
2411
|
# @!attribute [rw] rest_api_id
|
2238
|
-
# The
|
2412
|
+
# The string identifier of the associated RestApi.
|
2239
2413
|
# @return [String]
|
2240
2414
|
#
|
2241
2415
|
# @!attribute [rw] position
|
@@ -2370,8 +2544,7 @@ module Aws::APIGateway
|
|
2370
2544
|
# }
|
2371
2545
|
#
|
2372
2546
|
# @!attribute [rw] rest_api_id
|
2373
|
-
# The identifier of the RestApi
|
2374
|
-
# to get information about.
|
2547
|
+
# The string identifier of the associated RestApi.
|
2375
2548
|
# @return [String]
|
2376
2549
|
#
|
2377
2550
|
# @!attribute [rw] deployment_id
|
@@ -2412,8 +2585,7 @@ module Aws::APIGateway
|
|
2412
2585
|
# }
|
2413
2586
|
#
|
2414
2587
|
# @!attribute [rw] rest_api_id
|
2415
|
-
# The identifier of the RestApi
|
2416
|
-
# Deployment resources to get information about.
|
2588
|
+
# The string identifier of the associated RestApi.
|
2417
2589
|
# @return [String]
|
2418
2590
|
#
|
2419
2591
|
# @!attribute [rw] position
|
@@ -2443,13 +2615,11 @@ module Aws::APIGateway
|
|
2443
2615
|
# }
|
2444
2616
|
#
|
2445
2617
|
# @!attribute [rw] rest_api_id
|
2446
|
-
# \[Required\] The identifier of
|
2447
|
-
# documentation part.
|
2618
|
+
# \[Required\] The string identifier of the associated RestApi.
|
2448
2619
|
# @return [String]
|
2449
2620
|
#
|
2450
2621
|
# @!attribute [rw] documentation_part_id
|
2451
|
-
# \[Required\] The identifier of the
|
2452
|
-
# part.
|
2622
|
+
# \[Required\] The string identifier of the associated RestApi.
|
2453
2623
|
# @return [String]
|
2454
2624
|
#
|
2455
2625
|
class GetDocumentationPartRequest < Struct.new(
|
@@ -2474,8 +2644,7 @@ module Aws::APIGateway
|
|
2474
2644
|
# }
|
2475
2645
|
#
|
2476
2646
|
# @!attribute [rw] rest_api_id
|
2477
|
-
# \[Required\] The identifier of the
|
2478
|
-
# documentation parts.
|
2647
|
+
# \[Required\] The string identifier of the associated RestApi.
|
2479
2648
|
# @return [String]
|
2480
2649
|
#
|
2481
2650
|
# @!attribute [rw] type
|
@@ -2519,8 +2688,7 @@ module Aws::APIGateway
|
|
2519
2688
|
# }
|
2520
2689
|
#
|
2521
2690
|
# @!attribute [rw] rest_api_id
|
2522
|
-
# \[Required\] The identifier of the
|
2523
|
-
# documentation snapshot.
|
2691
|
+
# \[Required\] The string identifier of the associated RestApi.
|
2524
2692
|
# @return [String]
|
2525
2693
|
#
|
2526
2694
|
# @!attribute [rw] documentation_version
|
@@ -2546,8 +2714,7 @@ module Aws::APIGateway
|
|
2546
2714
|
# }
|
2547
2715
|
#
|
2548
2716
|
# @!attribute [rw] rest_api_id
|
2549
|
-
# \[Required\] The identifier of
|
2550
|
-
# documentation versions.
|
2717
|
+
# \[Required\] The string identifier of the associated RestApi.
|
2551
2718
|
# @return [String]
|
2552
2719
|
#
|
2553
2720
|
# @!attribute [rw] position
|
@@ -2624,7 +2791,7 @@ module Aws::APIGateway
|
|
2624
2791
|
# }
|
2625
2792
|
#
|
2626
2793
|
# @!attribute [rw] rest_api_id
|
2627
|
-
# The identifier of the RestApi
|
2794
|
+
# The string identifier of the associated RestApi.
|
2628
2795
|
# @return [String]
|
2629
2796
|
#
|
2630
2797
|
# @!attribute [rw] stage_name
|
@@ -2662,6 +2829,88 @@ module Aws::APIGateway
|
|
2662
2829
|
include Aws::Structure
|
2663
2830
|
end
|
2664
2831
|
|
2832
|
+
# Gets a GatewayResponse of a specified response type on the given
|
2833
|
+
# RestApi.
|
2834
|
+
#
|
2835
|
+
# @note When making an API call, you may pass GetGatewayResponseRequest
|
2836
|
+
# data as a hash:
|
2837
|
+
#
|
2838
|
+
# {
|
2839
|
+
# rest_api_id: "String", # required
|
2840
|
+
# 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
|
2841
|
+
# }
|
2842
|
+
#
|
2843
|
+
# @!attribute [rw] rest_api_id
|
2844
|
+
# The string identifier of the associated RestApi.
|
2845
|
+
# @return [String]
|
2846
|
+
#
|
2847
|
+
# @!attribute [rw] response_type
|
2848
|
+
# The response type of the associated GatewayResponse. Valid values
|
2849
|
+
# are * ACCESS\_DENIED
|
2850
|
+
# * API\_CONFIGURATION\_ERROR
|
2851
|
+
# * AUTHORIZER\_FAILURE
|
2852
|
+
# * AUTHORIZER\_CONFIGURATION\_ERROR
|
2853
|
+
# * BAD\_REQUEST\_PARAMETERS
|
2854
|
+
# * BAD\_REQUEST\_BODY
|
2855
|
+
# * DEFAULT\_4XX
|
2856
|
+
# * DEFAULT\_5XX
|
2857
|
+
# * EXPIRED\_TOKEN
|
2858
|
+
# * INVALID\_SIGNATURE
|
2859
|
+
# * INTEGRATION\_FAILURE
|
2860
|
+
# * INTEGRATION\_TIMEOUT
|
2861
|
+
# * INVALID\_API\_KEY
|
2862
|
+
# * MISSING\_AUTHENTICATION\_TOKEN
|
2863
|
+
# * QUOTA\_EXCEEDED
|
2864
|
+
# * REQUEST\_TOO\_LARGE
|
2865
|
+
# * RESOURCE\_NOT\_FOUND
|
2866
|
+
# * THROTTLED
|
2867
|
+
# * UNAUTHORIZED
|
2868
|
+
# * UNSUPPORTED\_MEDIA\_TYPES
|
2869
|
+
# @return [String]
|
2870
|
+
#
|
2871
|
+
class GetGatewayResponseRequest < Struct.new(
|
2872
|
+
:rest_api_id,
|
2873
|
+
:response_type)
|
2874
|
+
include Aws::Structure
|
2875
|
+
end
|
2876
|
+
|
2877
|
+
# Gets the GatewayResponses collection on the given RestApi. If an API
|
2878
|
+
# developer has not added any definitions for gateway responses, the
|
2879
|
+
# result will be the Amazon API Gateway-generated default
|
2880
|
+
# GatewayResponses collection for the supported response types.
|
2881
|
+
#
|
2882
|
+
# @note When making an API call, you may pass GetGatewayResponsesRequest
|
2883
|
+
# data as a hash:
|
2884
|
+
#
|
2885
|
+
# {
|
2886
|
+
# rest_api_id: "String", # required
|
2887
|
+
# position: "String",
|
2888
|
+
# limit: 1,
|
2889
|
+
# }
|
2890
|
+
#
|
2891
|
+
# @!attribute [rw] rest_api_id
|
2892
|
+
# The string identifier of the associated RestApi.
|
2893
|
+
# @return [String]
|
2894
|
+
#
|
2895
|
+
# @!attribute [rw] position
|
2896
|
+
# The current pagination position in the paged result set. The
|
2897
|
+
# GatewayResponse collection does not support pagination and the
|
2898
|
+
# position does not apply here.
|
2899
|
+
# @return [String]
|
2900
|
+
#
|
2901
|
+
# @!attribute [rw] limit
|
2902
|
+
# The maximum number of returned results per page. The
|
2903
|
+
# GatewayResponses collection does not support pagination and the
|
2904
|
+
# limit does not apply here.
|
2905
|
+
# @return [Integer]
|
2906
|
+
#
|
2907
|
+
class GetGatewayResponsesRequest < Struct.new(
|
2908
|
+
:rest_api_id,
|
2909
|
+
:position,
|
2910
|
+
:limit)
|
2911
|
+
include Aws::Structure
|
2912
|
+
end
|
2913
|
+
|
2665
2914
|
# Represents a get integration request.
|
2666
2915
|
#
|
2667
2916
|
# @note When making an API call, you may pass GetIntegrationRequest
|
@@ -2674,7 +2923,7 @@ module Aws::APIGateway
|
|
2674
2923
|
# }
|
2675
2924
|
#
|
2676
2925
|
# @!attribute [rw] rest_api_id
|
2677
|
-
#
|
2926
|
+
# The string identifier of the associated RestApi.
|
2678
2927
|
# @return [String]
|
2679
2928
|
#
|
2680
2929
|
# @!attribute [rw] resource_id
|
@@ -2705,7 +2954,7 @@ module Aws::APIGateway
|
|
2705
2954
|
# }
|
2706
2955
|
#
|
2707
2956
|
# @!attribute [rw] rest_api_id
|
2708
|
-
#
|
2957
|
+
# The string identifier of the associated RestApi.
|
2709
2958
|
# @return [String]
|
2710
2959
|
#
|
2711
2960
|
# @!attribute [rw] resource_id
|
@@ -2740,7 +2989,7 @@ module Aws::APIGateway
|
|
2740
2989
|
# }
|
2741
2990
|
#
|
2742
2991
|
# @!attribute [rw] rest_api_id
|
2743
|
-
# The
|
2992
|
+
# The string identifier of the associated RestApi.
|
2744
2993
|
# @return [String]
|
2745
2994
|
#
|
2746
2995
|
# @!attribute [rw] resource_id
|
@@ -2771,7 +3020,7 @@ module Aws::APIGateway
|
|
2771
3020
|
# }
|
2772
3021
|
#
|
2773
3022
|
# @!attribute [rw] rest_api_id
|
2774
|
-
# The
|
3023
|
+
# The string identifier of the associated RestApi.
|
2775
3024
|
# @return [String]
|
2776
3025
|
#
|
2777
3026
|
# @!attribute [rw] resource_id
|
@@ -2839,7 +3088,7 @@ module Aws::APIGateway
|
|
2839
3088
|
# }
|
2840
3089
|
#
|
2841
3090
|
# @!attribute [rw] rest_api_id
|
2842
|
-
# The
|
3091
|
+
# The string identifier of the associated RestApi.
|
2843
3092
|
# @return [String]
|
2844
3093
|
#
|
2845
3094
|
# @!attribute [rw] model_name
|
@@ -2864,7 +3113,7 @@ module Aws::APIGateway
|
|
2864
3113
|
# }
|
2865
3114
|
#
|
2866
3115
|
# @!attribute [rw] rest_api_id
|
2867
|
-
# The
|
3116
|
+
# The string identifier of the associated RestApi.
|
2868
3117
|
# @return [String]
|
2869
3118
|
#
|
2870
3119
|
# @!attribute [rw] position
|
@@ -2894,8 +3143,7 @@ module Aws::APIGateway
|
|
2894
3143
|
# }
|
2895
3144
|
#
|
2896
3145
|
# @!attribute [rw] rest_api_id
|
2897
|
-
#
|
2898
|
-
# RequestValidator belongs.
|
3146
|
+
# The string identifier of the associated RestApi.
|
2899
3147
|
# @return [String]
|
2900
3148
|
#
|
2901
3149
|
# @!attribute [rw] request_validator_id
|
@@ -2920,8 +3168,7 @@ module Aws::APIGateway
|
|
2920
3168
|
# }
|
2921
3169
|
#
|
2922
3170
|
# @!attribute [rw] rest_api_id
|
2923
|
-
#
|
2924
|
-
# RequestValidators collection belongs.
|
3171
|
+
# The string identifier of the associated RestApi.
|
2925
3172
|
# @return [String]
|
2926
3173
|
#
|
2927
3174
|
# @!attribute [rw] position
|
@@ -2951,7 +3198,7 @@ module Aws::APIGateway
|
|
2951
3198
|
# }
|
2952
3199
|
#
|
2953
3200
|
# @!attribute [rw] rest_api_id
|
2954
|
-
# The
|
3201
|
+
# The string identifier of the associated RestApi.
|
2955
3202
|
# @return [String]
|
2956
3203
|
#
|
2957
3204
|
# @!attribute [rw] resource_id
|
@@ -2988,7 +3235,7 @@ module Aws::APIGateway
|
|
2988
3235
|
# }
|
2989
3236
|
#
|
2990
3237
|
# @!attribute [rw] rest_api_id
|
2991
|
-
# The
|
3238
|
+
# The string identifier of the associated RestApi.
|
2992
3239
|
# @return [String]
|
2993
3240
|
#
|
2994
3241
|
# @!attribute [rw] position
|
@@ -3077,7 +3324,7 @@ module Aws::APIGateway
|
|
3077
3324
|
# }
|
3078
3325
|
#
|
3079
3326
|
# @!attribute [rw] rest_api_id
|
3080
|
-
# The identifier of the RestApi
|
3327
|
+
# The string identifier of the associated RestApi.
|
3081
3328
|
# @return [String]
|
3082
3329
|
#
|
3083
3330
|
# @!attribute [rw] stage_name
|
@@ -3158,8 +3405,7 @@ module Aws::APIGateway
|
|
3158
3405
|
# }
|
3159
3406
|
#
|
3160
3407
|
# @!attribute [rw] rest_api_id
|
3161
|
-
# The identifier of the RestApi
|
3162
|
-
# information about.
|
3408
|
+
# The string identifier of the associated RestApi.
|
3163
3409
|
# @return [String]
|
3164
3410
|
#
|
3165
3411
|
# @!attribute [rw] stage_name
|
@@ -3184,7 +3430,7 @@ module Aws::APIGateway
|
|
3184
3430
|
# }
|
3185
3431
|
#
|
3186
3432
|
# @!attribute [rw] rest_api_id
|
3187
|
-
# The
|
3433
|
+
# The string identifier of the associated RestApi.
|
3188
3434
|
# @return [String]
|
3189
3435
|
#
|
3190
3436
|
# @!attribute [rw] deployment_id
|
@@ -3413,8 +3659,7 @@ module Aws::APIGateway
|
|
3413
3659
|
# }
|
3414
3660
|
#
|
3415
3661
|
# @!attribute [rw] rest_api_id
|
3416
|
-
# \[Required\] The identifier of
|
3417
|
-
# documentation parts.
|
3662
|
+
# \[Required\] The string identifier of the associated RestApi.
|
3418
3663
|
# @return [String]
|
3419
3664
|
#
|
3420
3665
|
# @!attribute [rw] mode
|
@@ -3464,12 +3709,18 @@ module Aws::APIGateway
|
|
3464
3709
|
# @return [Boolean]
|
3465
3710
|
#
|
3466
3711
|
# @!attribute [rw] parameters
|
3467
|
-
# Custom header parameters as part of the request.
|
3712
|
+
# Custom header parameters as part of the request. For example, to
|
3713
|
+
# exclude DocumentationParts from an imported API, set
|
3714
|
+
# `ignore=documentation` as a `parameters` value, as in the AWS CLI
|
3715
|
+
# command of `aws apigateway import-rest-api --parameters
|
3716
|
+
# ignore=documentation --body
|
3717
|
+
# 'file:///path/to/imported-api-body.json`.
|
3468
3718
|
# @return [Hash<String,String>]
|
3469
3719
|
#
|
3470
3720
|
# @!attribute [rw] body
|
3471
3721
|
# The POST request body containing external API definitions.
|
3472
|
-
# Currently, only Swagger definition JSON files are supported.
|
3722
|
+
# Currently, only Swagger definition JSON files are supported. The
|
3723
|
+
# maximum size of the API definition file is 2MB.
|
3473
3724
|
# @return [String]
|
3474
3725
|
#
|
3475
3726
|
class ImportRestApiRequest < Struct.new(
|
@@ -4178,7 +4429,7 @@ module Aws::APIGateway
|
|
4178
4429
|
# @return [String]
|
4179
4430
|
#
|
4180
4431
|
# @!attribute [rw] items
|
4181
|
-
#
|
4432
|
+
# The current page of elements from this collection.
|
4182
4433
|
# @return [Array<Types::Model>]
|
4183
4434
|
#
|
4184
4435
|
class Models < Struct.new(
|
@@ -4250,7 +4501,76 @@ module Aws::APIGateway
|
|
4250
4501
|
include Aws::Structure
|
4251
4502
|
end
|
4252
4503
|
|
4253
|
-
#
|
4504
|
+
# Creates a customization of a GatewayResponse of a specified response
|
4505
|
+
# type and status code on the given RestApi.
|
4506
|
+
#
|
4507
|
+
# @note When making an API call, you may pass PutGatewayResponseRequest
|
4508
|
+
# data as a hash:
|
4509
|
+
#
|
4510
|
+
# {
|
4511
|
+
# rest_api_id: "String", # required
|
4512
|
+
# 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
|
4513
|
+
# status_code: "StatusCode",
|
4514
|
+
# response_parameters: {
|
4515
|
+
# "String" => "String",
|
4516
|
+
# },
|
4517
|
+
# response_templates: {
|
4518
|
+
# "String" => "String",
|
4519
|
+
# },
|
4520
|
+
# }
|
4521
|
+
#
|
4522
|
+
# @!attribute [rw] rest_api_id
|
4523
|
+
# The string identifier of the associated RestApi.
|
4524
|
+
# @return [String]
|
4525
|
+
#
|
4526
|
+
# @!attribute [rw] response_type
|
4527
|
+
# The response type of the associated GatewayResponse. Valid values
|
4528
|
+
# are * ACCESS\_DENIED
|
4529
|
+
# * API\_CONFIGURATION\_ERROR
|
4530
|
+
# * AUTHORIZER\_FAILURE
|
4531
|
+
# * AUTHORIZER\_CONFIGURATION\_ERROR
|
4532
|
+
# * BAD\_REQUEST\_PARAMETERS
|
4533
|
+
# * BAD\_REQUEST\_BODY
|
4534
|
+
# * DEFAULT\_4XX
|
4535
|
+
# * DEFAULT\_5XX
|
4536
|
+
# * EXPIRED\_TOKEN
|
4537
|
+
# * INVALID\_SIGNATURE
|
4538
|
+
# * INTEGRATION\_FAILURE
|
4539
|
+
# * INTEGRATION\_TIMEOUT
|
4540
|
+
# * INVALID\_API\_KEY
|
4541
|
+
# * MISSING\_AUTHENTICATION\_TOKEN
|
4542
|
+
# * QUOTA\_EXCEEDED
|
4543
|
+
# * REQUEST\_TOO\_LARGE
|
4544
|
+
# * RESOURCE\_NOT\_FOUND
|
4545
|
+
# * THROTTLED
|
4546
|
+
# * UNAUTHORIZED
|
4547
|
+
# * UNSUPPORTED\_MEDIA\_TYPES
|
4548
|
+
# @return [String]
|
4549
|
+
#
|
4550
|
+
# @!attribute [rw] status_code
|
4551
|
+
# The HTTP status code of the GatewayResponse.
|
4552
|
+
# @return [String]
|
4553
|
+
#
|
4554
|
+
# @!attribute [rw] response_parameters
|
4555
|
+
# Response parameters (paths, query strings and headers) of the
|
4556
|
+
# GatewayResponse as a string-to-string map of key-value pairs.
|
4557
|
+
# @return [Hash<String,String>]
|
4558
|
+
#
|
4559
|
+
# @!attribute [rw] response_templates
|
4560
|
+
# Response templates of the GatewayResponse as a string-to-string map
|
4561
|
+
# of key-value pairs.
|
4562
|
+
# @return [Hash<String,String>]
|
4563
|
+
#
|
4564
|
+
class PutGatewayResponseRequest < Struct.new(
|
4565
|
+
:rest_api_id,
|
4566
|
+
:response_type,
|
4567
|
+
:status_code,
|
4568
|
+
:response_parameters,
|
4569
|
+
:response_templates)
|
4570
|
+
include Aws::Structure
|
4571
|
+
end
|
4572
|
+
|
4573
|
+
# Sets up a method's integration.
|
4254
4574
|
#
|
4255
4575
|
# @note When making an API call, you may pass PutIntegrationRequest
|
4256
4576
|
# data as a hash:
|
@@ -4276,7 +4596,7 @@ module Aws::APIGateway
|
|
4276
4596
|
# }
|
4277
4597
|
#
|
4278
4598
|
# @!attribute [rw] rest_api_id
|
4279
|
-
#
|
4599
|
+
# The string identifier of the associated RestApi.
|
4280
4600
|
# @return [String]
|
4281
4601
|
#
|
4282
4602
|
# @!attribute [rw] resource_id
|
@@ -4297,12 +4617,21 @@ module Aws::APIGateway
|
|
4297
4617
|
# @return [String]
|
4298
4618
|
#
|
4299
4619
|
# @!attribute [rw] uri
|
4300
|
-
# Specifies
|
4301
|
-
#
|
4302
|
-
#
|
4303
|
-
#
|
4304
|
-
#
|
4305
|
-
#
|
4620
|
+
# Specifies the integration's Uniform Resource Identifier (URI). For
|
4621
|
+
# HTTP integrations, the URI must be a fully formed, encoded HTTP(S)
|
4622
|
+
# URL according to the [RFC-3986 specification][1]. For AWS
|
4623
|
+
# integrations, the URI should be of the form
|
4624
|
+
# `arn:aws:apigateway:\{region\}:\{subdomain.service|service\}:\{path|action\}/\{service_api\}`.
|
4625
|
+
# `Region`, `subdomain` and `service` are used to determine the right
|
4626
|
+
# endpoint. For AWS services that use the `Action=` query string
|
4627
|
+
# parameter, `service_api` should be a valid action for the desired
|
4628
|
+
# service. For RESTful AWS service APIs, `path` is used to indicate
|
4629
|
+
# that the remaining substring in the URI should be treated as the
|
4630
|
+
# path to the resource, including the initial `/`.
|
4631
|
+
#
|
4632
|
+
#
|
4633
|
+
#
|
4634
|
+
# [1]: https://en.wikipedia.org/wiki/Uniform_Resource_Identifier
|
4306
4635
|
# @return [String]
|
4307
4636
|
#
|
4308
4637
|
# @!attribute [rw] credentials
|
@@ -4410,7 +4739,7 @@ module Aws::APIGateway
|
|
4410
4739
|
# }
|
4411
4740
|
#
|
4412
4741
|
# @!attribute [rw] rest_api_id
|
4413
|
-
#
|
4742
|
+
# The string identifier of the associated RestApi.
|
4414
4743
|
# @return [String]
|
4415
4744
|
#
|
4416
4745
|
# @!attribute [rw] resource_id
|
@@ -4500,7 +4829,7 @@ module Aws::APIGateway
|
|
4500
4829
|
# }
|
4501
4830
|
#
|
4502
4831
|
# @!attribute [rw] rest_api_id
|
4503
|
-
# The
|
4832
|
+
# The string identifier of the associated RestApi.
|
4504
4833
|
# @return [String]
|
4505
4834
|
#
|
4506
4835
|
# @!attribute [rw] resource_id
|
@@ -4594,7 +4923,7 @@ module Aws::APIGateway
|
|
4594
4923
|
# }
|
4595
4924
|
#
|
4596
4925
|
# @!attribute [rw] rest_api_id
|
4597
|
-
# The
|
4926
|
+
# The string identifier of the associated RestApi.
|
4598
4927
|
# @return [String]
|
4599
4928
|
#
|
4600
4929
|
# @!attribute [rw] resource_id
|
@@ -4660,7 +4989,7 @@ module Aws::APIGateway
|
|
4660
4989
|
# }
|
4661
4990
|
#
|
4662
4991
|
# @!attribute [rw] rest_api_id
|
4663
|
-
# The identifier of the RestApi
|
4992
|
+
# The string identifier of the associated RestApi.
|
4664
4993
|
# @return [String]
|
4665
4994
|
#
|
4666
4995
|
# @!attribute [rw] mode
|
@@ -4676,12 +5005,18 @@ module Aws::APIGateway
|
|
4676
5005
|
# @return [Boolean]
|
4677
5006
|
#
|
4678
5007
|
# @!attribute [rw] parameters
|
4679
|
-
# Custom
|
5008
|
+
# Custom header parameters as part of the request. For example, to
|
5009
|
+
# exclude DocumentationParts from an imported API, set
|
5010
|
+
# `ignore=documentation` as a `parameters` value, as in the AWS CLI
|
5011
|
+
# command of `aws apigateway import-rest-api --parameters
|
5012
|
+
# ignore=documentation --body
|
5013
|
+
# 'file:///path/to/imported-api-body.json`.
|
4680
5014
|
# @return [Hash<String,String>]
|
4681
5015
|
#
|
4682
5016
|
# @!attribute [rw] body
|
4683
5017
|
# The PUT request body containing external API definitions. Currently,
|
4684
|
-
# only Swagger definition JSON files are supported.
|
5018
|
+
# only Swagger definition JSON files are supported. The maximum size
|
5019
|
+
# of the API definition file is 2MB.
|
4685
5020
|
# @return [String]
|
4686
5021
|
#
|
4687
5022
|
class PutRestApiRequest < Struct.new(
|
@@ -4793,8 +5128,7 @@ module Aws::APIGateway
|
|
4793
5128
|
# @return [String]
|
4794
5129
|
#
|
4795
5130
|
# @!attribute [rw] items
|
4796
|
-
# The current page of
|
4797
|
-
# RequestValidators collection.
|
5131
|
+
# The current page of elements from this collection.
|
4798
5132
|
# @return [Array<Types::RequestValidator>]
|
4799
5133
|
#
|
4800
5134
|
class RequestValidators < Struct.new(
|
@@ -4882,7 +5216,7 @@ module Aws::APIGateway
|
|
4882
5216
|
# @return [String]
|
4883
5217
|
#
|
4884
5218
|
# @!attribute [rw] items
|
4885
|
-
#
|
5219
|
+
# The current page of elements from this collection.
|
4886
5220
|
# @return [Array<Types::Resource>]
|
4887
5221
|
#
|
4888
5222
|
class Resources < Struct.new(
|
@@ -4959,7 +5293,7 @@ module Aws::APIGateway
|
|
4959
5293
|
# @return [String]
|
4960
5294
|
#
|
4961
5295
|
# @!attribute [rw] items
|
4962
|
-
#
|
5296
|
+
# The current page of elements from this collection.
|
4963
5297
|
# @return [Array<Types::RestApi>]
|
4964
5298
|
#
|
4965
5299
|
class RestApis < Struct.new(
|
@@ -5055,8 +5389,7 @@ module Aws::APIGateway
|
|
5055
5389
|
# @return [String]
|
5056
5390
|
#
|
5057
5391
|
# @!attribute [rw] items
|
5058
|
-
# The
|
5059
|
-
# collection.
|
5392
|
+
# The current page of elements from this collection.
|
5060
5393
|
# @return [Array<Types::SdkType>]
|
5061
5394
|
#
|
5062
5395
|
class SdkTypes < Struct.new(
|
@@ -5159,12 +5492,11 @@ module Aws::APIGateway
|
|
5159
5492
|
# }
|
5160
5493
|
#
|
5161
5494
|
# @!attribute [rw] rest_api_id
|
5162
|
-
#
|
5163
|
-
# resource.
|
5495
|
+
# The string identifier of the associated RestApi.
|
5164
5496
|
# @return [String]
|
5165
5497
|
#
|
5166
5498
|
# @!attribute [rw] stage_name
|
5167
|
-
# The stage name
|
5499
|
+
# The stage name associated with the stage key.
|
5168
5500
|
# @return [String]
|
5169
5501
|
#
|
5170
5502
|
class StageKey < Struct.new(
|
@@ -5185,7 +5517,7 @@ module Aws::APIGateway
|
|
5185
5517
|
# [1]: http://docs.aws.amazon.com/apigateway/latest/developerguide/stages.html
|
5186
5518
|
#
|
5187
5519
|
# @!attribute [rw] item
|
5188
|
-
#
|
5520
|
+
# The current page of elements from this collection.
|
5189
5521
|
# @return [Array<Types::Stage>]
|
5190
5522
|
#
|
5191
5523
|
class Stages < Struct.new(
|
@@ -5239,7 +5571,7 @@ module Aws::APIGateway
|
|
5239
5571
|
# }
|
5240
5572
|
#
|
5241
5573
|
# @!attribute [rw] rest_api_id
|
5242
|
-
#
|
5574
|
+
# The string identifier of the associated RestApi.
|
5243
5575
|
# @return [String]
|
5244
5576
|
#
|
5245
5577
|
# @!attribute [rw] authorizer_id
|
@@ -5352,7 +5684,7 @@ module Aws::APIGateway
|
|
5352
5684
|
# }
|
5353
5685
|
#
|
5354
5686
|
# @!attribute [rw] rest_api_id
|
5355
|
-
#
|
5687
|
+
# The string identifier of the associated RestApi.
|
5356
5688
|
# @return [String]
|
5357
5689
|
#
|
5358
5690
|
# @!attribute [rw] resource_id
|
@@ -5544,7 +5876,7 @@ module Aws::APIGateway
|
|
5544
5876
|
# }
|
5545
5877
|
#
|
5546
5878
|
# @!attribute [rw] rest_api_id
|
5547
|
-
# The
|
5879
|
+
# The string identifier of the associated RestApi.
|
5548
5880
|
# @return [String]
|
5549
5881
|
#
|
5550
5882
|
# @!attribute [rw] authorizer_id
|
@@ -5653,8 +5985,7 @@ module Aws::APIGateway
|
|
5653
5985
|
# }
|
5654
5986
|
#
|
5655
5987
|
# @!attribute [rw] rest_api_id
|
5656
|
-
# The
|
5657
|
-
# Deployment resource to change information about.
|
5988
|
+
# The string identifier of the associated RestApi.
|
5658
5989
|
# @return [String]
|
5659
5990
|
#
|
5660
5991
|
# @!attribute [rw] deployment_id
|
@@ -5693,8 +6024,7 @@ module Aws::APIGateway
|
|
5693
6024
|
# }
|
5694
6025
|
#
|
5695
6026
|
# @!attribute [rw] rest_api_id
|
5696
|
-
# \[Required\] The identifier of
|
5697
|
-
# documentation part.
|
6027
|
+
# \[Required\] The string identifier of the associated RestApi.
|
5698
6028
|
# @return [String]
|
5699
6029
|
#
|
5700
6030
|
# @!attribute [rw] documentation_part_id
|
@@ -5732,8 +6062,7 @@ module Aws::APIGateway
|
|
5732
6062
|
# }
|
5733
6063
|
#
|
5734
6064
|
# @!attribute [rw] rest_api_id
|
5735
|
-
# \[Required\] The identifier of
|
5736
|
-
# documentation version.
|
6065
|
+
# \[Required\] The string identifier of the associated RestApi..
|
5737
6066
|
# @return [String]
|
5738
6067
|
#
|
5739
6068
|
# @!attribute [rw] documentation_version
|
@@ -5785,6 +6114,65 @@ module Aws::APIGateway
|
|
5785
6114
|
include Aws::Structure
|
5786
6115
|
end
|
5787
6116
|
|
6117
|
+
# Updates a GatewayResponse of a specified response type on the given
|
6118
|
+
# RestApi.
|
6119
|
+
#
|
6120
|
+
# @note When making an API call, you may pass UpdateGatewayResponseRequest
|
6121
|
+
# data as a hash:
|
6122
|
+
#
|
6123
|
+
# {
|
6124
|
+
# rest_api_id: "String", # required
|
6125
|
+
# 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
|
6126
|
+
# patch_operations: [
|
6127
|
+
# {
|
6128
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
6129
|
+
# path: "String",
|
6130
|
+
# value: "String",
|
6131
|
+
# from: "String",
|
6132
|
+
# },
|
6133
|
+
# ],
|
6134
|
+
# }
|
6135
|
+
#
|
6136
|
+
# @!attribute [rw] rest_api_id
|
6137
|
+
# The string identifier of the associated RestApi.
|
6138
|
+
# @return [String]
|
6139
|
+
#
|
6140
|
+
# @!attribute [rw] response_type
|
6141
|
+
# The response type of the associated GatewayResponse. Valid values
|
6142
|
+
# are * ACCESS\_DENIED
|
6143
|
+
# * API\_CONFIGURATION\_ERROR
|
6144
|
+
# * AUTHORIZER\_FAILURE
|
6145
|
+
# * AUTHORIZER\_CONFIGURATION\_ERROR
|
6146
|
+
# * BAD\_REQUEST\_PARAMETERS
|
6147
|
+
# * BAD\_REQUEST\_BODY
|
6148
|
+
# * DEFAULT\_4XX
|
6149
|
+
# * DEFAULT\_5XX
|
6150
|
+
# * EXPIRED\_TOKEN
|
6151
|
+
# * INVALID\_SIGNATURE
|
6152
|
+
# * INTEGRATION\_FAILURE
|
6153
|
+
# * INTEGRATION\_TIMEOUT
|
6154
|
+
# * INVALID\_API\_KEY
|
6155
|
+
# * MISSING\_AUTHENTICATION\_TOKEN
|
6156
|
+
# * QUOTA\_EXCEEDED
|
6157
|
+
# * REQUEST\_TOO\_LARGE
|
6158
|
+
# * RESOURCE\_NOT\_FOUND
|
6159
|
+
# * THROTTLED
|
6160
|
+
# * UNAUTHORIZED
|
6161
|
+
# * UNSUPPORTED\_MEDIA\_TYPES
|
6162
|
+
# @return [String]
|
6163
|
+
#
|
6164
|
+
# @!attribute [rw] patch_operations
|
6165
|
+
# A list of update operations to be applied to the specified resource
|
6166
|
+
# and in the order specified in this list.
|
6167
|
+
# @return [Array<Types::PatchOperation>]
|
6168
|
+
#
|
6169
|
+
class UpdateGatewayResponseRequest < Struct.new(
|
6170
|
+
:rest_api_id,
|
6171
|
+
:response_type,
|
6172
|
+
:patch_operations)
|
6173
|
+
include Aws::Structure
|
6174
|
+
end
|
6175
|
+
|
5788
6176
|
# Represents an update integration request.
|
5789
6177
|
#
|
5790
6178
|
# @note When making an API call, you may pass UpdateIntegrationRequest
|
@@ -5805,7 +6193,7 @@ module Aws::APIGateway
|
|
5805
6193
|
# }
|
5806
6194
|
#
|
5807
6195
|
# @!attribute [rw] rest_api_id
|
5808
|
-
#
|
6196
|
+
# The string identifier of the associated RestApi.
|
5809
6197
|
# @return [String]
|
5810
6198
|
#
|
5811
6199
|
# @!attribute [rw] resource_id
|
@@ -5850,7 +6238,7 @@ module Aws::APIGateway
|
|
5850
6238
|
# }
|
5851
6239
|
#
|
5852
6240
|
# @!attribute [rw] rest_api_id
|
5853
|
-
#
|
6241
|
+
# The string identifier of the associated RestApi.
|
5854
6242
|
# @return [String]
|
5855
6243
|
#
|
5856
6244
|
# @!attribute [rw] resource_id
|
@@ -5900,7 +6288,7 @@ module Aws::APIGateway
|
|
5900
6288
|
# }
|
5901
6289
|
#
|
5902
6290
|
# @!attribute [rw] rest_api_id
|
5903
|
-
# The
|
6291
|
+
# The string identifier of the associated RestApi.
|
5904
6292
|
# @return [String]
|
5905
6293
|
#
|
5906
6294
|
# @!attribute [rw] resource_id
|
@@ -5945,7 +6333,7 @@ module Aws::APIGateway
|
|
5945
6333
|
# }
|
5946
6334
|
#
|
5947
6335
|
# @!attribute [rw] rest_api_id
|
5948
|
-
# The
|
6336
|
+
# The string identifier of the associated RestApi.
|
5949
6337
|
# @return [String]
|
5950
6338
|
#
|
5951
6339
|
# @!attribute [rw] resource_id
|
@@ -5993,7 +6381,7 @@ module Aws::APIGateway
|
|
5993
6381
|
# }
|
5994
6382
|
#
|
5995
6383
|
# @!attribute [rw] rest_api_id
|
5996
|
-
# The
|
6384
|
+
# The string identifier of the associated RestApi.
|
5997
6385
|
# @return [String]
|
5998
6386
|
#
|
5999
6387
|
# @!attribute [rw] model_name
|
@@ -6031,8 +6419,7 @@ module Aws::APIGateway
|
|
6031
6419
|
# }
|
6032
6420
|
#
|
6033
6421
|
# @!attribute [rw] rest_api_id
|
6034
|
-
#
|
6035
|
-
# RequestValidator is updated.
|
6422
|
+
# The string identifier of the associated RestApi.
|
6036
6423
|
# @return [String]
|
6037
6424
|
#
|
6038
6425
|
# @!attribute [rw] request_validator_id
|
@@ -6070,7 +6457,7 @@ module Aws::APIGateway
|
|
6070
6457
|
# }
|
6071
6458
|
#
|
6072
6459
|
# @!attribute [rw] rest_api_id
|
6073
|
-
# The
|
6460
|
+
# The string identifier of the associated RestApi.
|
6074
6461
|
# @return [String]
|
6075
6462
|
#
|
6076
6463
|
# @!attribute [rw] resource_id
|
@@ -6107,7 +6494,7 @@ module Aws::APIGateway
|
|
6107
6494
|
# }
|
6108
6495
|
#
|
6109
6496
|
# @!attribute [rw] rest_api_id
|
6110
|
-
# The
|
6497
|
+
# The string identifier of the associated RestApi.
|
6111
6498
|
# @return [String]
|
6112
6499
|
#
|
6113
6500
|
# @!attribute [rw] patch_operations
|
@@ -6141,8 +6528,7 @@ module Aws::APIGateway
|
|
6141
6528
|
# }
|
6142
6529
|
#
|
6143
6530
|
# @!attribute [rw] rest_api_id
|
6144
|
-
# The identifier of the RestApi
|
6145
|
-
# change information about.
|
6531
|
+
# The string identifier of the associated RestApi.
|
6146
6532
|
# @return [String]
|
6147
6533
|
#
|
6148
6534
|
# @!attribute [rw] stage_name
|
@@ -6193,7 +6579,7 @@ module Aws::APIGateway
|
|
6193
6579
|
include Aws::Structure
|
6194
6580
|
end
|
6195
6581
|
|
6196
|
-
# The PATCH request to grant a temporary extension to the
|
6582
|
+
# The PATCH request to grant a temporary extension to the remaining
|
6197
6583
|
# quota of a usage plan associated with a specified API key.
|
6198
6584
|
#
|
6199
6585
|
# @note When making an API call, you may pass UpdateUsageRequest
|
@@ -6394,7 +6780,7 @@ module Aws::APIGateway
|
|
6394
6780
|
# @return [String]
|
6395
6781
|
#
|
6396
6782
|
# @!attribute [rw] items
|
6397
|
-
#
|
6783
|
+
# The current page of elements from this collection.
|
6398
6784
|
# @return [Array<Types::UsagePlanKey>]
|
6399
6785
|
#
|
6400
6786
|
class UsagePlanKeys < Struct.new(
|
@@ -6417,7 +6803,7 @@ module Aws::APIGateway
|
|
6417
6803
|
# @return [String]
|
6418
6804
|
#
|
6419
6805
|
# @!attribute [rw] items
|
6420
|
-
#
|
6806
|
+
# The current page of elements from this collection.
|
6421
6807
|
# @return [Array<Types::UsagePlan>]
|
6422
6808
|
#
|
6423
6809
|
class UsagePlans < Struct.new(
|