aws-sdk-apigateway 1.0.0.rc3 → 1.0.0.rc4
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 +324 -76
- data/lib/aws-sdk-apigateway/client_api.rb +116 -4
- data/lib/aws-sdk-apigateway/types.rb +390 -124
- metadata +2 -2
@@ -39,6 +39,7 @@ module Aws::APIGateway
|
|
39
39
|
CreateDocumentationVersionRequest = Shapes::StructureShape.new(name: 'CreateDocumentationVersionRequest')
|
40
40
|
CreateDomainNameRequest = Shapes::StructureShape.new(name: 'CreateDomainNameRequest')
|
41
41
|
CreateModelRequest = Shapes::StructureShape.new(name: 'CreateModelRequest')
|
42
|
+
CreateRequestValidatorRequest = Shapes::StructureShape.new(name: 'CreateRequestValidatorRequest')
|
42
43
|
CreateResourceRequest = Shapes::StructureShape.new(name: 'CreateResourceRequest')
|
43
44
|
CreateRestApiRequest = Shapes::StructureShape.new(name: 'CreateRestApiRequest')
|
44
45
|
CreateStageRequest = Shapes::StructureShape.new(name: 'CreateStageRequest')
|
@@ -57,6 +58,7 @@ module Aws::APIGateway
|
|
57
58
|
DeleteMethodRequest = Shapes::StructureShape.new(name: 'DeleteMethodRequest')
|
58
59
|
DeleteMethodResponseRequest = Shapes::StructureShape.new(name: 'DeleteMethodResponseRequest')
|
59
60
|
DeleteModelRequest = Shapes::StructureShape.new(name: 'DeleteModelRequest')
|
61
|
+
DeleteRequestValidatorRequest = Shapes::StructureShape.new(name: 'DeleteRequestValidatorRequest')
|
60
62
|
DeleteResourceRequest = Shapes::StructureShape.new(name: 'DeleteResourceRequest')
|
61
63
|
DeleteRestApiRequest = Shapes::StructureShape.new(name: 'DeleteRestApiRequest')
|
62
64
|
DeleteStageRequest = Shapes::StructureShape.new(name: 'DeleteStageRequest')
|
@@ -104,6 +106,8 @@ module Aws::APIGateway
|
|
104
106
|
GetModelRequest = Shapes::StructureShape.new(name: 'GetModelRequest')
|
105
107
|
GetModelTemplateRequest = Shapes::StructureShape.new(name: 'GetModelTemplateRequest')
|
106
108
|
GetModelsRequest = Shapes::StructureShape.new(name: 'GetModelsRequest')
|
109
|
+
GetRequestValidatorRequest = Shapes::StructureShape.new(name: 'GetRequestValidatorRequest')
|
110
|
+
GetRequestValidatorsRequest = Shapes::StructureShape.new(name: 'GetRequestValidatorsRequest')
|
107
111
|
GetResourceRequest = Shapes::StructureShape.new(name: 'GetResourceRequest')
|
108
112
|
GetResourcesRequest = Shapes::StructureShape.new(name: 'GetResourcesRequest')
|
109
113
|
GetRestApiRequest = Shapes::StructureShape.new(name: 'GetRestApiRequest')
|
@@ -139,6 +143,7 @@ module Aws::APIGateway
|
|
139
143
|
ListOfLong = Shapes::ListShape.new(name: 'ListOfLong')
|
140
144
|
ListOfModel = Shapes::ListShape.new(name: 'ListOfModel')
|
141
145
|
ListOfPatchOperation = Shapes::ListShape.new(name: 'ListOfPatchOperation')
|
146
|
+
ListOfRequestValidator = Shapes::ListShape.new(name: 'ListOfRequestValidator')
|
142
147
|
ListOfResource = Shapes::ListShape.new(name: 'ListOfResource')
|
143
148
|
ListOfRestApi = Shapes::ListShape.new(name: 'ListOfRestApi')
|
144
149
|
ListOfSdkConfigurationProperty = Shapes::ListShape.new(name: 'ListOfSdkConfigurationProperty')
|
@@ -181,6 +186,8 @@ module Aws::APIGateway
|
|
181
186
|
PutRestApiRequest = Shapes::StructureShape.new(name: 'PutRestApiRequest')
|
182
187
|
QuotaPeriodType = Shapes::StringShape.new(name: 'QuotaPeriodType')
|
183
188
|
QuotaSettings = Shapes::StructureShape.new(name: 'QuotaSettings')
|
189
|
+
RequestValidator = Shapes::StructureShape.new(name: 'RequestValidator')
|
190
|
+
RequestValidators = Shapes::StructureShape.new(name: 'RequestValidators')
|
184
191
|
Resource = Shapes::StructureShape.new(name: 'Resource')
|
185
192
|
Resources = Shapes::StructureShape.new(name: 'Resources')
|
186
193
|
RestApi = Shapes::StructureShape.new(name: 'RestApi')
|
@@ -219,6 +226,7 @@ module Aws::APIGateway
|
|
219
226
|
UpdateMethodRequest = Shapes::StructureShape.new(name: 'UpdateMethodRequest')
|
220
227
|
UpdateMethodResponseRequest = Shapes::StructureShape.new(name: 'UpdateMethodResponseRequest')
|
221
228
|
UpdateModelRequest = Shapes::StructureShape.new(name: 'UpdateModelRequest')
|
229
|
+
UpdateRequestValidatorRequest = Shapes::StructureShape.new(name: 'UpdateRequestValidatorRequest')
|
222
230
|
UpdateResourceRequest = Shapes::StructureShape.new(name: 'UpdateResourceRequest')
|
223
231
|
UpdateRestApiRequest = Shapes::StructureShape.new(name: 'UpdateRestApiRequest')
|
224
232
|
UpdateStageRequest = Shapes::StructureShape.new(name: 'UpdateStageRequest')
|
@@ -344,10 +352,11 @@ module Aws::APIGateway
|
|
344
352
|
CreateDocumentationVersionRequest.struct_class = Types::CreateDocumentationVersionRequest
|
345
353
|
|
346
354
|
CreateDomainNameRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "domainName"))
|
347
|
-
CreateDomainNameRequest.add_member(:certificate_name, Shapes::ShapeRef.new(shape: String,
|
348
|
-
CreateDomainNameRequest.add_member(:certificate_body, Shapes::ShapeRef.new(shape: String,
|
349
|
-
CreateDomainNameRequest.add_member(:certificate_private_key, Shapes::ShapeRef.new(shape: String,
|
350
|
-
CreateDomainNameRequest.add_member(:certificate_chain, Shapes::ShapeRef.new(shape: String,
|
355
|
+
CreateDomainNameRequest.add_member(:certificate_name, Shapes::ShapeRef.new(shape: String, location_name: "certificateName"))
|
356
|
+
CreateDomainNameRequest.add_member(:certificate_body, Shapes::ShapeRef.new(shape: String, location_name: "certificateBody"))
|
357
|
+
CreateDomainNameRequest.add_member(:certificate_private_key, Shapes::ShapeRef.new(shape: String, location_name: "certificatePrivateKey"))
|
358
|
+
CreateDomainNameRequest.add_member(:certificate_chain, Shapes::ShapeRef.new(shape: String, location_name: "certificateChain"))
|
359
|
+
CreateDomainNameRequest.add_member(:certificate_arn, Shapes::ShapeRef.new(shape: String, location_name: "certificateArn"))
|
351
360
|
CreateDomainNameRequest.struct_class = Types::CreateDomainNameRequest
|
352
361
|
|
353
362
|
CreateModelRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
@@ -357,6 +366,12 @@ module Aws::APIGateway
|
|
357
366
|
CreateModelRequest.add_member(:content_type, Shapes::ShapeRef.new(shape: String, required: true, location_name: "contentType"))
|
358
367
|
CreateModelRequest.struct_class = Types::CreateModelRequest
|
359
368
|
|
369
|
+
CreateRequestValidatorRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
370
|
+
CreateRequestValidatorRequest.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "name"))
|
371
|
+
CreateRequestValidatorRequest.add_member(:validate_request_body, Shapes::ShapeRef.new(shape: Boolean, location_name: "validateRequestBody"))
|
372
|
+
CreateRequestValidatorRequest.add_member(:validate_request_parameters, Shapes::ShapeRef.new(shape: Boolean, location_name: "validateRequestParameters"))
|
373
|
+
CreateRequestValidatorRequest.struct_class = Types::CreateRequestValidatorRequest
|
374
|
+
|
360
375
|
CreateResourceRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
361
376
|
CreateResourceRequest.add_member(:parent_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "parent_id"))
|
362
377
|
CreateResourceRequest.add_member(:path_part, Shapes::ShapeRef.new(shape: String, required: true, location_name: "pathPart"))
|
@@ -446,6 +461,10 @@ module Aws::APIGateway
|
|
446
461
|
DeleteModelRequest.add_member(:model_name, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "model_name"))
|
447
462
|
DeleteModelRequest.struct_class = Types::DeleteModelRequest
|
448
463
|
|
464
|
+
DeleteRequestValidatorRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
465
|
+
DeleteRequestValidatorRequest.add_member(:request_validator_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "requestvalidator_id"))
|
466
|
+
DeleteRequestValidatorRequest.struct_class = Types::DeleteRequestValidatorRequest
|
467
|
+
|
449
468
|
DeleteResourceRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
450
469
|
DeleteResourceRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "resource_id"))
|
451
470
|
DeleteResourceRequest.struct_class = Types::DeleteResourceRequest
|
@@ -505,6 +524,7 @@ module Aws::APIGateway
|
|
505
524
|
|
506
525
|
DomainName.add_member(:domain_name, Shapes::ShapeRef.new(shape: String, location_name: "domainName"))
|
507
526
|
DomainName.add_member(:certificate_name, Shapes::ShapeRef.new(shape: String, location_name: "certificateName"))
|
527
|
+
DomainName.add_member(:certificate_arn, Shapes::ShapeRef.new(shape: String, location_name: "certificateArn"))
|
508
528
|
DomainName.add_member(:certificate_upload_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "certificateUploadDate"))
|
509
529
|
DomainName.add_member(:distribution_domain_name, Shapes::ShapeRef.new(shape: String, location_name: "distributionDomainName"))
|
510
530
|
DomainName.struct_class = Types::DomainName
|
@@ -571,6 +591,7 @@ module Aws::APIGateway
|
|
571
591
|
|
572
592
|
GetDeploymentRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
573
593
|
GetDeploymentRequest.add_member(:deployment_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "deployment_id"))
|
594
|
+
GetDeploymentRequest.add_member(:embed, Shapes::ShapeRef.new(shape: ListOfString, location: "querystring", location_name: "embed"))
|
574
595
|
GetDeploymentRequest.struct_class = Types::GetDeploymentRequest
|
575
596
|
|
576
597
|
GetDeploymentsRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
@@ -649,13 +670,24 @@ module Aws::APIGateway
|
|
649
670
|
GetModelsRequest.add_member(:limit, Shapes::ShapeRef.new(shape: NullableInteger, location: "querystring", location_name: "limit"))
|
650
671
|
GetModelsRequest.struct_class = Types::GetModelsRequest
|
651
672
|
|
673
|
+
GetRequestValidatorRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
674
|
+
GetRequestValidatorRequest.add_member(:request_validator_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "requestvalidator_id"))
|
675
|
+
GetRequestValidatorRequest.struct_class = Types::GetRequestValidatorRequest
|
676
|
+
|
677
|
+
GetRequestValidatorsRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
678
|
+
GetRequestValidatorsRequest.add_member(:position, Shapes::ShapeRef.new(shape: String, location: "querystring", location_name: "position"))
|
679
|
+
GetRequestValidatorsRequest.add_member(:limit, Shapes::ShapeRef.new(shape: NullableInteger, location: "querystring", location_name: "limit"))
|
680
|
+
GetRequestValidatorsRequest.struct_class = Types::GetRequestValidatorsRequest
|
681
|
+
|
652
682
|
GetResourceRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
653
683
|
GetResourceRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "resource_id"))
|
684
|
+
GetResourceRequest.add_member(:embed, Shapes::ShapeRef.new(shape: ListOfString, location: "querystring", location_name: "embed"))
|
654
685
|
GetResourceRequest.struct_class = Types::GetResourceRequest
|
655
686
|
|
656
687
|
GetResourcesRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
657
688
|
GetResourcesRequest.add_member(:position, Shapes::ShapeRef.new(shape: String, location: "querystring", location_name: "position"))
|
658
689
|
GetResourcesRequest.add_member(:limit, Shapes::ShapeRef.new(shape: NullableInteger, location: "querystring", location_name: "limit"))
|
690
|
+
GetResourcesRequest.add_member(:embed, Shapes::ShapeRef.new(shape: ListOfString, location: "querystring", location_name: "embed"))
|
659
691
|
GetResourcesRequest.struct_class = Types::GetResourcesRequest
|
660
692
|
|
661
693
|
GetRestApiRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
@@ -780,6 +812,8 @@ module Aws::APIGateway
|
|
780
812
|
|
781
813
|
ListOfPatchOperation.member = Shapes::ShapeRef.new(shape: PatchOperation)
|
782
814
|
|
815
|
+
ListOfRequestValidator.member = Shapes::ShapeRef.new(shape: RequestValidator)
|
816
|
+
|
783
817
|
ListOfResource.member = Shapes::ShapeRef.new(shape: Resource)
|
784
818
|
|
785
819
|
ListOfRestApi.member = Shapes::ShapeRef.new(shape: RestApi)
|
@@ -834,6 +868,7 @@ module Aws::APIGateway
|
|
834
868
|
Method.add_member(:authorization_type, Shapes::ShapeRef.new(shape: String, location_name: "authorizationType"))
|
835
869
|
Method.add_member(:authorizer_id, Shapes::ShapeRef.new(shape: String, location_name: "authorizerId"))
|
836
870
|
Method.add_member(:api_key_required, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "apiKeyRequired"))
|
871
|
+
Method.add_member(:request_validator_id, Shapes::ShapeRef.new(shape: String, location_name: "requestValidatorId"))
|
837
872
|
Method.add_member(:operation_name, Shapes::ShapeRef.new(shape: String, location_name: "operationName"))
|
838
873
|
Method.add_member(:request_parameters, Shapes::ShapeRef.new(shape: MapOfStringToBoolean, location_name: "requestParameters"))
|
839
874
|
Method.add_member(:request_models, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "requestModels"))
|
@@ -916,6 +951,7 @@ module Aws::APIGateway
|
|
916
951
|
PutMethodRequest.add_member(:operation_name, Shapes::ShapeRef.new(shape: String, location_name: "operationName"))
|
917
952
|
PutMethodRequest.add_member(:request_parameters, Shapes::ShapeRef.new(shape: MapOfStringToBoolean, location_name: "requestParameters"))
|
918
953
|
PutMethodRequest.add_member(:request_models, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "requestModels"))
|
954
|
+
PutMethodRequest.add_member(:request_validator_id, Shapes::ShapeRef.new(shape: String, location_name: "requestValidatorId"))
|
919
955
|
PutMethodRequest.struct_class = Types::PutMethodRequest
|
920
956
|
|
921
957
|
PutMethodResponseRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
@@ -940,6 +976,16 @@ module Aws::APIGateway
|
|
940
976
|
QuotaSettings.add_member(:period, Shapes::ShapeRef.new(shape: QuotaPeriodType, location_name: "period"))
|
941
977
|
QuotaSettings.struct_class = Types::QuotaSettings
|
942
978
|
|
979
|
+
RequestValidator.add_member(:id, Shapes::ShapeRef.new(shape: String, location_name: "id"))
|
980
|
+
RequestValidator.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "name"))
|
981
|
+
RequestValidator.add_member(:validate_request_body, Shapes::ShapeRef.new(shape: Boolean, location_name: "validateRequestBody"))
|
982
|
+
RequestValidator.add_member(:validate_request_parameters, Shapes::ShapeRef.new(shape: Boolean, location_name: "validateRequestParameters"))
|
983
|
+
RequestValidator.struct_class = Types::RequestValidator
|
984
|
+
|
985
|
+
RequestValidators.add_member(:position, Shapes::ShapeRef.new(shape: String, location_name: "position"))
|
986
|
+
RequestValidators.add_member(:items, Shapes::ShapeRef.new(shape: ListOfRequestValidator, location_name: "item"))
|
987
|
+
RequestValidators.struct_class = Types::RequestValidators
|
988
|
+
|
943
989
|
Resource.add_member(:id, Shapes::ShapeRef.new(shape: String, location_name: "id"))
|
944
990
|
Resource.add_member(:parent_id, Shapes::ShapeRef.new(shape: String, location_name: "parentId"))
|
945
991
|
Resource.add_member(:path_part, Shapes::ShapeRef.new(shape: String, location_name: "pathPart"))
|
@@ -1122,6 +1168,11 @@ module Aws::APIGateway
|
|
1122
1168
|
UpdateModelRequest.add_member(:patch_operations, Shapes::ShapeRef.new(shape: ListOfPatchOperation, location_name: "patchOperations"))
|
1123
1169
|
UpdateModelRequest.struct_class = Types::UpdateModelRequest
|
1124
1170
|
|
1171
|
+
UpdateRequestValidatorRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
1172
|
+
UpdateRequestValidatorRequest.add_member(:request_validator_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "requestvalidator_id"))
|
1173
|
+
UpdateRequestValidatorRequest.add_member(:patch_operations, Shapes::ShapeRef.new(shape: ListOfPatchOperation, location_name: "patchOperations"))
|
1174
|
+
UpdateRequestValidatorRequest.struct_class = Types::UpdateRequestValidatorRequest
|
1175
|
+
|
1125
1176
|
UpdateResourceRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
1126
1177
|
UpdateResourceRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "resource_id"))
|
1127
1178
|
UpdateResourceRequest.add_member(:patch_operations, Shapes::ShapeRef.new(shape: ListOfPatchOperation, location_name: "patchOperations"))
|
@@ -1297,6 +1348,19 @@ module Aws::APIGateway
|
|
1297
1348
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1298
1349
|
end)
|
1299
1350
|
|
1351
|
+
api.add_operation(:create_request_validator, Seahorse::Model::Operation.new.tap do |o|
|
1352
|
+
o.name = "CreateRequestValidator"
|
1353
|
+
o.http_method = "POST"
|
1354
|
+
o.http_request_uri = "/restapis/{restapi_id}/requestvalidators"
|
1355
|
+
o.input = Shapes::ShapeRef.new(shape: CreateRequestValidatorRequest)
|
1356
|
+
o.output = Shapes::ShapeRef.new(shape: RequestValidator)
|
1357
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1358
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
1359
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1360
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1361
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1362
|
+
end)
|
1363
|
+
|
1300
1364
|
api.add_operation(:create_resource, Seahorse::Model::Operation.new.tap do |o|
|
1301
1365
|
o.name = "CreateResource"
|
1302
1366
|
o.http_method = "POST"
|
@@ -1523,6 +1587,19 @@ module Aws::APIGateway
|
|
1523
1587
|
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1524
1588
|
end)
|
1525
1589
|
|
1590
|
+
api.add_operation(:delete_request_validator, Seahorse::Model::Operation.new.tap do |o|
|
1591
|
+
o.name = "DeleteRequestValidator"
|
1592
|
+
o.http_method = "DELETE"
|
1593
|
+
o.http_request_uri = "/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}"
|
1594
|
+
o.input = Shapes::ShapeRef.new(shape: DeleteRequestValidatorRequest)
|
1595
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1596
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
1597
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1598
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1599
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1600
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1601
|
+
end)
|
1602
|
+
|
1526
1603
|
api.add_operation(:delete_resource, Seahorse::Model::Operation.new.tap do |o|
|
1527
1604
|
o.name = "DeleteResource"
|
1528
1605
|
o.http_method = "DELETE"
|
@@ -1940,6 +2017,29 @@ module Aws::APIGateway
|
|
1940
2017
|
)
|
1941
2018
|
end)
|
1942
2019
|
|
2020
|
+
api.add_operation(:get_request_validator, Seahorse::Model::Operation.new.tap do |o|
|
2021
|
+
o.name = "GetRequestValidator"
|
2022
|
+
o.http_method = "GET"
|
2023
|
+
o.http_request_uri = "/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}"
|
2024
|
+
o.input = Shapes::ShapeRef.new(shape: GetRequestValidatorRequest)
|
2025
|
+
o.output = Shapes::ShapeRef.new(shape: RequestValidator)
|
2026
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
2027
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
2028
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
2029
|
+
end)
|
2030
|
+
|
2031
|
+
api.add_operation(:get_request_validators, Seahorse::Model::Operation.new.tap do |o|
|
2032
|
+
o.name = "GetRequestValidators"
|
2033
|
+
o.http_method = "GET"
|
2034
|
+
o.http_request_uri = "/restapis/{restapi_id}/requestvalidators"
|
2035
|
+
o.input = Shapes::ShapeRef.new(shape: GetRequestValidatorsRequest)
|
2036
|
+
o.output = Shapes::ShapeRef.new(shape: RequestValidators)
|
2037
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
2038
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
2039
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
2040
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
2041
|
+
end)
|
2042
|
+
|
1943
2043
|
api.add_operation(:get_resource, Seahorse::Model::Operation.new.tap do |o|
|
1944
2044
|
o.name = "GetResource"
|
1945
2045
|
o.http_method = "GET"
|
@@ -2445,6 +2545,18 @@ module Aws::APIGateway
|
|
2445
2545
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
2446
2546
|
end)
|
2447
2547
|
|
2548
|
+
api.add_operation(:update_request_validator, Seahorse::Model::Operation.new.tap do |o|
|
2549
|
+
o.name = "UpdateRequestValidator"
|
2550
|
+
o.http_method = "PATCH"
|
2551
|
+
o.http_request_uri = "/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}"
|
2552
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateRequestValidatorRequest)
|
2553
|
+
o.output = Shapes::ShapeRef.new(shape: RequestValidator)
|
2554
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
2555
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
2556
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
2557
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
2558
|
+
end)
|
2559
|
+
|
2448
2560
|
api.add_operation(:update_resource, Seahorse::Model::Operation.new.tap do |o|
|
2449
2561
|
o.name = "UpdateResource"
|
2450
2562
|
o.http_method = "PATCH"
|
@@ -117,15 +117,11 @@ module Aws::APIGateway
|
|
117
117
|
# @return [Boolean]
|
118
118
|
#
|
119
119
|
# @!attribute [rw] created_date
|
120
|
-
# The
|
121
|
-
#
|
122
|
-
#
|
123
|
-
#
|
124
|
-
# [1]: http://www.iso.org/iso/home/standards/iso8601.htm
|
120
|
+
# The timestamp when the API Key was created.
|
125
121
|
# @return [Time]
|
126
122
|
#
|
127
123
|
# @!attribute [rw] last_updated_date
|
128
|
-
#
|
124
|
+
# The timestamp when the API Key was last updated.
|
129
125
|
# @return [Time]
|
130
126
|
#
|
131
127
|
# @!attribute [rw] stage_keys
|
@@ -430,21 +426,11 @@ module Aws::APIGateway
|
|
430
426
|
# @return [String]
|
431
427
|
#
|
432
428
|
# @!attribute [rw] created_date
|
433
|
-
# The
|
434
|
-
# format][1].
|
435
|
-
#
|
436
|
-
#
|
437
|
-
#
|
438
|
-
# [1]: http://www.iso.org/iso/home/standards/iso8601.htm
|
429
|
+
# The timestamp when the client certificate was created.
|
439
430
|
# @return [Time]
|
440
431
|
#
|
441
432
|
# @!attribute [rw] expiration_date
|
442
|
-
# The
|
443
|
-
# format][1].
|
444
|
-
#
|
445
|
-
#
|
446
|
-
#
|
447
|
-
# [1]: http://www.iso.org/iso/home/standards/iso8601.htm
|
433
|
+
# The timestamp when the client certificate will expire.
|
448
434
|
# @return [Time]
|
449
435
|
#
|
450
436
|
class ClientCertificate < Struct.new(
|
@@ -806,37 +792,43 @@ module Aws::APIGateway
|
|
806
792
|
#
|
807
793
|
# {
|
808
794
|
# domain_name: "String", # required
|
809
|
-
# certificate_name: "String",
|
810
|
-
# certificate_body: "String",
|
811
|
-
# certificate_private_key: "String",
|
812
|
-
# certificate_chain: "String",
|
795
|
+
# certificate_name: "String",
|
796
|
+
# certificate_body: "String",
|
797
|
+
# certificate_private_key: "String",
|
798
|
+
# certificate_chain: "String",
|
799
|
+
# certificate_arn: "String",
|
813
800
|
# }
|
814
801
|
#
|
815
802
|
# @!attribute [rw] domain_name
|
816
|
-
# The name of the DomainName resource.
|
803
|
+
# (Required) The name of the DomainName resource.
|
817
804
|
# @return [String]
|
818
805
|
#
|
819
806
|
# @!attribute [rw] certificate_name
|
820
|
-
# The name of the certificate.
|
807
|
+
# The user-friendly name of the certificate.
|
821
808
|
# @return [String]
|
822
809
|
#
|
823
810
|
# @!attribute [rw] certificate_body
|
824
|
-
# The body of the server certificate provided by your
|
825
|
-
# authority.
|
811
|
+
# \[Deprecated\] The body of the server certificate provided by your
|
812
|
+
# certificate authority.
|
826
813
|
# @return [String]
|
827
814
|
#
|
828
815
|
# @!attribute [rw] certificate_private_key
|
829
|
-
# Your certificate's private key.
|
816
|
+
# \[Deprecated\] Your certificate's private key.
|
830
817
|
# @return [String]
|
831
818
|
#
|
832
819
|
# @!attribute [rw] certificate_chain
|
833
|
-
# The intermediate certificates and optionally the root
|
834
|
-
# one after the other without any blank lines. If you
|
835
|
-
# certificate, your certificate chain must start with
|
836
|
-
# certificates and end with the root certificate. Use the
|
837
|
-
# certificates that were provided by your certificate
|
838
|
-
# not include any intermediaries that are not in the
|
839
|
-
# path.
|
820
|
+
# \[Deprecated\] The intermediate certificates and optionally the root
|
821
|
+
# certificate, one after the other without any blank lines. If you
|
822
|
+
# include the root certificate, your certificate chain must start with
|
823
|
+
# intermediate certificates and end with the root certificate. Use the
|
824
|
+
# intermediate certificates that were provided by your certificate
|
825
|
+
# authority. Do not include any intermediaries that are not in the
|
826
|
+
# chain of trust path.
|
827
|
+
# @return [String]
|
828
|
+
#
|
829
|
+
# @!attribute [rw] certificate_arn
|
830
|
+
# The reference to an AWS-managed certificate. AWS Certificate Manager
|
831
|
+
# is the only supported source.
|
840
832
|
# @return [String]
|
841
833
|
#
|
842
834
|
class CreateDomainNameRequest < Struct.new(
|
@@ -844,7 +836,8 @@ module Aws::APIGateway
|
|
844
836
|
:certificate_name,
|
845
837
|
:certificate_body,
|
846
838
|
:certificate_private_key,
|
847
|
-
:certificate_chain
|
839
|
+
:certificate_chain,
|
840
|
+
:certificate_arn)
|
848
841
|
include Aws::Structure
|
849
842
|
end
|
850
843
|
|
@@ -895,6 +888,46 @@ module Aws::APIGateway
|
|
895
888
|
include Aws::Structure
|
896
889
|
end
|
897
890
|
|
891
|
+
# Creates a RequestValidator of a given RestApi.
|
892
|
+
#
|
893
|
+
# @note When making an API call, you may pass CreateRequestValidatorRequest
|
894
|
+
# data as a hash:
|
895
|
+
#
|
896
|
+
# {
|
897
|
+
# rest_api_id: "String", # required
|
898
|
+
# name: "String",
|
899
|
+
# validate_request_body: false,
|
900
|
+
# validate_request_parameters: false,
|
901
|
+
# }
|
902
|
+
#
|
903
|
+
# @!attribute [rw] rest_api_id
|
904
|
+
# \[Required\] The identifier of the RestApi for which the
|
905
|
+
# RequestValidator is created.
|
906
|
+
# @return [String]
|
907
|
+
#
|
908
|
+
# @!attribute [rw] name
|
909
|
+
# The name of the to-be-created RequestValidator.
|
910
|
+
# @return [String]
|
911
|
+
#
|
912
|
+
# @!attribute [rw] validate_request_body
|
913
|
+
# A Boolean flag to indicate whether to validate request body
|
914
|
+
# according to the configured model schema for the method (`true`) or
|
915
|
+
# not (`false`).
|
916
|
+
# @return [Boolean]
|
917
|
+
#
|
918
|
+
# @!attribute [rw] validate_request_parameters
|
919
|
+
# A Boolean flag to indicate whether to validate request parameters,
|
920
|
+
# `true`, or not `false`.
|
921
|
+
# @return [Boolean]
|
922
|
+
#
|
923
|
+
class CreateRequestValidatorRequest < Struct.new(
|
924
|
+
:rest_api_id,
|
925
|
+
:name,
|
926
|
+
:validate_request_body,
|
927
|
+
:validate_request_parameters)
|
928
|
+
include Aws::Structure
|
929
|
+
end
|
930
|
+
|
898
931
|
# Requests Amazon API Gateway to create a Resource resource.
|
899
932
|
#
|
900
933
|
# @note When making an API call, you may pass CreateResourceRequest
|
@@ -1457,6 +1490,31 @@ module Aws::APIGateway
|
|
1457
1490
|
include Aws::Structure
|
1458
1491
|
end
|
1459
1492
|
|
1493
|
+
# Deletes a specified RequestValidator of a given RestApi.
|
1494
|
+
#
|
1495
|
+
# @note When making an API call, you may pass DeleteRequestValidatorRequest
|
1496
|
+
# data as a hash:
|
1497
|
+
#
|
1498
|
+
# {
|
1499
|
+
# rest_api_id: "String", # required
|
1500
|
+
# request_validator_id: "String", # required
|
1501
|
+
# }
|
1502
|
+
#
|
1503
|
+
# @!attribute [rw] rest_api_id
|
1504
|
+
# \[Required\] The identifier of the RestApi from which the given
|
1505
|
+
# RequestValidator is deleted.
|
1506
|
+
# @return [String]
|
1507
|
+
#
|
1508
|
+
# @!attribute [rw] request_validator_id
|
1509
|
+
# \[Required\] The identifier of the RequestValidator to be deleted.
|
1510
|
+
# @return [String]
|
1511
|
+
#
|
1512
|
+
class DeleteRequestValidatorRequest < Struct.new(
|
1513
|
+
:rest_api_id,
|
1514
|
+
:request_validator_id)
|
1515
|
+
include Aws::Structure
|
1516
|
+
end
|
1517
|
+
|
1460
1518
|
# Request to delete a Resource.
|
1461
1519
|
#
|
1462
1520
|
# @note When making an API call, you may pass DeleteResourceRequest
|
@@ -1761,8 +1819,8 @@ module Aws::APIGateway
|
|
1761
1819
|
# `AUTHORIZER`, `MODEL`, `RESOURCE`, `METHOD`, `PATH_PARAMETER`,
|
1762
1820
|
# `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`,
|
1763
1821
|
# `RESPONSE_HEADER`, and `RESPONSE_BODY`. Content inheritance does not
|
1764
|
-
# apply to any entity of the `API`, `AUTHROZER`, `MODEL`,
|
1765
|
-
# `RESOURCE` type.
|
1822
|
+
# apply to any entity of the `API`, `AUTHROZER`, `METHOD`, `MODEL`,
|
1823
|
+
# `REQUEST_BODY`, or `RESOURCE` type.
|
1766
1824
|
# @return [String]
|
1767
1825
|
#
|
1768
1826
|
# @!attribute [rw] path
|
@@ -1925,12 +1983,13 @@ module Aws::APIGateway
|
|
1925
1983
|
# The name of the certificate.
|
1926
1984
|
# @return [String]
|
1927
1985
|
#
|
1928
|
-
# @!attribute [rw]
|
1929
|
-
# The
|
1930
|
-
#
|
1931
|
-
#
|
1986
|
+
# @!attribute [rw] certificate_arn
|
1987
|
+
# The reference to an AWS-managed certificate. AWS Certificate Manager
|
1988
|
+
# is the only supported source.
|
1989
|
+
# @return [String]
|
1932
1990
|
#
|
1933
|
-
#
|
1991
|
+
# @!attribute [rw] certificate_upload_date
|
1992
|
+
# The timestamp when the certificate was uploaded.
|
1934
1993
|
# @return [Time]
|
1935
1994
|
#
|
1936
1995
|
# @!attribute [rw] distribution_domain_name
|
@@ -1945,6 +2004,7 @@ module Aws::APIGateway
|
|
1945
2004
|
class DomainName < Struct.new(
|
1946
2005
|
:domain_name,
|
1947
2006
|
:certificate_name,
|
2007
|
+
:certificate_arn,
|
1948
2008
|
:certificate_upload_date,
|
1949
2009
|
:distribution_domain_name)
|
1950
2010
|
include Aws::Structure
|
@@ -2109,8 +2169,7 @@ module Aws::APIGateway
|
|
2109
2169
|
# }
|
2110
2170
|
#
|
2111
2171
|
# @!attribute [rw] position
|
2112
|
-
# The position
|
2113
|
-
# about.
|
2172
|
+
# The current pagination position in the paged result set.
|
2114
2173
|
# @return [String]
|
2115
2174
|
#
|
2116
2175
|
# @!attribute [rw] limit
|
@@ -2180,12 +2239,11 @@ module Aws::APIGateway
|
|
2180
2239
|
# @return [String]
|
2181
2240
|
#
|
2182
2241
|
# @!attribute [rw] position
|
2183
|
-
#
|
2184
|
-
# position will specify where to start the next page of results.
|
2242
|
+
# The current pagination position in the paged result set.
|
2185
2243
|
# @return [String]
|
2186
2244
|
#
|
2187
2245
|
# @!attribute [rw] limit
|
2188
|
-
#
|
2246
|
+
# The maximum number of returned results per page.
|
2189
2247
|
# @return [Integer]
|
2190
2248
|
#
|
2191
2249
|
class GetAuthorizersRequest < Struct.new(
|
@@ -2239,14 +2297,12 @@ module Aws::APIGateway
|
|
2239
2297
|
# @return [String]
|
2240
2298
|
#
|
2241
2299
|
# @!attribute [rw] position
|
2242
|
-
# The position
|
2243
|
-
# collection to get information about.
|
2300
|
+
# The current pagination position in the paged result set.
|
2244
2301
|
# @return [String]
|
2245
2302
|
#
|
2246
2303
|
# @!attribute [rw] limit
|
2247
|
-
# The maximum number of
|
2248
|
-
#
|
2249
|
-
# integer between 1 - 500.
|
2304
|
+
# The maximum number of returned results per page. The value is 25 by
|
2305
|
+
# default and could be between 1 - 500.
|
2250
2306
|
# @return [Integer]
|
2251
2307
|
#
|
2252
2308
|
class GetBasePathMappingsRequest < Struct.new(
|
@@ -2287,14 +2343,12 @@ module Aws::APIGateway
|
|
2287
2343
|
# }
|
2288
2344
|
#
|
2289
2345
|
# @!attribute [rw] position
|
2290
|
-
# The position
|
2291
|
-
# collection to get information about.
|
2346
|
+
# The current pagination position in the paged result set.
|
2292
2347
|
# @return [String]
|
2293
2348
|
#
|
2294
2349
|
# @!attribute [rw] limit
|
2295
|
-
# The maximum number of
|
2296
|
-
#
|
2297
|
-
# integer between 1 - 500.
|
2350
|
+
# The maximum number of returned results per page. The value is 25 by
|
2351
|
+
# default and could be between 1 - 500.
|
2298
2352
|
# @return [Integer]
|
2299
2353
|
#
|
2300
2354
|
class GetClientCertificatesRequest < Struct.new(
|
@@ -2312,6 +2366,7 @@ module Aws::APIGateway
|
|
2312
2366
|
# {
|
2313
2367
|
# rest_api_id: "String", # required
|
2314
2368
|
# deployment_id: "String", # required
|
2369
|
+
# embed: ["String"],
|
2315
2370
|
# }
|
2316
2371
|
#
|
2317
2372
|
# @!attribute [rw] rest_api_id
|
@@ -2323,9 +2378,24 @@ module Aws::APIGateway
|
|
2323
2378
|
# The identifier of the Deployment resource to get information about.
|
2324
2379
|
# @return [String]
|
2325
2380
|
#
|
2381
|
+
# @!attribute [rw] embed
|
2382
|
+
# A query parameter to retrieve the specified embedded resources of
|
2383
|
+
# the returned Deployment resource in the response. In a REST API
|
2384
|
+
# call, this `embed` parameter value is a list of comma-separated
|
2385
|
+
# strings, as in `GET
|
2386
|
+
# /restapis/\{restapi_id\}/deployments/\{deployment_id\}?embed=var1,var2`.
|
2387
|
+
# The SDK and other platform-dependent libraries might use a different
|
2388
|
+
# format for the list. Currently, this request supports only retrieval
|
2389
|
+
# of the embedded API summary this way. Hence, the parameter value
|
2390
|
+
# must be a single-valued list containing only the `"apisummary"`
|
2391
|
+
# string. For example, `GET
|
2392
|
+
# /restapis/\{restapi_id\}/deployments/\{deployment_id\}?embed=apisummary`.
|
2393
|
+
# @return [Array<String>]
|
2394
|
+
#
|
2326
2395
|
class GetDeploymentRequest < Struct.new(
|
2327
2396
|
:rest_api_id,
|
2328
|
-
:deployment_id
|
2397
|
+
:deployment_id,
|
2398
|
+
:embed)
|
2329
2399
|
include Aws::Structure
|
2330
2400
|
end
|
2331
2401
|
|
@@ -2347,14 +2417,12 @@ module Aws::APIGateway
|
|
2347
2417
|
# @return [String]
|
2348
2418
|
#
|
2349
2419
|
# @!attribute [rw] position
|
2350
|
-
# The
|
2351
|
-
# get information about.
|
2420
|
+
# The current pagination position in the paged result set.
|
2352
2421
|
# @return [String]
|
2353
2422
|
#
|
2354
2423
|
# @!attribute [rw] limit
|
2355
|
-
# The maximum number of
|
2356
|
-
#
|
2357
|
-
# between 1 - 500.
|
2424
|
+
# The maximum number of returned results per page. The value is 25 by
|
2425
|
+
# default and could be between 1 - 500.
|
2358
2426
|
# @return [Integer]
|
2359
2427
|
#
|
2360
2428
|
class GetDeploymentsRequest < Struct.new(
|
@@ -2423,12 +2491,11 @@ module Aws::APIGateway
|
|
2423
2491
|
# @return [String]
|
2424
2492
|
#
|
2425
2493
|
# @!attribute [rw] position
|
2426
|
-
# The position
|
2427
|
-
# DocumentationParts collection.
|
2494
|
+
# The current pagination position in the paged result set.
|
2428
2495
|
# @return [String]
|
2429
2496
|
#
|
2430
2497
|
# @!attribute [rw] limit
|
2431
|
-
# The
|
2498
|
+
# The maximum number of returned results per page.
|
2432
2499
|
# @return [Integer]
|
2433
2500
|
#
|
2434
2501
|
class GetDocumentationPartsRequest < Struct.new(
|
@@ -2484,12 +2551,11 @@ module Aws::APIGateway
|
|
2484
2551
|
# @return [String]
|
2485
2552
|
#
|
2486
2553
|
# @!attribute [rw] position
|
2487
|
-
# The position
|
2488
|
-
# DocumentationVersions collection.
|
2554
|
+
# The current pagination position in the paged result set.
|
2489
2555
|
# @return [String]
|
2490
2556
|
#
|
2491
2557
|
# @!attribute [rw] limit
|
2492
|
-
# The
|
2558
|
+
# The maximum number of returned results per page.
|
2493
2559
|
# @return [Integer]
|
2494
2560
|
#
|
2495
2561
|
class GetDocumentationVersionsRequest < Struct.new(
|
@@ -2528,13 +2594,12 @@ module Aws::APIGateway
|
|
2528
2594
|
# }
|
2529
2595
|
#
|
2530
2596
|
# @!attribute [rw] position
|
2531
|
-
# The position
|
2597
|
+
# The current pagination position in the paged result set.
|
2532
2598
|
# @return [String]
|
2533
2599
|
#
|
2534
2600
|
# @!attribute [rw] limit
|
2535
|
-
# The maximum number of
|
2536
|
-
#
|
2537
|
-
# between 1 - 500.
|
2601
|
+
# The maximum number of returned results per page. The value is 25 by
|
2602
|
+
# default and could be between 1 - 500.
|
2538
2603
|
# @return [Integer]
|
2539
2604
|
#
|
2540
2605
|
class GetDomainNamesRequest < Struct.new(
|
@@ -2803,14 +2868,12 @@ module Aws::APIGateway
|
|
2803
2868
|
# @return [String]
|
2804
2869
|
#
|
2805
2870
|
# @!attribute [rw] position
|
2806
|
-
# The
|
2807
|
-
# get information about.
|
2871
|
+
# The current pagination position in the paged result set.
|
2808
2872
|
# @return [String]
|
2809
2873
|
#
|
2810
2874
|
# @!attribute [rw] limit
|
2811
|
-
# The maximum number of
|
2812
|
-
#
|
2813
|
-
# 500.
|
2875
|
+
# The maximum number of returned results per page. The value is 25 by
|
2876
|
+
# default and could be between 1 - 500.
|
2814
2877
|
# @return [Integer]
|
2815
2878
|
#
|
2816
2879
|
class GetModelsRequest < Struct.new(
|
@@ -2820,6 +2883,62 @@ module Aws::APIGateway
|
|
2820
2883
|
include Aws::Structure
|
2821
2884
|
end
|
2822
2885
|
|
2886
|
+
# Gets a RequestValidator of a given RestApi.
|
2887
|
+
#
|
2888
|
+
# @note When making an API call, you may pass GetRequestValidatorRequest
|
2889
|
+
# data as a hash:
|
2890
|
+
#
|
2891
|
+
# {
|
2892
|
+
# rest_api_id: "String", # required
|
2893
|
+
# request_validator_id: "String", # required
|
2894
|
+
# }
|
2895
|
+
#
|
2896
|
+
# @!attribute [rw] rest_api_id
|
2897
|
+
# \[Required\] The identifier of the RestApi to which the specified
|
2898
|
+
# RequestValidator belongs.
|
2899
|
+
# @return [String]
|
2900
|
+
#
|
2901
|
+
# @!attribute [rw] request_validator_id
|
2902
|
+
# \[Required\] The identifier of the RequestValidator to be retrieved.
|
2903
|
+
# @return [String]
|
2904
|
+
#
|
2905
|
+
class GetRequestValidatorRequest < Struct.new(
|
2906
|
+
:rest_api_id,
|
2907
|
+
:request_validator_id)
|
2908
|
+
include Aws::Structure
|
2909
|
+
end
|
2910
|
+
|
2911
|
+
# Gets the RequestValidators collection of a given RestApi.
|
2912
|
+
#
|
2913
|
+
# @note When making an API call, you may pass GetRequestValidatorsRequest
|
2914
|
+
# data as a hash:
|
2915
|
+
#
|
2916
|
+
# {
|
2917
|
+
# rest_api_id: "String", # required
|
2918
|
+
# position: "String",
|
2919
|
+
# limit: 1,
|
2920
|
+
# }
|
2921
|
+
#
|
2922
|
+
# @!attribute [rw] rest_api_id
|
2923
|
+
# \[Required\] The identifier of a RestApi to which the
|
2924
|
+
# RequestValidators collection belongs.
|
2925
|
+
# @return [String]
|
2926
|
+
#
|
2927
|
+
# @!attribute [rw] position
|
2928
|
+
# The current pagination position in the paged result set.
|
2929
|
+
# @return [String]
|
2930
|
+
#
|
2931
|
+
# @!attribute [rw] limit
|
2932
|
+
# The maximum number of returned results per page.
|
2933
|
+
# @return [Integer]
|
2934
|
+
#
|
2935
|
+
class GetRequestValidatorsRequest < Struct.new(
|
2936
|
+
:rest_api_id,
|
2937
|
+
:position,
|
2938
|
+
:limit)
|
2939
|
+
include Aws::Structure
|
2940
|
+
end
|
2941
|
+
|
2823
2942
|
# Request to list information about a resource.
|
2824
2943
|
#
|
2825
2944
|
# @note When making an API call, you may pass GetResourceRequest
|
@@ -2828,6 +2947,7 @@ module Aws::APIGateway
|
|
2828
2947
|
# {
|
2829
2948
|
# rest_api_id: "String", # required
|
2830
2949
|
# resource_id: "String", # required
|
2950
|
+
# embed: ["String"],
|
2831
2951
|
# }
|
2832
2952
|
#
|
2833
2953
|
# @!attribute [rw] rest_api_id
|
@@ -2838,9 +2958,20 @@ module Aws::APIGateway
|
|
2838
2958
|
# The identifier for the Resource resource.
|
2839
2959
|
# @return [String]
|
2840
2960
|
#
|
2961
|
+
# @!attribute [rw] embed
|
2962
|
+
# A query parameter to retrieve the specified resources embedded in
|
2963
|
+
# the returned Resource representation in the response. This `embed`
|
2964
|
+
# parameter value is a list of comma-separated strings. Currently, the
|
2965
|
+
# request supports only retrieval of the embedded Method resources
|
2966
|
+
# this way. The query parameter value must be a single-valued list and
|
2967
|
+
# contain the `"methods"` string. For example, `GET
|
2968
|
+
# /restapis/\{restapi_id\}/resources/\{resource_id\}?embed=methods`.
|
2969
|
+
# @return [Array<String>]
|
2970
|
+
#
|
2841
2971
|
class GetResourceRequest < Struct.new(
|
2842
2972
|
:rest_api_id,
|
2843
|
-
:resource_id
|
2973
|
+
:resource_id,
|
2974
|
+
:embed)
|
2844
2975
|
include Aws::Structure
|
2845
2976
|
end
|
2846
2977
|
|
@@ -2853,6 +2984,7 @@ module Aws::APIGateway
|
|
2853
2984
|
# rest_api_id: "String", # required
|
2854
2985
|
# position: "String",
|
2855
2986
|
# limit: 1,
|
2987
|
+
# embed: ["String"],
|
2856
2988
|
# }
|
2857
2989
|
#
|
2858
2990
|
# @!attribute [rw] rest_api_id
|
@@ -2860,20 +2992,29 @@ module Aws::APIGateway
|
|
2860
2992
|
# @return [String]
|
2861
2993
|
#
|
2862
2994
|
# @!attribute [rw] position
|
2863
|
-
# The
|
2864
|
-
# resource to get information about.
|
2995
|
+
# The current pagination position in the paged result set.
|
2865
2996
|
# @return [String]
|
2866
2997
|
#
|
2867
2998
|
# @!attribute [rw] limit
|
2868
|
-
# The maximum number of
|
2869
|
-
#
|
2870
|
-
# between 1 - 500.
|
2999
|
+
# The maximum number of returned results per page. The value is 25 by
|
3000
|
+
# default and could be between 1 - 500.
|
2871
3001
|
# @return [Integer]
|
2872
3002
|
#
|
3003
|
+
# @!attribute [rw] embed
|
3004
|
+
# A query parameter used to retrieve the specified resources embedded
|
3005
|
+
# in the returned Resources resource in the response. This `embed`
|
3006
|
+
# parameter value is a list of comma-separated strings. Currently, the
|
3007
|
+
# request supports only retrieval of the embedded Method resources
|
3008
|
+
# this way. The query parameter value must be a single-valued list and
|
3009
|
+
# contain the `"methods"` string. For example, `GET
|
3010
|
+
# /restapis/\{restapi_id\}/resources?embed=methods`.
|
3011
|
+
# @return [Array<String>]
|
3012
|
+
#
|
2873
3013
|
class GetResourcesRequest < Struct.new(
|
2874
3014
|
:rest_api_id,
|
2875
3015
|
:position,
|
2876
|
-
:limit
|
3016
|
+
:limit,
|
3017
|
+
:embed)
|
2877
3018
|
include Aws::Structure
|
2878
3019
|
end
|
2879
3020
|
|
@@ -2907,14 +3048,12 @@ module Aws::APIGateway
|
|
2907
3048
|
# }
|
2908
3049
|
#
|
2909
3050
|
# @!attribute [rw] position
|
2910
|
-
# The
|
2911
|
-
# get information about.
|
3051
|
+
# The current pagination position in the paged result set.
|
2912
3052
|
# @return [String]
|
2913
3053
|
#
|
2914
3054
|
# @!attribute [rw] limit
|
2915
|
-
# The maximum number of
|
2916
|
-
#
|
2917
|
-
# between 1 - 500.
|
3055
|
+
# The maximum number of returned results per page. The value is 25 by
|
3056
|
+
# default and could be between 1 - 500.
|
2918
3057
|
# @return [Integer]
|
2919
3058
|
#
|
2920
3059
|
class GetRestApisRequest < Struct.new(
|
@@ -2995,11 +3134,11 @@ module Aws::APIGateway
|
|
2995
3134
|
# }
|
2996
3135
|
#
|
2997
3136
|
# @!attribute [rw] position
|
2998
|
-
# The
|
3137
|
+
# The current pagination position in the paged result set.
|
2999
3138
|
# @return [String]
|
3000
3139
|
#
|
3001
3140
|
# @!attribute [rw] limit
|
3002
|
-
# The maximum number of
|
3141
|
+
# The maximum number of returned results per page.
|
3003
3142
|
# @return [Integer]
|
3004
3143
|
#
|
3005
3144
|
class GetSdkTypesRequest < Struct.new(
|
@@ -3105,13 +3244,11 @@ module Aws::APIGateway
|
|
3105
3244
|
# @return [String]
|
3106
3245
|
#
|
3107
3246
|
# @!attribute [rw] position
|
3108
|
-
#
|
3109
|
-
# position of a usage plan key.
|
3247
|
+
# The current pagination position in the paged result set.
|
3110
3248
|
# @return [String]
|
3111
3249
|
#
|
3112
3250
|
# @!attribute [rw] limit
|
3113
|
-
#
|
3114
|
-
# returned by the GET request.
|
3251
|
+
# The maximum number of returned results per page.
|
3115
3252
|
# @return [Integer]
|
3116
3253
|
#
|
3117
3254
|
# @!attribute [rw] name_query
|
@@ -3157,8 +3294,7 @@ module Aws::APIGateway
|
|
3157
3294
|
# }
|
3158
3295
|
#
|
3159
3296
|
# @!attribute [rw] position
|
3160
|
-
# The
|
3161
|
-
# to-be-retrieved UsagePlan resource.
|
3297
|
+
# The current pagination position in the paged result set.
|
3162
3298
|
# @return [String]
|
3163
3299
|
#
|
3164
3300
|
# @!attribute [rw] key_id
|
@@ -3166,7 +3302,7 @@ module Aws::APIGateway
|
|
3166
3302
|
# @return [String]
|
3167
3303
|
#
|
3168
3304
|
# @!attribute [rw] limit
|
3169
|
-
# The number of
|
3305
|
+
# The maximum number of returned results per page.
|
3170
3306
|
# @return [Integer]
|
3171
3307
|
#
|
3172
3308
|
class GetUsagePlansRequest < Struct.new(
|
@@ -3208,11 +3344,11 @@ module Aws::APIGateway
|
|
3208
3344
|
# @return [String]
|
3209
3345
|
#
|
3210
3346
|
# @!attribute [rw] position
|
3211
|
-
#
|
3347
|
+
# The current pagination position in the paged result set.
|
3212
3348
|
# @return [String]
|
3213
3349
|
#
|
3214
3350
|
# @!attribute [rw] limit
|
3215
|
-
# The maximum number of results
|
3351
|
+
# The maximum number of returned results per page.
|
3216
3352
|
# @return [Integer]
|
3217
3353
|
#
|
3218
3354
|
class GetUsageRequest < Struct.new(
|
@@ -3652,7 +3788,10 @@ module Aws::APIGateway
|
|
3652
3788
|
# @return [String]
|
3653
3789
|
#
|
3654
3790
|
# @!attribute [rw] authorization_type
|
3655
|
-
# The method's authorization type.
|
3791
|
+
# The method's authorization type. Valid values are `NONE` for open
|
3792
|
+
# access, `AWS_IAM` for using AWS IAM permissions, `CUSTOM` for using
|
3793
|
+
# a custom authorizer, or `COGNITO_USER_POOLS` for using a Cognito
|
3794
|
+
# user pool.
|
3656
3795
|
# @return [String]
|
3657
3796
|
#
|
3658
3797
|
# @!attribute [rw] authorizer_id
|
@@ -3665,6 +3804,10 @@ module Aws::APIGateway
|
|
3665
3804
|
# invoke this method.
|
3666
3805
|
# @return [Boolean]
|
3667
3806
|
#
|
3807
|
+
# @!attribute [rw] request_validator_id
|
3808
|
+
# The identifier of a RequestValidator for request validation.
|
3809
|
+
# @return [String]
|
3810
|
+
#
|
3668
3811
|
# @!attribute [rw] operation_name
|
3669
3812
|
# A human-friendly operation identifier for the method. For example,
|
3670
3813
|
# you can assign the `operationName` of `ListPets` for the `GET /pets`
|
@@ -3772,6 +3915,7 @@ module Aws::APIGateway
|
|
3772
3915
|
:authorization_type,
|
3773
3916
|
:authorizer_id,
|
3774
3917
|
:api_key_required,
|
3918
|
+
:request_validator_id,
|
3775
3919
|
:operation_name,
|
3776
3920
|
:request_parameters,
|
3777
3921
|
:request_models,
|
@@ -3943,7 +4087,10 @@ module Aws::APIGateway
|
|
3943
4087
|
# time.
|
3944
4088
|
#
|
3945
4089
|
# @!attribute [rw] authorization_type
|
3946
|
-
#
|
4090
|
+
# The method's authorization type. Valid values are `NONE` for open
|
4091
|
+
# access, `AWS_IAM` for using AWS IAM permissions, `CUSTOM` for using
|
4092
|
+
# a custom authorizer, or `COGNITO_USER_POOLS` for using a Cognito
|
4093
|
+
# user pool.
|
3947
4094
|
# @return [String]
|
3948
4095
|
#
|
3949
4096
|
# @!attribute [rw] api_key_required
|
@@ -4081,7 +4228,14 @@ module Aws::APIGateway
|
|
4081
4228
|
# @return [String]
|
4082
4229
|
#
|
4083
4230
|
# @!attribute [rw] value
|
4084
|
-
# The new target value of the update operation.
|
4231
|
+
# The new target value of the update operation. When using AWS CLI to
|
4232
|
+
# update a property of a JSON value, enclose the JSON object with a
|
4233
|
+
# pair of single quotes in a Linux shell, e.g., '\\\{"a": ...\\}'.
|
4234
|
+
# In a Windows shell, see [Using JSON for Parameters][1].
|
4235
|
+
#
|
4236
|
+
#
|
4237
|
+
#
|
4238
|
+
# [1]: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json
|
4085
4239
|
# @return [String]
|
4086
4240
|
#
|
4087
4241
|
# @!attribute [rw] from
|
@@ -4342,6 +4496,7 @@ module Aws::APIGateway
|
|
4342
4496
|
# request_models: {
|
4343
4497
|
# "String" => "String",
|
4344
4498
|
# },
|
4499
|
+
# request_validator_id: "String",
|
4345
4500
|
# }
|
4346
4501
|
#
|
4347
4502
|
# @!attribute [rw] rest_api_id
|
@@ -4357,7 +4512,10 @@ module Aws::APIGateway
|
|
4357
4512
|
# @return [String]
|
4358
4513
|
#
|
4359
4514
|
# @!attribute [rw] authorization_type
|
4360
|
-
#
|
4515
|
+
# The method's authorization type. Valid values are `NONE` for open
|
4516
|
+
# access, `AWS_IAM` for using AWS IAM permissions, `CUSTOM` for using
|
4517
|
+
# a custom authorizer, or `COGNITO_USER_POOLS` for using a Cognito
|
4518
|
+
# user pool.
|
4361
4519
|
# @return [String]
|
4362
4520
|
#
|
4363
4521
|
# @!attribute [rw] authorizer_id
|
@@ -4398,6 +4556,11 @@ module Aws::APIGateway
|
|
4398
4556
|
# type as the key and a Model name as the value.
|
4399
4557
|
# @return [Hash<String,String>]
|
4400
4558
|
#
|
4559
|
+
# @!attribute [rw] request_validator_id
|
4560
|
+
# The identifier of a RequestValidator for validating the method
|
4561
|
+
# request.
|
4562
|
+
# @return [String]
|
4563
|
+
#
|
4401
4564
|
class PutMethodRequest < Struct.new(
|
4402
4565
|
:rest_api_id,
|
4403
4566
|
:resource_id,
|
@@ -4407,7 +4570,8 @@ module Aws::APIGateway
|
|
4407
4570
|
:api_key_required,
|
4408
4571
|
:operation_name,
|
4409
4572
|
:request_parameters,
|
4410
|
-
:request_models
|
4573
|
+
:request_models,
|
4574
|
+
:request_validator_id)
|
4411
4575
|
include Aws::Structure
|
4412
4576
|
end
|
4413
4577
|
|
@@ -4562,6 +4726,83 @@ module Aws::APIGateway
|
|
4562
4726
|
include Aws::Structure
|
4563
4727
|
end
|
4564
4728
|
|
4729
|
+
# A set of validation rules for incoming Method requests.
|
4730
|
+
#
|
4731
|
+
# <div class="remarks" markdown="1">
|
4732
|
+
# In Swagger, a RequestValidator of an API is defined by the
|
4733
|
+
# [x-amazon-apigateway-request-validators.requestValidator][1] object.
|
4734
|
+
# It the referenced using the [x-amazon-apigateway-request-validator][2]
|
4735
|
+
# property.
|
4736
|
+
#
|
4737
|
+
# </div>
|
4738
|
+
#
|
4739
|
+
# <div class="seeAlso">
|
4740
|
+
# [Enable Basic Request Validation in API Gateway][3]
|
4741
|
+
# </div>
|
4742
|
+
#
|
4743
|
+
#
|
4744
|
+
#
|
4745
|
+
# [1]: http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.requestValidator.html
|
4746
|
+
# [2]: http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validator
|
4747
|
+
# [3]: http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html
|
4748
|
+
#
|
4749
|
+
# @!attribute [rw] id
|
4750
|
+
# The identifier of this RequestValidator.
|
4751
|
+
# @return [String]
|
4752
|
+
#
|
4753
|
+
# @!attribute [rw] name
|
4754
|
+
# The name of this RequestValidator
|
4755
|
+
# @return [String]
|
4756
|
+
#
|
4757
|
+
# @!attribute [rw] validate_request_body
|
4758
|
+
# A Boolean flag to indicate whether to validate a request body
|
4759
|
+
# according to the configured Model schema.
|
4760
|
+
# @return [Boolean]
|
4761
|
+
#
|
4762
|
+
# @!attribute [rw] validate_request_parameters
|
4763
|
+
# A Boolean flag to indicate whether to validate request parameters
|
4764
|
+
# (`true`) or not (`false`).
|
4765
|
+
# @return [Boolean]
|
4766
|
+
#
|
4767
|
+
class RequestValidator < Struct.new(
|
4768
|
+
:id,
|
4769
|
+
:name,
|
4770
|
+
:validate_request_body,
|
4771
|
+
:validate_request_parameters)
|
4772
|
+
include Aws::Structure
|
4773
|
+
end
|
4774
|
+
|
4775
|
+
# A collection of RequestValidator resources of a given RestApi.
|
4776
|
+
#
|
4777
|
+
# <div class="remarks" markdown="1">
|
4778
|
+
# In Swagger, the RequestValidators of an API is defined by the
|
4779
|
+
# [x-amazon-apigateway-request-validators][1] extension.
|
4780
|
+
#
|
4781
|
+
# </div>
|
4782
|
+
#
|
4783
|
+
# <div class="seeAlso">
|
4784
|
+
# [Enable Basic Request Validation in API Gateway][2]
|
4785
|
+
# </div>
|
4786
|
+
#
|
4787
|
+
#
|
4788
|
+
#
|
4789
|
+
# [1]: http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html#api-gateway-swagger-extensions-request-validators.html
|
4790
|
+
# [2]: http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html
|
4791
|
+
#
|
4792
|
+
# @!attribute [rw] position
|
4793
|
+
# @return [String]
|
4794
|
+
#
|
4795
|
+
# @!attribute [rw] items
|
4796
|
+
# The current page of RequestValidator resources in the
|
4797
|
+
# RequestValidators collection.
|
4798
|
+
# @return [Array<Types::RequestValidator>]
|
4799
|
+
#
|
4800
|
+
class RequestValidators < Struct.new(
|
4801
|
+
:position,
|
4802
|
+
:items)
|
4803
|
+
include Aws::Structure
|
4804
|
+
end
|
4805
|
+
|
4565
4806
|
# Represents an API resource.
|
4566
4807
|
#
|
4567
4808
|
# <div class="seeAlso">
|
@@ -4603,7 +4844,7 @@ module Aws::APIGateway
|
|
4603
4844
|
#
|
4604
4845
|
# ##### Request
|
4605
4846
|
#
|
4606
|
-
# GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date:
|
4847
|
+
# GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential=\{access_key_ID\}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=\{sig4_hash\}
|
4607
4848
|
#
|
4608
4849
|
# ##### Response
|
4609
4850
|
#
|
@@ -4674,11 +4915,7 @@ module Aws::APIGateway
|
|
4674
4915
|
# @return [String]
|
4675
4916
|
#
|
4676
4917
|
# @!attribute [rw] created_date
|
4677
|
-
# The
|
4678
|
-
#
|
4679
|
-
#
|
4680
|
-
#
|
4681
|
-
# [1]: http://www.iso.org/iso/home/standards/iso8601.htm
|
4918
|
+
# The timestamp when the API was created.
|
4682
4919
|
# @return [Time]
|
4683
4920
|
#
|
4684
4921
|
# @!attribute [rw] version
|
@@ -4887,21 +5124,11 @@ module Aws::APIGateway
|
|
4887
5124
|
# @return [String]
|
4888
5125
|
#
|
4889
5126
|
# @!attribute [rw] created_date
|
4890
|
-
# The
|
4891
|
-
# format][1].
|
4892
|
-
#
|
4893
|
-
#
|
4894
|
-
#
|
4895
|
-
# [1]: http://www.iso.org/iso/home/standards/iso8601.htm
|
5127
|
+
# The timestamp when the stage was created.
|
4896
5128
|
# @return [Time]
|
4897
5129
|
#
|
4898
5130
|
# @!attribute [rw] last_updated_date
|
4899
|
-
# The
|
4900
|
-
# in [ISO 8601 format][1].
|
4901
|
-
#
|
4902
|
-
#
|
4903
|
-
#
|
4904
|
-
# [1]: http://www.iso.org/iso/home/standards/iso8601.htm
|
5131
|
+
# The timestamp when the stage last updated.
|
4905
5132
|
# @return [Time]
|
4906
5133
|
#
|
4907
5134
|
class Stage < Struct.new(
|
@@ -5785,6 +6012,45 @@ module Aws::APIGateway
|
|
5785
6012
|
include Aws::Structure
|
5786
6013
|
end
|
5787
6014
|
|
6015
|
+
# Updates a RequestValidator of a given RestApi.
|
6016
|
+
#
|
6017
|
+
# @note When making an API call, you may pass UpdateRequestValidatorRequest
|
6018
|
+
# data as a hash:
|
6019
|
+
#
|
6020
|
+
# {
|
6021
|
+
# rest_api_id: "String", # required
|
6022
|
+
# request_validator_id: "String", # required
|
6023
|
+
# patch_operations: [
|
6024
|
+
# {
|
6025
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
6026
|
+
# path: "String",
|
6027
|
+
# value: "String",
|
6028
|
+
# from: "String",
|
6029
|
+
# },
|
6030
|
+
# ],
|
6031
|
+
# }
|
6032
|
+
#
|
6033
|
+
# @!attribute [rw] rest_api_id
|
6034
|
+
# \[Required\] The identifier of the RestApi for which the given
|
6035
|
+
# RequestValidator is updated.
|
6036
|
+
# @return [String]
|
6037
|
+
#
|
6038
|
+
# @!attribute [rw] request_validator_id
|
6039
|
+
# \[Required\] The identifier of RequestValidator to be updated.
|
6040
|
+
# @return [String]
|
6041
|
+
#
|
6042
|
+
# @!attribute [rw] patch_operations
|
6043
|
+
# A list of update operations to be applied to the specified resource
|
6044
|
+
# and in the order specified in this list.
|
6045
|
+
# @return [Array<Types::PatchOperation>]
|
6046
|
+
#
|
6047
|
+
class UpdateRequestValidatorRequest < Struct.new(
|
6048
|
+
:rest_api_id,
|
6049
|
+
:request_validator_id,
|
6050
|
+
:patch_operations)
|
6051
|
+
include Aws::Structure
|
6052
|
+
end
|
6053
|
+
|
5788
6054
|
# Request to change information about a Resource resource.
|
5789
6055
|
#
|
5790
6056
|
# @note When making an API call, you may pass UpdateResourceRequest
|