aws-sdk-apigateway 1.78.0 → 1.80.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -166,20 +166,6 @@ module Aws::APIGateway
166
166
 
167
167
  # API stage name of the associated API stage in a usage plan.
168
168
  #
169
- # @note When making an API call, you may pass ApiStage
170
- # data as a hash:
171
- #
172
- # {
173
- # api_id: "String",
174
- # stage: "String",
175
- # throttle: {
176
- # "String" => {
177
- # burst_limit: 1,
178
- # rate_limit: 1.0,
179
- # },
180
- # },
181
- # }
182
- #
183
169
  # @!attribute [rw] api_id
184
170
  # API Id of the associated API stage in a usage plan.
185
171
  # @return [String]
@@ -381,18 +367,6 @@ module Aws::APIGateway
381
367
 
382
368
  # Configuration settings of a canary deployment.
383
369
  #
384
- # @note When making an API call, you may pass CanarySettings
385
- # data as a hash:
386
- #
387
- # {
388
- # percent_traffic: 1.0,
389
- # deployment_id: "String",
390
- # stage_variable_overrides: {
391
- # "String" => "String",
392
- # },
393
- # use_stage_cache: false,
394
- # }
395
- #
396
370
  # @!attribute [rw] percent_traffic
397
371
  # The percent (0-100) of traffic diverted to a canary deployment.
398
372
  # @return [Float]
@@ -493,27 +467,6 @@ module Aws::APIGateway
493
467
 
494
468
  # Request to create an ApiKey resource.
495
469
  #
496
- # @note When making an API call, you may pass CreateApiKeyRequest
497
- # data as a hash:
498
- #
499
- # {
500
- # name: "String",
501
- # description: "String",
502
- # enabled: false,
503
- # generate_distinct_id: false,
504
- # value: "String",
505
- # stage_keys: [
506
- # {
507
- # rest_api_id: "String",
508
- # stage_name: "String",
509
- # },
510
- # ],
511
- # customer_id: "String",
512
- # tags: {
513
- # "String" => "String",
514
- # },
515
- # }
516
- #
517
470
  # @!attribute [rw] name
518
471
  # The name of the ApiKey.
519
472
  # @return [String]
@@ -567,22 +520,6 @@ module Aws::APIGateway
567
520
 
568
521
  # Request to add a new Authorizer to an existing RestApi resource.
569
522
  #
570
- # @note When making an API call, you may pass CreateAuthorizerRequest
571
- # data as a hash:
572
- #
573
- # {
574
- # rest_api_id: "String", # required
575
- # name: "String", # required
576
- # type: "TOKEN", # required, accepts TOKEN, REQUEST, COGNITO_USER_POOLS
577
- # provider_arns: ["ProviderARN"],
578
- # auth_type: "String",
579
- # authorizer_uri: "String",
580
- # authorizer_credentials: "String",
581
- # identity_source: "String",
582
- # identity_validation_expression: "String",
583
- # authorizer_result_ttl_in_seconds: 1,
584
- # }
585
- #
586
523
  # @!attribute [rw] rest_api_id
587
524
  # The string identifier of the associated RestApi.
588
525
  # @return [String]
@@ -690,16 +627,6 @@ module Aws::APIGateway
690
627
 
691
628
  # Requests API Gateway to create a new BasePathMapping resource.
692
629
  #
693
- # @note When making an API call, you may pass CreateBasePathMappingRequest
694
- # data as a hash:
695
- #
696
- # {
697
- # domain_name: "String", # required
698
- # base_path: "String",
699
- # rest_api_id: "String", # required
700
- # stage: "String",
701
- # }
702
- #
703
630
  # @!attribute [rw] domain_name
704
631
  # The domain name of the BasePathMapping resource to create.
705
632
  # @return [String]
@@ -732,29 +659,6 @@ module Aws::APIGateway
732
659
 
733
660
  # Requests API Gateway to create a Deployment resource.
734
661
  #
735
- # @note When making an API call, you may pass CreateDeploymentRequest
736
- # data as a hash:
737
- #
738
- # {
739
- # rest_api_id: "String", # required
740
- # stage_name: "String",
741
- # stage_description: "String",
742
- # description: "String",
743
- # cache_cluster_enabled: false,
744
- # cache_cluster_size: "0.5", # accepts 0.5, 1.6, 6.1, 13.5, 28.4, 58.2, 118, 237
745
- # variables: {
746
- # "String" => "String",
747
- # },
748
- # canary_settings: {
749
- # percent_traffic: 1.0,
750
- # stage_variable_overrides: {
751
- # "String" => "String",
752
- # },
753
- # use_stage_cache: false,
754
- # },
755
- # tracing_enabled: false,
756
- # }
757
- #
758
662
  # @!attribute [rw] rest_api_id
759
663
  # The string identifier of the associated RestApi.
760
664
  # @return [String]
@@ -779,8 +683,13 @@ module Aws::APIGateway
779
683
  # @return [Boolean]
780
684
  #
781
685
  # @!attribute [rw] cache_cluster_size
782
- # Specifies the cache cluster size for the Stage resource specified in
783
- # the input, if a cache cluster is enabled.
686
+ # The stage's cache capacity in GB. For more information about
687
+ # choosing a cache size, see [Enabling API caching to enhance
688
+ # responsiveness][1].
689
+ #
690
+ #
691
+ #
692
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html
784
693
  # @return [String]
785
694
  #
786
695
  # @!attribute [rw] variables
@@ -816,21 +725,6 @@ module Aws::APIGateway
816
725
 
817
726
  # Creates a new documentation part of a given API.
818
727
  #
819
- # @note When making an API call, you may pass CreateDocumentationPartRequest
820
- # data as a hash:
821
- #
822
- # {
823
- # rest_api_id: "String", # required
824
- # location: { # required
825
- # type: "API", # required, accepts API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY
826
- # path: "String",
827
- # method: "String",
828
- # status_code: "DocumentationPartLocationStatusCode",
829
- # name: "String",
830
- # },
831
- # properties: "String", # required
832
- # }
833
- #
834
728
  # @!attribute [rw] rest_api_id
835
729
  # The string identifier of the associated RestApi.
836
730
  # @return [String]
@@ -857,16 +751,6 @@ module Aws::APIGateway
857
751
 
858
752
  # Creates a new documentation version of a given API.
859
753
  #
860
- # @note When making an API call, you may pass CreateDocumentationVersionRequest
861
- # data as a hash:
862
- #
863
- # {
864
- # rest_api_id: "String", # required
865
- # documentation_version: "String", # required
866
- # stage_name: "String",
867
- # description: "String",
868
- # }
869
- #
870
754
  # @!attribute [rw] rest_api_id
871
755
  # The string identifier of the associated RestApi.
872
756
  # @return [String]
@@ -894,33 +778,6 @@ module Aws::APIGateway
894
778
 
895
779
  # A request to create a new domain name.
896
780
  #
897
- # @note When making an API call, you may pass CreateDomainNameRequest
898
- # data as a hash:
899
- #
900
- # {
901
- # domain_name: "String", # required
902
- # certificate_name: "String",
903
- # certificate_body: "String",
904
- # certificate_private_key: "String",
905
- # certificate_chain: "String",
906
- # certificate_arn: "String",
907
- # regional_certificate_name: "String",
908
- # regional_certificate_arn: "String",
909
- # endpoint_configuration: {
910
- # types: ["REGIONAL"], # accepts REGIONAL, EDGE, PRIVATE
911
- # vpc_endpoint_ids: ["String"],
912
- # },
913
- # tags: {
914
- # "String" => "String",
915
- # },
916
- # security_policy: "TLS_1_0", # accepts TLS_1_0, TLS_1_2
917
- # mutual_tls_authentication: {
918
- # truststore_uri: "String",
919
- # truststore_version: "String",
920
- # },
921
- # ownership_verification_certificate_arn: "String",
922
- # }
923
- #
924
781
  # @!attribute [rw] domain_name
925
782
  # The name of the DomainName resource.
926
783
  # @return [String]
@@ -1019,17 +876,6 @@ module Aws::APIGateway
1019
876
 
1020
877
  # Request to add a new Model to an existing RestApi resource.
1021
878
  #
1022
- # @note When making an API call, you may pass CreateModelRequest
1023
- # data as a hash:
1024
- #
1025
- # {
1026
- # rest_api_id: "String", # required
1027
- # name: "String", # required
1028
- # description: "String",
1029
- # schema: "String",
1030
- # content_type: "String", # required
1031
- # }
1032
- #
1033
879
  # @!attribute [rw] rest_api_id
1034
880
  # The RestApi identifier under which the Model will be created.
1035
881
  # @return [String]
@@ -1063,16 +909,6 @@ module Aws::APIGateway
1063
909
 
1064
910
  # Creates a RequestValidator of a given RestApi.
1065
911
  #
1066
- # @note When making an API call, you may pass CreateRequestValidatorRequest
1067
- # data as a hash:
1068
- #
1069
- # {
1070
- # rest_api_id: "String", # required
1071
- # name: "String",
1072
- # validate_request_body: false,
1073
- # validate_request_parameters: false,
1074
- # }
1075
- #
1076
912
  # @!attribute [rw] rest_api_id
1077
913
  # The string identifier of the associated RestApi.
1078
914
  # @return [String]
@@ -1103,15 +939,6 @@ module Aws::APIGateway
1103
939
 
1104
940
  # Requests API Gateway to create a Resource resource.
1105
941
  #
1106
- # @note When making an API call, you may pass CreateResourceRequest
1107
- # data as a hash:
1108
- #
1109
- # {
1110
- # rest_api_id: "String", # required
1111
- # parent_id: "String", # required
1112
- # path_part: "String", # required
1113
- # }
1114
- #
1115
942
  # @!attribute [rw] rest_api_id
1116
943
  # The string identifier of the associated RestApi.
1117
944
  # @return [String]
@@ -1134,28 +961,6 @@ module Aws::APIGateway
1134
961
 
1135
962
  # The POST Request to add a new RestApi resource to your collection.
1136
963
  #
1137
- # @note When making an API call, you may pass CreateRestApiRequest
1138
- # data as a hash:
1139
- #
1140
- # {
1141
- # name: "String", # required
1142
- # description: "String",
1143
- # version: "String",
1144
- # clone_from: "String",
1145
- # binary_media_types: ["String"],
1146
- # minimum_compression_size: 1,
1147
- # api_key_source: "HEADER", # accepts HEADER, AUTHORIZER
1148
- # endpoint_configuration: {
1149
- # types: ["REGIONAL"], # accepts REGIONAL, EDGE, PRIVATE
1150
- # vpc_endpoint_ids: ["String"],
1151
- # },
1152
- # policy: "String",
1153
- # tags: {
1154
- # "String" => "String",
1155
- # },
1156
- # disable_execute_api_endpoint: false,
1157
- # }
1158
- #
1159
964
  # @!attribute [rw] name
1160
965
  # The name of the RestApi.
1161
966
  # @return [String]
@@ -1236,34 +1041,6 @@ module Aws::APIGateway
1236
1041
 
1237
1042
  # Requests API Gateway to create a Stage resource.
1238
1043
  #
1239
- # @note When making an API call, you may pass CreateStageRequest
1240
- # data as a hash:
1241
- #
1242
- # {
1243
- # rest_api_id: "String", # required
1244
- # stage_name: "String", # required
1245
- # deployment_id: "String", # required
1246
- # description: "String",
1247
- # cache_cluster_enabled: false,
1248
- # cache_cluster_size: "0.5", # accepts 0.5, 1.6, 6.1, 13.5, 28.4, 58.2, 118, 237
1249
- # variables: {
1250
- # "String" => "String",
1251
- # },
1252
- # documentation_version: "String",
1253
- # canary_settings: {
1254
- # percent_traffic: 1.0,
1255
- # deployment_id: "String",
1256
- # stage_variable_overrides: {
1257
- # "String" => "String",
1258
- # },
1259
- # use_stage_cache: false,
1260
- # },
1261
- # tracing_enabled: false,
1262
- # tags: {
1263
- # "String" => "String",
1264
- # },
1265
- # }
1266
- #
1267
1044
  # @!attribute [rw] rest_api_id
1268
1045
  # The string identifier of the associated RestApi.
1269
1046
  # @return [String]
@@ -1287,7 +1064,13 @@ module Aws::APIGateway
1287
1064
  # @return [Boolean]
1288
1065
  #
1289
1066
  # @!attribute [rw] cache_cluster_size
1290
- # The stage's cache cluster size.
1067
+ # The stage's cache capacity in GB. For more information about
1068
+ # choosing a cache size, see [Enabling API caching to enhance
1069
+ # responsiveness][1].
1070
+ #
1071
+ #
1072
+ #
1073
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html
1291
1074
  # @return [String]
1292
1075
  #
1293
1076
  # @!attribute [rw] variables
@@ -1334,15 +1117,6 @@ module Aws::APIGateway
1334
1117
  # The POST request to create a usage plan key for adding an existing API
1335
1118
  # key to a usage plan.
1336
1119
  #
1337
- # @note When making an API call, you may pass CreateUsagePlanKeyRequest
1338
- # data as a hash:
1339
- #
1340
- # {
1341
- # usage_plan_id: "String", # required
1342
- # key_id: "String", # required
1343
- # key_type: "String", # required
1344
- # }
1345
- #
1346
1120
  # @!attribute [rw] usage_plan_id
1347
1121
  # The Id of the UsagePlan resource representing the usage plan
1348
1122
  # containing the to-be-created UsagePlanKey resource representing a
@@ -1369,38 +1143,6 @@ module Aws::APIGateway
1369
1143
  # throttle limits and quota limits, as well as the associated API
1370
1144
  # stages, specified in the payload.
1371
1145
  #
1372
- # @note When making an API call, you may pass CreateUsagePlanRequest
1373
- # data as a hash:
1374
- #
1375
- # {
1376
- # name: "String", # required
1377
- # description: "String",
1378
- # api_stages: [
1379
- # {
1380
- # api_id: "String",
1381
- # stage: "String",
1382
- # throttle: {
1383
- # "String" => {
1384
- # burst_limit: 1,
1385
- # rate_limit: 1.0,
1386
- # },
1387
- # },
1388
- # },
1389
- # ],
1390
- # throttle: {
1391
- # burst_limit: 1,
1392
- # rate_limit: 1.0,
1393
- # },
1394
- # quota: {
1395
- # limit: 1,
1396
- # offset: 1,
1397
- # period: "DAY", # accepts DAY, WEEK, MONTH
1398
- # },
1399
- # tags: {
1400
- # "String" => "String",
1401
- # },
1402
- # }
1403
- #
1404
1146
  # @!attribute [rw] name
1405
1147
  # The name of the usage plan.
1406
1148
  # @return [String]
@@ -1443,18 +1185,6 @@ module Aws::APIGateway
1443
1185
  # complete and become operational. The caller must have permissions to
1444
1186
  # create and update VPC Endpoint services.
1445
1187
  #
1446
- # @note When making an API call, you may pass CreateVpcLinkRequest
1447
- # data as a hash:
1448
- #
1449
- # {
1450
- # name: "String", # required
1451
- # description: "String",
1452
- # target_arns: ["String"], # required
1453
- # tags: {
1454
- # "String" => "String",
1455
- # },
1456
- # }
1457
- #
1458
1188
  # @!attribute [rw] name
1459
1189
  # The name used to label and identify the VPC link.
1460
1190
  # @return [String]
@@ -1486,13 +1216,6 @@ module Aws::APIGateway
1486
1216
 
1487
1217
  # A request to delete the ApiKey resource.
1488
1218
  #
1489
- # @note When making an API call, you may pass DeleteApiKeyRequest
1490
- # data as a hash:
1491
- #
1492
- # {
1493
- # api_key: "String", # required
1494
- # }
1495
- #
1496
1219
  # @!attribute [rw] api_key
1497
1220
  # The identifier of the ApiKey resource to be deleted.
1498
1221
  # @return [String]
@@ -1505,14 +1228,6 @@ module Aws::APIGateway
1505
1228
 
1506
1229
  # Request to delete an existing Authorizer resource.
1507
1230
  #
1508
- # @note When making an API call, you may pass DeleteAuthorizerRequest
1509
- # data as a hash:
1510
- #
1511
- # {
1512
- # rest_api_id: "String", # required
1513
- # authorizer_id: "String", # required
1514
- # }
1515
- #
1516
1231
  # @!attribute [rw] rest_api_id
1517
1232
  # The string identifier of the associated RestApi.
1518
1233
  # @return [String]
@@ -1530,14 +1245,6 @@ module Aws::APIGateway
1530
1245
 
1531
1246
  # A request to delete the BasePathMapping resource.
1532
1247
  #
1533
- # @note When making an API call, you may pass DeleteBasePathMappingRequest
1534
- # data as a hash:
1535
- #
1536
- # {
1537
- # domain_name: "String", # required
1538
- # base_path: "String", # required
1539
- # }
1540
- #
1541
1248
  # @!attribute [rw] domain_name
1542
1249
  # The domain name of the BasePathMapping resource to delete.
1543
1250
  # @return [String]
@@ -1557,13 +1264,6 @@ module Aws::APIGateway
1557
1264
 
1558
1265
  # A request to delete the ClientCertificate resource.
1559
1266
  #
1560
- # @note When making an API call, you may pass DeleteClientCertificateRequest
1561
- # data as a hash:
1562
- #
1563
- # {
1564
- # client_certificate_id: "String", # required
1565
- # }
1566
- #
1567
1267
  # @!attribute [rw] client_certificate_id
1568
1268
  # The identifier of the ClientCertificate resource to be deleted.
1569
1269
  # @return [String]
@@ -1576,14 +1276,6 @@ module Aws::APIGateway
1576
1276
 
1577
1277
  # Requests API Gateway to delete a Deployment resource.
1578
1278
  #
1579
- # @note When making an API call, you may pass DeleteDeploymentRequest
1580
- # data as a hash:
1581
- #
1582
- # {
1583
- # rest_api_id: "String", # required
1584
- # deployment_id: "String", # required
1585
- # }
1586
- #
1587
1279
  # @!attribute [rw] rest_api_id
1588
1280
  # The string identifier of the associated RestApi.
1589
1281
  # @return [String]
@@ -1601,14 +1293,6 @@ module Aws::APIGateway
1601
1293
 
1602
1294
  # Deletes an existing documentation part of an API.
1603
1295
  #
1604
- # @note When making an API call, you may pass DeleteDocumentationPartRequest
1605
- # data as a hash:
1606
- #
1607
- # {
1608
- # rest_api_id: "String", # required
1609
- # documentation_part_id: "String", # required
1610
- # }
1611
- #
1612
1296
  # @!attribute [rw] rest_api_id
1613
1297
  # The string identifier of the associated RestApi.
1614
1298
  # @return [String]
@@ -1626,14 +1310,6 @@ module Aws::APIGateway
1626
1310
 
1627
1311
  # Deletes an existing documentation version of an API.
1628
1312
  #
1629
- # @note When making an API call, you may pass DeleteDocumentationVersionRequest
1630
- # data as a hash:
1631
- #
1632
- # {
1633
- # rest_api_id: "String", # required
1634
- # documentation_version: "String", # required
1635
- # }
1636
- #
1637
1313
  # @!attribute [rw] rest_api_id
1638
1314
  # The string identifier of the associated RestApi.
1639
1315
  # @return [String]
@@ -1651,13 +1327,6 @@ module Aws::APIGateway
1651
1327
 
1652
1328
  # A request to delete the DomainName resource.
1653
1329
  #
1654
- # @note When making an API call, you may pass DeleteDomainNameRequest
1655
- # data as a hash:
1656
- #
1657
- # {
1658
- # domain_name: "String", # required
1659
- # }
1660
- #
1661
1330
  # @!attribute [rw] domain_name
1662
1331
  # The name of the DomainName resource to be deleted.
1663
1332
  # @return [String]
@@ -1671,14 +1340,6 @@ module Aws::APIGateway
1671
1340
  # Clears any customization of a GatewayResponse of a specified response
1672
1341
  # type on the given RestApi and resets it with the default settings.
1673
1342
  #
1674
- # @note When making an API call, you may pass DeleteGatewayResponseRequest
1675
- # data as a hash:
1676
- #
1677
- # {
1678
- # rest_api_id: "String", # required
1679
- # 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, WAF_FILTERED
1680
- # }
1681
- #
1682
1343
  # @!attribute [rw] rest_api_id
1683
1344
  # The string identifier of the associated RestApi.
1684
1345
  # @return [String]
@@ -1696,15 +1357,6 @@ module Aws::APIGateway
1696
1357
 
1697
1358
  # Represents a delete integration request.
1698
1359
  #
1699
- # @note When making an API call, you may pass DeleteIntegrationRequest
1700
- # data as a hash:
1701
- #
1702
- # {
1703
- # rest_api_id: "String", # required
1704
- # resource_id: "String", # required
1705
- # http_method: "String", # required
1706
- # }
1707
- #
1708
1360
  # @!attribute [rw] rest_api_id
1709
1361
  # The string identifier of the associated RestApi.
1710
1362
  # @return [String]
@@ -1727,16 +1379,6 @@ module Aws::APIGateway
1727
1379
 
1728
1380
  # Represents a delete integration response request.
1729
1381
  #
1730
- # @note When making an API call, you may pass DeleteIntegrationResponseRequest
1731
- # data as a hash:
1732
- #
1733
- # {
1734
- # rest_api_id: "String", # required
1735
- # resource_id: "String", # required
1736
- # http_method: "String", # required
1737
- # status_code: "StatusCode", # required
1738
- # }
1739
- #
1740
1382
  # @!attribute [rw] rest_api_id
1741
1383
  # The string identifier of the associated RestApi.
1742
1384
  # @return [String]
@@ -1765,15 +1407,6 @@ module Aws::APIGateway
1765
1407
 
1766
1408
  # Request to delete an existing Method resource.
1767
1409
  #
1768
- # @note When making an API call, you may pass DeleteMethodRequest
1769
- # data as a hash:
1770
- #
1771
- # {
1772
- # rest_api_id: "String", # required
1773
- # resource_id: "String", # required
1774
- # http_method: "String", # required
1775
- # }
1776
- #
1777
1410
  # @!attribute [rw] rest_api_id
1778
1411
  # The string identifier of the associated RestApi.
1779
1412
  # @return [String]
@@ -1796,16 +1429,6 @@ module Aws::APIGateway
1796
1429
 
1797
1430
  # A request to delete an existing MethodResponse resource.
1798
1431
  #
1799
- # @note When making an API call, you may pass DeleteMethodResponseRequest
1800
- # data as a hash:
1801
- #
1802
- # {
1803
- # rest_api_id: "String", # required
1804
- # resource_id: "String", # required
1805
- # http_method: "String", # required
1806
- # status_code: "StatusCode", # required
1807
- # }
1808
- #
1809
1432
  # @!attribute [rw] rest_api_id
1810
1433
  # The string identifier of the associated RestApi.
1811
1434
  # @return [String]
@@ -1833,14 +1456,6 @@ module Aws::APIGateway
1833
1456
 
1834
1457
  # Request to delete an existing model in an existing RestApi resource.
1835
1458
  #
1836
- # @note When making an API call, you may pass DeleteModelRequest
1837
- # data as a hash:
1838
- #
1839
- # {
1840
- # rest_api_id: "String", # required
1841
- # model_name: "String", # required
1842
- # }
1843
- #
1844
1459
  # @!attribute [rw] rest_api_id
1845
1460
  # The string identifier of the associated RestApi.
1846
1461
  # @return [String]
@@ -1858,14 +1473,6 @@ module Aws::APIGateway
1858
1473
 
1859
1474
  # Deletes a specified RequestValidator of a given RestApi.
1860
1475
  #
1861
- # @note When making an API call, you may pass DeleteRequestValidatorRequest
1862
- # data as a hash:
1863
- #
1864
- # {
1865
- # rest_api_id: "String", # required
1866
- # request_validator_id: "String", # required
1867
- # }
1868
- #
1869
1476
  # @!attribute [rw] rest_api_id
1870
1477
  # The string identifier of the associated RestApi.
1871
1478
  # @return [String]
@@ -1883,14 +1490,6 @@ module Aws::APIGateway
1883
1490
 
1884
1491
  # Request to delete a Resource.
1885
1492
  #
1886
- # @note When making an API call, you may pass DeleteResourceRequest
1887
- # data as a hash:
1888
- #
1889
- # {
1890
- # rest_api_id: "String", # required
1891
- # resource_id: "String", # required
1892
- # }
1893
- #
1894
1493
  # @!attribute [rw] rest_api_id
1895
1494
  # The string identifier of the associated RestApi.
1896
1495
  # @return [String]
@@ -1908,13 +1507,6 @@ module Aws::APIGateway
1908
1507
 
1909
1508
  # Request to delete the specified API from your collection.
1910
1509
  #
1911
- # @note When making an API call, you may pass DeleteRestApiRequest
1912
- # data as a hash:
1913
- #
1914
- # {
1915
- # rest_api_id: "String", # required
1916
- # }
1917
- #
1918
1510
  # @!attribute [rw] rest_api_id
1919
1511
  # The string identifier of the associated RestApi.
1920
1512
  # @return [String]
@@ -1927,14 +1519,6 @@ module Aws::APIGateway
1927
1519
 
1928
1520
  # Requests API Gateway to delete a Stage resource.
1929
1521
  #
1930
- # @note When making an API call, you may pass DeleteStageRequest
1931
- # data as a hash:
1932
- #
1933
- # {
1934
- # rest_api_id: "String", # required
1935
- # stage_name: "String", # required
1936
- # }
1937
- #
1938
1522
  # @!attribute [rw] rest_api_id
1939
1523
  # The string identifier of the associated RestApi.
1940
1524
  # @return [String]
@@ -1953,14 +1537,6 @@ module Aws::APIGateway
1953
1537
  # The DELETE request to delete a usage plan key and remove the
1954
1538
  # underlying API key from the associated usage plan.
1955
1539
  #
1956
- # @note When making an API call, you may pass DeleteUsagePlanKeyRequest
1957
- # data as a hash:
1958
- #
1959
- # {
1960
- # usage_plan_id: "String", # required
1961
- # key_id: "String", # required
1962
- # }
1963
- #
1964
1540
  # @!attribute [rw] usage_plan_id
1965
1541
  # The Id of the UsagePlan resource representing the usage plan
1966
1542
  # containing the to-be-deleted UsagePlanKey resource representing a
@@ -1980,13 +1556,6 @@ module Aws::APIGateway
1980
1556
 
1981
1557
  # The DELETE request to delete a usage plan of a given plan Id.
1982
1558
  #
1983
- # @note When making an API call, you may pass DeleteUsagePlanRequest
1984
- # data as a hash:
1985
- #
1986
- # {
1987
- # usage_plan_id: "String", # required
1988
- # }
1989
- #
1990
1559
  # @!attribute [rw] usage_plan_id
1991
1560
  # The Id of the to-be-deleted usage plan.
1992
1561
  # @return [String]
@@ -1999,13 +1568,6 @@ module Aws::APIGateway
1999
1568
 
2000
1569
  # Deletes an existing VpcLink of a specified identifier.
2001
1570
  #
2002
- # @note When making an API call, you may pass DeleteVpcLinkRequest
2003
- # data as a hash:
2004
- #
2005
- # {
2006
- # vpc_link_id: "String", # required
2007
- # }
2008
- #
2009
1571
  # @!attribute [rw] vpc_link_id
2010
1572
  # The identifier of the VpcLink. It is used in an Integration to
2011
1573
  # reference this VpcLink.
@@ -2049,17 +1611,6 @@ module Aws::APIGateway
2049
1611
 
2050
1612
  # The input configuration for a canary deployment.
2051
1613
  #
2052
- # @note When making an API call, you may pass DeploymentCanarySettings
2053
- # data as a hash:
2054
- #
2055
- # {
2056
- # percent_traffic: 1.0,
2057
- # stage_variable_overrides: {
2058
- # "String" => "String",
2059
- # },
2060
- # use_stage_cache: false,
2061
- # }
2062
- #
2063
1614
  # @!attribute [rw] percent_traffic
2064
1615
  # The percentage (0.0-100.0) of traffic routed to the canary
2065
1616
  # deployment.
@@ -2159,17 +1710,6 @@ module Aws::APIGateway
2159
1710
 
2160
1711
  # Specifies the target API entity to which the documentation applies.
2161
1712
  #
2162
- # @note When making an API call, you may pass DocumentationPartLocation
2163
- # data as a hash:
2164
- #
2165
- # {
2166
- # type: "API", # required, accepts API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY
2167
- # path: "String",
2168
- # method: "String",
2169
- # status_code: "DocumentationPartLocationStatusCode",
2170
- # name: "String",
2171
- # }
2172
- #
2173
1713
  # @!attribute [rw] type
2174
1714
  # The type of API entity to which the documentation content applies.
2175
1715
  # Valid values are `API`, `AUTHORIZER`, `MODEL`, `RESOURCE`, `METHOD`,
@@ -2429,14 +1969,6 @@ module Aws::APIGateway
2429
1969
  # The endpoint configuration to indicate the types of endpoints an API
2430
1970
  # (RestApi) or its custom domain name (DomainName) has.
2431
1971
  #
2432
- # @note When making an API call, you may pass EndpointConfiguration
2433
- # data as a hash:
2434
- #
2435
- # {
2436
- # types: ["REGIONAL"], # accepts REGIONAL, EDGE, PRIVATE
2437
- # vpc_endpoint_ids: ["String"],
2438
- # }
2439
- #
2440
1972
  # @!attribute [rw] types
2441
1973
  # A list of endpoint types of an API (RestApi) or its custom domain
2442
1974
  # name (DomainName). For an edge-optimized API and its custom domain
@@ -2483,14 +2015,6 @@ module Aws::APIGateway
2483
2015
 
2484
2016
  # Request to flush authorizer cache entries on a specified stage.
2485
2017
  #
2486
- # @note When making an API call, you may pass FlushStageAuthorizersCacheRequest
2487
- # data as a hash:
2488
- #
2489
- # {
2490
- # rest_api_id: "String", # required
2491
- # stage_name: "String", # required
2492
- # }
2493
- #
2494
2018
  # @!attribute [rw] rest_api_id
2495
2019
  # The string identifier of the associated RestApi.
2496
2020
  # @return [String]
@@ -2508,14 +2032,6 @@ module Aws::APIGateway
2508
2032
 
2509
2033
  # Requests API Gateway to flush a stage's cache.
2510
2034
  #
2511
- # @note When making an API call, you may pass FlushStageCacheRequest
2512
- # data as a hash:
2513
- #
2514
- # {
2515
- # rest_api_id: "String", # required
2516
- # stage_name: "String", # required
2517
- # }
2518
- #
2519
2035
  # @!attribute [rw] rest_api_id
2520
2036
  # The string identifier of the associated RestApi.
2521
2037
  # @return [String]
@@ -2589,16 +2105,6 @@ module Aws::APIGateway
2589
2105
 
2590
2106
  # A request to generate a ClientCertificate resource.
2591
2107
  #
2592
- # @note When making an API call, you may pass GenerateClientCertificateRequest
2593
- # data as a hash:
2594
- #
2595
- # {
2596
- # description: "String",
2597
- # tags: {
2598
- # "String" => "String",
2599
- # },
2600
- # }
2601
- #
2602
2108
  # @!attribute [rw] description
2603
2109
  # The description of the ClientCertificate.
2604
2110
  # @return [String]
@@ -2625,14 +2131,6 @@ module Aws::APIGateway
2625
2131
 
2626
2132
  # A request to get information about the current ApiKey resource.
2627
2133
  #
2628
- # @note When making an API call, you may pass GetApiKeyRequest
2629
- # data as a hash:
2630
- #
2631
- # {
2632
- # api_key: "String", # required
2633
- # include_value: false,
2634
- # }
2635
- #
2636
2134
  # @!attribute [rw] api_key
2637
2135
  # The identifier of the ApiKey resource.
2638
2136
  # @return [String]
@@ -2651,17 +2149,6 @@ module Aws::APIGateway
2651
2149
 
2652
2150
  # A request to get information about the current ApiKeys resource.
2653
2151
  #
2654
- # @note When making an API call, you may pass GetApiKeysRequest
2655
- # data as a hash:
2656
- #
2657
- # {
2658
- # position: "String",
2659
- # limit: 1,
2660
- # name_query: "String",
2661
- # customer_id: "String",
2662
- # include_values: false,
2663
- # }
2664
- #
2665
2152
  # @!attribute [rw] position
2666
2153
  # The current pagination position in the paged result set.
2667
2154
  # @return [String]
@@ -2697,14 +2184,6 @@ module Aws::APIGateway
2697
2184
 
2698
2185
  # Request to describe an existing Authorizer resource.
2699
2186
  #
2700
- # @note When making an API call, you may pass GetAuthorizerRequest
2701
- # data as a hash:
2702
- #
2703
- # {
2704
- # rest_api_id: "String", # required
2705
- # authorizer_id: "String", # required
2706
- # }
2707
- #
2708
2187
  # @!attribute [rw] rest_api_id
2709
2188
  # The string identifier of the associated RestApi.
2710
2189
  # @return [String]
@@ -2722,15 +2201,6 @@ module Aws::APIGateway
2722
2201
 
2723
2202
  # Request to describe an existing Authorizers resource.
2724
2203
  #
2725
- # @note When making an API call, you may pass GetAuthorizersRequest
2726
- # data as a hash:
2727
- #
2728
- # {
2729
- # rest_api_id: "String", # required
2730
- # position: "String",
2731
- # limit: 1,
2732
- # }
2733
- #
2734
2204
  # @!attribute [rw] rest_api_id
2735
2205
  # The string identifier of the associated RestApi.
2736
2206
  # @return [String]
@@ -2754,14 +2224,6 @@ module Aws::APIGateway
2754
2224
 
2755
2225
  # Request to describe a BasePathMapping resource.
2756
2226
  #
2757
- # @note When making an API call, you may pass GetBasePathMappingRequest
2758
- # data as a hash:
2759
- #
2760
- # {
2761
- # domain_name: "String", # required
2762
- # base_path: "String", # required
2763
- # }
2764
- #
2765
2227
  # @!attribute [rw] domain_name
2766
2228
  # The domain name of the BasePathMapping resource to be described.
2767
2229
  # @return [String]
@@ -2783,15 +2245,6 @@ module Aws::APIGateway
2783
2245
  # A request to get information about a collection of BasePathMapping
2784
2246
  # resources.
2785
2247
  #
2786
- # @note When making an API call, you may pass GetBasePathMappingsRequest
2787
- # data as a hash:
2788
- #
2789
- # {
2790
- # domain_name: "String", # required
2791
- # position: "String",
2792
- # limit: 1,
2793
- # }
2794
- #
2795
2248
  # @!attribute [rw] domain_name
2796
2249
  # The domain name of a BasePathMapping resource.
2797
2250
  # @return [String]
@@ -2816,13 +2269,6 @@ module Aws::APIGateway
2816
2269
  # A request to get information about the current ClientCertificate
2817
2270
  # resource.
2818
2271
  #
2819
- # @note When making an API call, you may pass GetClientCertificateRequest
2820
- # data as a hash:
2821
- #
2822
- # {
2823
- # client_certificate_id: "String", # required
2824
- # }
2825
- #
2826
2272
  # @!attribute [rw] client_certificate_id
2827
2273
  # The identifier of the ClientCertificate resource to be described.
2828
2274
  # @return [String]
@@ -2836,14 +2282,6 @@ module Aws::APIGateway
2836
2282
  # A request to get information about a collection of ClientCertificate
2837
2283
  # resources.
2838
2284
  #
2839
- # @note When making an API call, you may pass GetClientCertificatesRequest
2840
- # data as a hash:
2841
- #
2842
- # {
2843
- # position: "String",
2844
- # limit: 1,
2845
- # }
2846
- #
2847
2285
  # @!attribute [rw] position
2848
2286
  # The current pagination position in the paged result set.
2849
2287
  # @return [String]
@@ -2862,15 +2300,6 @@ module Aws::APIGateway
2862
2300
 
2863
2301
  # Requests API Gateway to get information about a Deployment resource.
2864
2302
  #
2865
- # @note When making an API call, you may pass GetDeploymentRequest
2866
- # data as a hash:
2867
- #
2868
- # {
2869
- # rest_api_id: "String", # required
2870
- # deployment_id: "String", # required
2871
- # embed: ["String"],
2872
- # }
2873
- #
2874
2303
  # @!attribute [rw] rest_api_id
2875
2304
  # The string identifier of the associated RestApi.
2876
2305
  # @return [String]
@@ -2904,15 +2333,6 @@ module Aws::APIGateway
2904
2333
  # Requests API Gateway to get information about a Deployments
2905
2334
  # collection.
2906
2335
  #
2907
- # @note When making an API call, you may pass GetDeploymentsRequest
2908
- # data as a hash:
2909
- #
2910
- # {
2911
- # rest_api_id: "String", # required
2912
- # position: "String",
2913
- # limit: 1,
2914
- # }
2915
- #
2916
2336
  # @!attribute [rw] rest_api_id
2917
2337
  # The string identifier of the associated RestApi.
2918
2338
  # @return [String]
@@ -2936,14 +2356,6 @@ module Aws::APIGateway
2936
2356
 
2937
2357
  # Gets a specified documentation part of a given API.
2938
2358
  #
2939
- # @note When making an API call, you may pass GetDocumentationPartRequest
2940
- # data as a hash:
2941
- #
2942
- # {
2943
- # rest_api_id: "String", # required
2944
- # documentation_part_id: "String", # required
2945
- # }
2946
- #
2947
2359
  # @!attribute [rw] rest_api_id
2948
2360
  # The string identifier of the associated RestApi.
2949
2361
  # @return [String]
@@ -2962,19 +2374,6 @@ module Aws::APIGateway
2962
2374
  # Gets the documentation parts of an API. The result may be filtered by
2963
2375
  # the type, name, or path of API entities (targets).
2964
2376
  #
2965
- # @note When making an API call, you may pass GetDocumentationPartsRequest
2966
- # data as a hash:
2967
- #
2968
- # {
2969
- # rest_api_id: "String", # required
2970
- # type: "API", # accepts API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY
2971
- # name_query: "String",
2972
- # path: "String",
2973
- # position: "String",
2974
- # limit: 1,
2975
- # location_status: "DOCUMENTED", # accepts DOCUMENTED, UNDOCUMENTED
2976
- # }
2977
- #
2978
2377
  # @!attribute [rw] rest_api_id
2979
2378
  # The string identifier of the associated RestApi.
2980
2379
  # @return [String]
@@ -3021,14 +2420,6 @@ module Aws::APIGateway
3021
2420
 
3022
2421
  # Gets a documentation snapshot of an API.
3023
2422
  #
3024
- # @note When making an API call, you may pass GetDocumentationVersionRequest
3025
- # data as a hash:
3026
- #
3027
- # {
3028
- # rest_api_id: "String", # required
3029
- # documentation_version: "String", # required
3030
- # }
3031
- #
3032
2423
  # @!attribute [rw] rest_api_id
3033
2424
  # The string identifier of the associated RestApi.
3034
2425
  # @return [String]
@@ -3047,15 +2438,6 @@ module Aws::APIGateway
3047
2438
 
3048
2439
  # Gets the documentation versions of an API.
3049
2440
  #
3050
- # @note When making an API call, you may pass GetDocumentationVersionsRequest
3051
- # data as a hash:
3052
- #
3053
- # {
3054
- # rest_api_id: "String", # required
3055
- # position: "String",
3056
- # limit: 1,
3057
- # }
3058
- #
3059
2441
  # @!attribute [rw] rest_api_id
3060
2442
  # The string identifier of the associated RestApi.
3061
2443
  # @return [String]
@@ -3079,13 +2461,6 @@ module Aws::APIGateway
3079
2461
 
3080
2462
  # Request to get the name of a DomainName resource.
3081
2463
  #
3082
- # @note When making an API call, you may pass GetDomainNameRequest
3083
- # data as a hash:
3084
- #
3085
- # {
3086
- # domain_name: "String", # required
3087
- # }
3088
- #
3089
2464
  # @!attribute [rw] domain_name
3090
2465
  # The name of the DomainName resource.
3091
2466
  # @return [String]
@@ -3098,14 +2473,6 @@ module Aws::APIGateway
3098
2473
 
3099
2474
  # Request to describe a collection of DomainName resources.
3100
2475
  #
3101
- # @note When making an API call, you may pass GetDomainNamesRequest
3102
- # data as a hash:
3103
- #
3104
- # {
3105
- # position: "String",
3106
- # limit: 1,
3107
- # }
3108
- #
3109
2476
  # @!attribute [rw] position
3110
2477
  # The current pagination position in the paged result set.
3111
2478
  # @return [String]
@@ -3124,19 +2491,6 @@ module Aws::APIGateway
3124
2491
 
3125
2492
  # Request a new export of a RestApi for a particular Stage.
3126
2493
  #
3127
- # @note When making an API call, you may pass GetExportRequest
3128
- # data as a hash:
3129
- #
3130
- # {
3131
- # rest_api_id: "String", # required
3132
- # stage_name: "String", # required
3133
- # export_type: "String", # required
3134
- # parameters: {
3135
- # "String" => "String",
3136
- # },
3137
- # accepts: "String",
3138
- # }
3139
- #
3140
2494
  # @!attribute [rw] rest_api_id
3141
2495
  # The string identifier of the associated RestApi.
3142
2496
  # @return [String]
@@ -3182,14 +2536,6 @@ module Aws::APIGateway
3182
2536
  # Gets a GatewayResponse of a specified response type on the given
3183
2537
  # RestApi.
3184
2538
  #
3185
- # @note When making an API call, you may pass GetGatewayResponseRequest
3186
- # data as a hash:
3187
- #
3188
- # {
3189
- # rest_api_id: "String", # required
3190
- # 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, WAF_FILTERED
3191
- # }
3192
- #
3193
2539
  # @!attribute [rw] rest_api_id
3194
2540
  # The string identifier of the associated RestApi.
3195
2541
  # @return [String]
@@ -3210,15 +2556,6 @@ module Aws::APIGateway
3210
2556
  # result will be the API Gateway-generated default GatewayResponses
3211
2557
  # collection for the supported response types.
3212
2558
  #
3213
- # @note When making an API call, you may pass GetGatewayResponsesRequest
3214
- # data as a hash:
3215
- #
3216
- # {
3217
- # rest_api_id: "String", # required
3218
- # position: "String",
3219
- # limit: 1,
3220
- # }
3221
- #
3222
2559
  # @!attribute [rw] rest_api_id
3223
2560
  # The string identifier of the associated RestApi.
3224
2561
  # @return [String]
@@ -3245,15 +2582,6 @@ module Aws::APIGateway
3245
2582
 
3246
2583
  # Represents a request to get the integration configuration.
3247
2584
  #
3248
- # @note When making an API call, you may pass GetIntegrationRequest
3249
- # data as a hash:
3250
- #
3251
- # {
3252
- # rest_api_id: "String", # required
3253
- # resource_id: "String", # required
3254
- # http_method: "String", # required
3255
- # }
3256
- #
3257
2585
  # @!attribute [rw] rest_api_id
3258
2586
  # The string identifier of the associated RestApi.
3259
2587
  # @return [String]
@@ -3276,16 +2604,6 @@ module Aws::APIGateway
3276
2604
 
3277
2605
  # Represents a get integration response request.
3278
2606
  #
3279
- # @note When making an API call, you may pass GetIntegrationResponseRequest
3280
- # data as a hash:
3281
- #
3282
- # {
3283
- # rest_api_id: "String", # required
3284
- # resource_id: "String", # required
3285
- # http_method: "String", # required
3286
- # status_code: "StatusCode", # required
3287
- # }
3288
- #
3289
2607
  # @!attribute [rw] rest_api_id
3290
2608
  # The string identifier of the associated RestApi.
3291
2609
  # @return [String]
@@ -3313,15 +2631,6 @@ module Aws::APIGateway
3313
2631
 
3314
2632
  # Request to describe an existing Method resource.
3315
2633
  #
3316
- # @note When making an API call, you may pass GetMethodRequest
3317
- # data as a hash:
3318
- #
3319
- # {
3320
- # rest_api_id: "String", # required
3321
- # resource_id: "String", # required
3322
- # http_method: "String", # required
3323
- # }
3324
- #
3325
2634
  # @!attribute [rw] rest_api_id
3326
2635
  # The string identifier of the associated RestApi.
3327
2636
  # @return [String]
@@ -3344,16 +2653,6 @@ module Aws::APIGateway
3344
2653
 
3345
2654
  # Request to describe a MethodResponse resource.
3346
2655
  #
3347
- # @note When making an API call, you may pass GetMethodResponseRequest
3348
- # data as a hash:
3349
- #
3350
- # {
3351
- # rest_api_id: "String", # required
3352
- # resource_id: "String", # required
3353
- # http_method: "String", # required
3354
- # status_code: "StatusCode", # required
3355
- # }
3356
- #
3357
2656
  # @!attribute [rw] rest_api_id
3358
2657
  # The string identifier of the associated RestApi.
3359
2658
  # @return [String]
@@ -3382,15 +2681,6 @@ module Aws::APIGateway
3382
2681
  # Request to list information about a model in an existing RestApi
3383
2682
  # resource.
3384
2683
  #
3385
- # @note When making an API call, you may pass GetModelRequest
3386
- # data as a hash:
3387
- #
3388
- # {
3389
- # rest_api_id: "String", # required
3390
- # model_name: "String", # required
3391
- # flatten: false,
3392
- # }
3393
- #
3394
2684
  # @!attribute [rw] rest_api_id
3395
2685
  # The RestApi identifier under which the Model exists.
3396
2686
  # @return [String]
@@ -3416,14 +2706,6 @@ module Aws::APIGateway
3416
2706
  # Request to generate a sample mapping template used to transform the
3417
2707
  # payload.
3418
2708
  #
3419
- # @note When making an API call, you may pass GetModelTemplateRequest
3420
- # data as a hash:
3421
- #
3422
- # {
3423
- # rest_api_id: "String", # required
3424
- # model_name: "String", # required
3425
- # }
3426
- #
3427
2709
  # @!attribute [rw] rest_api_id
3428
2710
  # The string identifier of the associated RestApi.
3429
2711
  # @return [String]
@@ -3441,15 +2723,6 @@ module Aws::APIGateway
3441
2723
 
3442
2724
  # Request to list existing Models defined for a RestApi resource.
3443
2725
  #
3444
- # @note When making an API call, you may pass GetModelsRequest
3445
- # data as a hash:
3446
- #
3447
- # {
3448
- # rest_api_id: "String", # required
3449
- # position: "String",
3450
- # limit: 1,
3451
- # }
3452
- #
3453
2726
  # @!attribute [rw] rest_api_id
3454
2727
  # The string identifier of the associated RestApi.
3455
2728
  # @return [String]
@@ -3473,14 +2746,6 @@ module Aws::APIGateway
3473
2746
 
3474
2747
  # Gets a RequestValidator of a given RestApi.
3475
2748
  #
3476
- # @note When making an API call, you may pass GetRequestValidatorRequest
3477
- # data as a hash:
3478
- #
3479
- # {
3480
- # rest_api_id: "String", # required
3481
- # request_validator_id: "String", # required
3482
- # }
3483
- #
3484
2749
  # @!attribute [rw] rest_api_id
3485
2750
  # The string identifier of the associated RestApi.
3486
2751
  # @return [String]
@@ -3498,15 +2763,6 @@ module Aws::APIGateway
3498
2763
 
3499
2764
  # Gets the RequestValidators collection of a given RestApi.
3500
2765
  #
3501
- # @note When making an API call, you may pass GetRequestValidatorsRequest
3502
- # data as a hash:
3503
- #
3504
- # {
3505
- # rest_api_id: "String", # required
3506
- # position: "String",
3507
- # limit: 1,
3508
- # }
3509
- #
3510
2766
  # @!attribute [rw] rest_api_id
3511
2767
  # The string identifier of the associated RestApi.
3512
2768
  # @return [String]
@@ -3530,15 +2786,6 @@ module Aws::APIGateway
3530
2786
 
3531
2787
  # Request to list information about a resource.
3532
2788
  #
3533
- # @note When making an API call, you may pass GetResourceRequest
3534
- # data as a hash:
3535
- #
3536
- # {
3537
- # rest_api_id: "String", # required
3538
- # resource_id: "String", # required
3539
- # embed: ["String"],
3540
- # }
3541
- #
3542
2789
  # @!attribute [rw] rest_api_id
3543
2790
  # The string identifier of the associated RestApi.
3544
2791
  # @return [String]
@@ -3567,16 +2814,6 @@ module Aws::APIGateway
3567
2814
 
3568
2815
  # Request to list information about a collection of resources.
3569
2816
  #
3570
- # @note When making an API call, you may pass GetResourcesRequest
3571
- # data as a hash:
3572
- #
3573
- # {
3574
- # rest_api_id: "String", # required
3575
- # position: "String",
3576
- # limit: 1,
3577
- # embed: ["String"],
3578
- # }
3579
- #
3580
2817
  # @!attribute [rw] rest_api_id
3581
2818
  # The string identifier of the associated RestApi.
3582
2819
  # @return [String]
@@ -3612,13 +2849,6 @@ module Aws::APIGateway
3612
2849
  # The GET request to list an existing RestApi defined for your
3613
2850
  # collection.
3614
2851
  #
3615
- # @note When making an API call, you may pass GetRestApiRequest
3616
- # data as a hash:
3617
- #
3618
- # {
3619
- # rest_api_id: "String", # required
3620
- # }
3621
- #
3622
2852
  # @!attribute [rw] rest_api_id
3623
2853
  # The string identifier of the associated RestApi.
3624
2854
  # @return [String]
@@ -3631,14 +2861,6 @@ module Aws::APIGateway
3631
2861
 
3632
2862
  # The GET request to list existing RestApis defined for your collection.
3633
2863
  #
3634
- # @note When making an API call, you may pass GetRestApisRequest
3635
- # data as a hash:
3636
- #
3637
- # {
3638
- # position: "String",
3639
- # limit: 1,
3640
- # }
3641
- #
3642
2864
  # @!attribute [rw] position
3643
2865
  # The current pagination position in the paged result set.
3644
2866
  # @return [String]
@@ -3657,18 +2879,6 @@ module Aws::APIGateway
3657
2879
 
3658
2880
  # Request a new generated client SDK for a RestApi and Stage.
3659
2881
  #
3660
- # @note When making an API call, you may pass GetSdkRequest
3661
- # data as a hash:
3662
- #
3663
- # {
3664
- # rest_api_id: "String", # required
3665
- # stage_name: "String", # required
3666
- # sdk_type: "String", # required
3667
- # parameters: {
3668
- # "String" => "String",
3669
- # },
3670
- # }
3671
- #
3672
2882
  # @!attribute [rw] rest_api_id
3673
2883
  # The string identifier of the associated RestApi.
3674
2884
  # @return [String]
@@ -3704,13 +2914,6 @@ module Aws::APIGateway
3704
2914
 
3705
2915
  # Get an SdkType instance.
3706
2916
  #
3707
- # @note When making an API call, you may pass GetSdkTypeRequest
3708
- # data as a hash:
3709
- #
3710
- # {
3711
- # id: "String", # required
3712
- # }
3713
- #
3714
2917
  # @!attribute [rw] id
3715
2918
  # The identifier of the queried SdkType instance.
3716
2919
  # @return [String]
@@ -3723,14 +2926,6 @@ module Aws::APIGateway
3723
2926
 
3724
2927
  # Get the SdkTypes collection.
3725
2928
  #
3726
- # @note When making an API call, you may pass GetSdkTypesRequest
3727
- # data as a hash:
3728
- #
3729
- # {
3730
- # position: "String",
3731
- # limit: 1,
3732
- # }
3733
- #
3734
2929
  # @!attribute [rw] position
3735
2930
  # The current pagination position in the paged result set.
3736
2931
  # @return [String]
@@ -3749,14 +2944,6 @@ module Aws::APIGateway
3749
2944
 
3750
2945
  # Requests API Gateway to get information about a Stage resource.
3751
2946
  #
3752
- # @note When making an API call, you may pass GetStageRequest
3753
- # data as a hash:
3754
- #
3755
- # {
3756
- # rest_api_id: "String", # required
3757
- # stage_name: "String", # required
3758
- # }
3759
- #
3760
2947
  # @!attribute [rw] rest_api_id
3761
2948
  # The string identifier of the associated RestApi.
3762
2949
  # @return [String]
@@ -3775,14 +2962,6 @@ module Aws::APIGateway
3775
2962
  # Requests API Gateway to get information about one or more Stage
3776
2963
  # resources.
3777
2964
  #
3778
- # @note When making an API call, you may pass GetStagesRequest
3779
- # data as a hash:
3780
- #
3781
- # {
3782
- # rest_api_id: "String", # required
3783
- # deployment_id: "String",
3784
- # }
3785
- #
3786
2965
  # @!attribute [rw] rest_api_id
3787
2966
  # The string identifier of the associated RestApi.
3788
2967
  # @return [String]
@@ -3800,15 +2979,6 @@ module Aws::APIGateway
3800
2979
 
3801
2980
  # Gets the Tags collection for a given resource.
3802
2981
  #
3803
- # @note When making an API call, you may pass GetTagsRequest
3804
- # data as a hash:
3805
- #
3806
- # {
3807
- # resource_arn: "String", # required
3808
- # position: "String",
3809
- # limit: 1,
3810
- # }
3811
- #
3812
2982
  # @!attribute [rw] resource_arn
3813
2983
  # The ARN of a resource that can be tagged.
3814
2984
  # @return [String]
@@ -3833,14 +3003,6 @@ module Aws::APIGateway
3833
3003
 
3834
3004
  # The GET request to get a usage plan key of a given key identifier.
3835
3005
  #
3836
- # @note When making an API call, you may pass GetUsagePlanKeyRequest
3837
- # data as a hash:
3838
- #
3839
- # {
3840
- # usage_plan_id: "String", # required
3841
- # key_id: "String", # required
3842
- # }
3843
- #
3844
3006
  # @!attribute [rw] usage_plan_id
3845
3007
  # The Id of the UsagePlan resource representing the usage plan
3846
3008
  # containing the to-be-retrieved UsagePlanKey resource representing a
@@ -3862,16 +3024,6 @@ module Aws::APIGateway
3862
3024
  # The GET request to get all the usage plan keys representing the API
3863
3025
  # keys added to a specified usage plan.
3864
3026
  #
3865
- # @note When making an API call, you may pass GetUsagePlanKeysRequest
3866
- # data as a hash:
3867
- #
3868
- # {
3869
- # usage_plan_id: "String", # required
3870
- # position: "String",
3871
- # limit: 1,
3872
- # name_query: "String",
3873
- # }
3874
- #
3875
3027
  # @!attribute [rw] usage_plan_id
3876
3028
  # The Id of the UsagePlan resource representing the usage plan
3877
3029
  # containing the to-be-retrieved UsagePlanKey resource representing a
@@ -3903,13 +3055,6 @@ module Aws::APIGateway
3903
3055
 
3904
3056
  # The GET request to get a usage plan of a given plan identifier.
3905
3057
  #
3906
- # @note When making an API call, you may pass GetUsagePlanRequest
3907
- # data as a hash:
3908
- #
3909
- # {
3910
- # usage_plan_id: "String", # required
3911
- # }
3912
- #
3913
3058
  # @!attribute [rw] usage_plan_id
3914
3059
  # The identifier of the UsagePlan resource to be retrieved.
3915
3060
  # @return [String]
@@ -3922,15 +3067,6 @@ module Aws::APIGateway
3922
3067
 
3923
3068
  # The GET request to get all the usage plans of the caller's account.
3924
3069
  #
3925
- # @note When making an API call, you may pass GetUsagePlansRequest
3926
- # data as a hash:
3927
- #
3928
- # {
3929
- # position: "String",
3930
- # key_id: "String",
3931
- # limit: 1,
3932
- # }
3933
- #
3934
3070
  # @!attribute [rw] position
3935
3071
  # The current pagination position in the paged result set.
3936
3072
  # @return [String]
@@ -3955,18 +3091,6 @@ module Aws::APIGateway
3955
3091
  # The GET request to get the usage data of a usage plan in a specified
3956
3092
  # time interval.
3957
3093
  #
3958
- # @note When making an API call, you may pass GetUsageRequest
3959
- # data as a hash:
3960
- #
3961
- # {
3962
- # usage_plan_id: "String", # required
3963
- # key_id: "String",
3964
- # start_date: "String", # required
3965
- # end_date: "String", # required
3966
- # position: "String",
3967
- # limit: 1,
3968
- # }
3969
- #
3970
3094
  # @!attribute [rw] usage_plan_id
3971
3095
  # The Id of the usage plan associated with the usage data.
3972
3096
  # @return [String]
@@ -4005,13 +3129,6 @@ module Aws::APIGateway
4005
3129
 
4006
3130
  # Gets a specified VPC link under the caller's account in a region.
4007
3131
  #
4008
- # @note When making an API call, you may pass GetVpcLinkRequest
4009
- # data as a hash:
4010
- #
4011
- # {
4012
- # vpc_link_id: "String", # required
4013
- # }
4014
- #
4015
3132
  # @!attribute [rw] vpc_link_id
4016
3133
  # The identifier of the VpcLink. It is used in an Integration to
4017
3134
  # reference this VpcLink.
@@ -4026,14 +3143,6 @@ module Aws::APIGateway
4026
3143
  # Gets the VpcLinks collection under the caller's account in a selected
4027
3144
  # region.
4028
3145
  #
4029
- # @note When making an API call, you may pass GetVpcLinksRequest
4030
- # data as a hash:
4031
- #
4032
- # {
4033
- # position: "String",
4034
- # limit: 1,
4035
- # }
4036
- #
4037
3146
  # @!attribute [rw] position
4038
3147
  # The current pagination position in the paged result set.
4039
3148
  # @return [String]
@@ -4053,15 +3162,6 @@ module Aws::APIGateway
4053
3162
  # The POST request to import API keys from an external source, such as a
4054
3163
  # CSV-formatted file.
4055
3164
  #
4056
- # @note When making an API call, you may pass ImportApiKeysRequest
4057
- # data as a hash:
4058
- #
4059
- # {
4060
- # body: "data", # required
4061
- # format: "csv", # required, accepts csv
4062
- # fail_on_warnings: false,
4063
- # }
4064
- #
4065
3165
  # @!attribute [rw] body
4066
3166
  # The payload of the POST request to import API keys. For the payload
4067
3167
  # format, see API Key File Format.
@@ -4088,16 +3188,6 @@ module Aws::APIGateway
4088
3188
  # Import documentation parts from an external (e.g., OpenAPI) definition
4089
3189
  # file.
4090
3190
  #
4091
- # @note When making an API call, you may pass ImportDocumentationPartsRequest
4092
- # data as a hash:
4093
- #
4094
- # {
4095
- # rest_api_id: "String", # required
4096
- # mode: "merge", # accepts merge, overwrite
4097
- # fail_on_warnings: false,
4098
- # body: "data", # required
4099
- # }
4100
- #
4101
3191
  # @!attribute [rw] rest_api_id
4102
3192
  # The string identifier of the associated RestApi.
4103
3193
  # @return [String]
@@ -4131,17 +3221,6 @@ module Aws::APIGateway
4131
3221
  # A POST request to import an API to API Gateway using an input of an
4132
3222
  # API definition file.
4133
3223
  #
4134
- # @note When making an API call, you may pass ImportRestApiRequest
4135
- # data as a hash:
4136
- #
4137
- # {
4138
- # fail_on_warnings: false,
4139
- # parameters: {
4140
- # "String" => "String",
4141
- # },
4142
- # body: "data", # required
4143
- # }
4144
- #
4145
3224
  # @!attribute [rw] fail_on_warnings
4146
3225
  # A query parameter to indicate whether to rollback the API creation
4147
3226
  # (`true`) or not (`false`) when a warning is encountered. The default
@@ -4784,14 +3863,6 @@ module Aws::APIGateway
4784
3863
  # client and the server. Clients must present a trusted certificate to
4785
3864
  # access your API.
4786
3865
  #
4787
- # @note When making an API call, you may pass MutualTlsAuthenticationInput
4788
- # data as a hash:
4789
- #
4790
- # {
4791
- # truststore_uri: "String",
4792
- # truststore_version: "String",
4793
- # }
4794
- #
4795
3866
  # @!attribute [rw] truststore_uri
4796
3867
  # An Amazon S3 URL that specifies the truststore for mutual TLS
4797
3868
  # authentication, for example `s3://bucket-name/key-name`. The
@@ -4834,16 +3905,6 @@ module Aws::APIGateway
4834
3905
  #
4835
3906
  # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
4836
3907
  #
4837
- # @note When making an API call, you may pass PatchOperation
4838
- # data as a hash:
4839
- #
4840
- # {
4841
- # op: "add", # accepts add, remove, replace, move, copy, test
4842
- # path: "String",
4843
- # value: "String",
4844
- # from: "String",
4845
- # }
4846
- #
4847
3908
  # @!attribute [rw] op
4848
3909
  # An update operation to be performed with this PATCH request. The
4849
3910
  # valid value can be add, remove, replace or copy. Not all valid
@@ -4895,21 +3956,6 @@ module Aws::APIGateway
4895
3956
  # Creates a customization of a GatewayResponse of a specified response
4896
3957
  # type and status code on the given RestApi.
4897
3958
  #
4898
- # @note When making an API call, you may pass PutGatewayResponseRequest
4899
- # data as a hash:
4900
- #
4901
- # {
4902
- # rest_api_id: "String", # required
4903
- # 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, WAF_FILTERED
4904
- # status_code: "StatusCode",
4905
- # response_parameters: {
4906
- # "String" => "String",
4907
- # },
4908
- # response_templates: {
4909
- # "String" => "String",
4910
- # },
4911
- # }
4912
- #
4913
3959
  # @!attribute [rw] rest_api_id
4914
3960
  # The string identifier of the associated RestApi.
4915
3961
  # @return [String]
@@ -4944,35 +3990,6 @@ module Aws::APIGateway
4944
3990
 
4945
3991
  # Sets up a method's integration.
4946
3992
  #
4947
- # @note When making an API call, you may pass PutIntegrationRequest
4948
- # data as a hash:
4949
- #
4950
- # {
4951
- # rest_api_id: "String", # required
4952
- # resource_id: "String", # required
4953
- # http_method: "String", # required
4954
- # type: "HTTP", # required, accepts HTTP, AWS, MOCK, HTTP_PROXY, AWS_PROXY
4955
- # integration_http_method: "String",
4956
- # uri: "String",
4957
- # connection_type: "INTERNET", # accepts INTERNET, VPC_LINK
4958
- # connection_id: "String",
4959
- # credentials: "String",
4960
- # request_parameters: {
4961
- # "String" => "String",
4962
- # },
4963
- # request_templates: {
4964
- # "String" => "String",
4965
- # },
4966
- # passthrough_behavior: "String",
4967
- # cache_namespace: "String",
4968
- # cache_key_parameters: ["String"],
4969
- # content_handling: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT
4970
- # timeout_in_millis: 1,
4971
- # tls_config: {
4972
- # insecure_skip_verification: false,
4973
- # },
4974
- # }
4975
- #
4976
3993
  # @!attribute [rw] rest_api_id
4977
3994
  # The string identifier of the associated RestApi.
4978
3995
  # @return [String]
@@ -5122,24 +4139,6 @@ module Aws::APIGateway
5122
4139
 
5123
4140
  # Represents a put integration response request.
5124
4141
  #
5125
- # @note When making an API call, you may pass PutIntegrationResponseRequest
5126
- # data as a hash:
5127
- #
5128
- # {
5129
- # rest_api_id: "String", # required
5130
- # resource_id: "String", # required
5131
- # http_method: "String", # required
5132
- # status_code: "StatusCode", # required
5133
- # selection_pattern: "String",
5134
- # response_parameters: {
5135
- # "String" => "String",
5136
- # },
5137
- # response_templates: {
5138
- # "String" => "String",
5139
- # },
5140
- # content_handling: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT
5141
- # }
5142
- #
5143
4142
  # @!attribute [rw] rest_api_id
5144
4143
  # The string identifier of the associated RestApi.
5145
4144
  # @return [String]
@@ -5205,27 +4204,6 @@ module Aws::APIGateway
5205
4204
 
5206
4205
  # Request to add a method to an existing Resource resource.
5207
4206
  #
5208
- # @note When making an API call, you may pass PutMethodRequest
5209
- # data as a hash:
5210
- #
5211
- # {
5212
- # rest_api_id: "String", # required
5213
- # resource_id: "String", # required
5214
- # http_method: "String", # required
5215
- # authorization_type: "String", # required
5216
- # authorizer_id: "String",
5217
- # api_key_required: false,
5218
- # operation_name: "String",
5219
- # request_parameters: {
5220
- # "String" => false,
5221
- # },
5222
- # request_models: {
5223
- # "String" => "String",
5224
- # },
5225
- # request_validator_id: "String",
5226
- # authorization_scopes: ["String"],
5227
- # }
5228
- #
5229
4207
  # @!attribute [rw] rest_api_id
5230
4208
  # The string identifier of the associated RestApi.
5231
4209
  # @return [String]
@@ -5316,22 +4294,6 @@ module Aws::APIGateway
5316
4294
 
5317
4295
  # Request to add a MethodResponse to an existing Method resource.
5318
4296
  #
5319
- # @note When making an API call, you may pass PutMethodResponseRequest
5320
- # data as a hash:
5321
- #
5322
- # {
5323
- # rest_api_id: "String", # required
5324
- # resource_id: "String", # required
5325
- # http_method: "String", # required
5326
- # status_code: "StatusCode", # required
5327
- # response_parameters: {
5328
- # "String" => false,
5329
- # },
5330
- # response_models: {
5331
- # "String" => "String",
5332
- # },
5333
- # }
5334
- #
5335
4297
  # @!attribute [rw] rest_api_id
5336
4298
  # The string identifier of the associated RestApi.
5337
4299
  # @return [String]
@@ -5386,19 +4348,6 @@ module Aws::APIGateway
5386
4348
  # A PUT request to update an existing API, with external API definitions
5387
4349
  # specified as the request body.
5388
4350
  #
5389
- # @note When making an API call, you may pass PutRestApiRequest
5390
- # data as a hash:
5391
- #
5392
- # {
5393
- # rest_api_id: "String", # required
5394
- # mode: "merge", # accepts merge, overwrite
5395
- # fail_on_warnings: false,
5396
- # parameters: {
5397
- # "String" => "String",
5398
- # },
5399
- # body: "data", # required
5400
- # }
5401
- #
5402
4351
  # @!attribute [rw] rest_api_id
5403
4352
  # The string identifier of the associated RestApi.
5404
4353
  # @return [String]
@@ -5442,15 +4391,6 @@ module Aws::APIGateway
5442
4391
 
5443
4392
  # Quotas configured for a usage plan.
5444
4393
  #
5445
- # @note When making an API call, you may pass QuotaSettings
5446
- # data as a hash:
5447
- #
5448
- # {
5449
- # limit: 1,
5450
- # offset: 1,
5451
- # period: "DAY", # accepts DAY, WEEK, MONTH
5452
- # }
5453
- #
5454
4394
  # @!attribute [rw] limit
5455
4395
  # The target maximum number of requests that can be made in a given
5456
4396
  # time period.
@@ -5819,7 +4759,13 @@ module Aws::APIGateway
5819
4759
  # @return [Boolean]
5820
4760
  #
5821
4761
  # @!attribute [rw] cache_cluster_size
5822
- # The size of the cache cluster for the stage, if enabled.
4762
+ # The stage's cache capacity in GB. For more information about
4763
+ # choosing a cache size, see [Enabling API caching to enhance
4764
+ # responsiveness][1].
4765
+ #
4766
+ #
4767
+ #
4768
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html
5823
4769
  # @return [String]
5824
4770
  #
5825
4771
  # @!attribute [rw] cache_cluster_status
@@ -5899,14 +4845,6 @@ module Aws::APIGateway
5899
4845
  # A reference to a unique stage identified in the format
5900
4846
  # `\{restApiId\}/\{stage\}`.
5901
4847
  #
5902
- # @note When making an API call, you may pass StageKey
5903
- # data as a hash:
5904
- #
5905
- # {
5906
- # rest_api_id: "String",
5907
- # stage_name: "String",
5908
- # }
5909
- #
5910
4848
  # @!attribute [rw] rest_api_id
5911
4849
  # The string identifier of the associated RestApi.
5912
4850
  # @return [String]
@@ -5937,16 +4875,6 @@ module Aws::APIGateway
5937
4875
 
5938
4876
  # Adds or updates a tag on a given resource.
5939
4877
  #
5940
- # @note When making an API call, you may pass TagResourceRequest
5941
- # data as a hash:
5942
- #
5943
- # {
5944
- # resource_arn: "String", # required
5945
- # tags: { # required
5946
- # "String" => "String",
5947
- # },
5948
- # }
5949
- #
5950
4878
  # @!attribute [rw] resource_arn
5951
4879
  # The ARN of a resource that can be tagged.
5952
4880
  # @return [String]
@@ -5993,28 +4921,6 @@ module Aws::APIGateway
5993
4921
 
5994
4922
  # Make a request to simulate the invocation of an Authorizer.
5995
4923
  #
5996
- # @note When making an API call, you may pass TestInvokeAuthorizerRequest
5997
- # data as a hash:
5998
- #
5999
- # {
6000
- # rest_api_id: "String", # required
6001
- # authorizer_id: "String", # required
6002
- # headers: {
6003
- # "String" => "String",
6004
- # },
6005
- # multi_value_headers: {
6006
- # "String" => ["String"],
6007
- # },
6008
- # path_with_query_string: "String",
6009
- # body: "String",
6010
- # stage_variables: {
6011
- # "String" => "String",
6012
- # },
6013
- # additional_context: {
6014
- # "String" => "String",
6015
- # },
6016
- # }
6017
- #
6018
4924
  # @!attribute [rw] rest_api_id
6019
4925
  # The string identifier of the associated RestApi.
6020
4926
  # @return [String]
@@ -6114,27 +5020,6 @@ module Aws::APIGateway
6114
5020
 
6115
5021
  # Make a request to simulate the invocation of a Method.
6116
5022
  #
6117
- # @note When making an API call, you may pass TestInvokeMethodRequest
6118
- # data as a hash:
6119
- #
6120
- # {
6121
- # rest_api_id: "String", # required
6122
- # resource_id: "String", # required
6123
- # http_method: "String", # required
6124
- # path_with_query_string: "String",
6125
- # body: "String",
6126
- # headers: {
6127
- # "String" => "String",
6128
- # },
6129
- # multi_value_headers: {
6130
- # "String" => ["String"],
6131
- # },
6132
- # client_certificate_id: "String",
6133
- # stage_variables: {
6134
- # "String" => "String",
6135
- # },
6136
- # }
6137
- #
6138
5023
  # @!attribute [rw] rest_api_id
6139
5024
  # The string identifier of the associated RestApi.
6140
5025
  # @return [String]
@@ -6232,14 +5117,6 @@ module Aws::APIGateway
6232
5117
 
6233
5118
  # The API request rate limits.
6234
5119
  #
6235
- # @note When making an API call, you may pass ThrottleSettings
6236
- # data as a hash:
6237
- #
6238
- # {
6239
- # burst_limit: 1,
6240
- # rate_limit: 1.0,
6241
- # }
6242
- #
6243
5120
  # @!attribute [rw] burst_limit
6244
5121
  # The API target request burst rate limit. This allows more requests
6245
5122
  # through for a period of time than the target rate limit.
@@ -6258,13 +5135,6 @@ module Aws::APIGateway
6258
5135
 
6259
5136
  # Specifies the TLS configuration for an integration.
6260
5137
  #
6261
- # @note When making an API call, you may pass TlsConfig
6262
- # data as a hash:
6263
- #
6264
- # {
6265
- # insecure_skip_verification: false,
6266
- # }
6267
- #
6268
5138
  # @!attribute [rw] insecure_skip_verification
6269
5139
  # Specifies whether or not API Gateway skips verification that the
6270
5140
  # certificate for an integration endpoint is issued by a supported
@@ -6317,14 +5187,6 @@ module Aws::APIGateway
6317
5187
 
6318
5188
  # Removes a tag from a given resource.
6319
5189
  #
6320
- # @note When making an API call, you may pass UntagResourceRequest
6321
- # data as a hash:
6322
- #
6323
- # {
6324
- # resource_arn: "String", # required
6325
- # tag_keys: ["String"], # required
6326
- # }
6327
- #
6328
5190
  # @!attribute [rw] resource_arn
6329
5191
  # The ARN of a resource that can be tagged.
6330
5192
  # @return [String]
@@ -6343,20 +5205,6 @@ module Aws::APIGateway
6343
5205
  # Requests API Gateway to change information about the current Account
6344
5206
  # resource.
6345
5207
  #
6346
- # @note When making an API call, you may pass UpdateAccountRequest
6347
- # data as a hash:
6348
- #
6349
- # {
6350
- # patch_operations: [
6351
- # {
6352
- # op: "add", # accepts add, remove, replace, move, copy, test
6353
- # path: "String",
6354
- # value: "String",
6355
- # from: "String",
6356
- # },
6357
- # ],
6358
- # }
6359
- #
6360
5208
  # @!attribute [rw] patch_operations
6361
5209
  # For more information about supported patch operations, see [Patch
6362
5210
  # Operations][1].
@@ -6374,21 +5222,6 @@ module Aws::APIGateway
6374
5222
 
6375
5223
  # A request to change information about an ApiKey resource.
6376
5224
  #
6377
- # @note When making an API call, you may pass UpdateApiKeyRequest
6378
- # data as a hash:
6379
- #
6380
- # {
6381
- # api_key: "String", # required
6382
- # patch_operations: [
6383
- # {
6384
- # op: "add", # accepts add, remove, replace, move, copy, test
6385
- # path: "String",
6386
- # value: "String",
6387
- # from: "String",
6388
- # },
6389
- # ],
6390
- # }
6391
- #
6392
5225
  # @!attribute [rw] api_key
6393
5226
  # The identifier of the ApiKey resource to be updated.
6394
5227
  # @return [String]
@@ -6411,22 +5244,6 @@ module Aws::APIGateway
6411
5244
 
6412
5245
  # Request to update an existing Authorizer resource.
6413
5246
  #
6414
- # @note When making an API call, you may pass UpdateAuthorizerRequest
6415
- # data as a hash:
6416
- #
6417
- # {
6418
- # rest_api_id: "String", # required
6419
- # authorizer_id: "String", # required
6420
- # patch_operations: [
6421
- # {
6422
- # op: "add", # accepts add, remove, replace, move, copy, test
6423
- # path: "String",
6424
- # value: "String",
6425
- # from: "String",
6426
- # },
6427
- # ],
6428
- # }
6429
- #
6430
5247
  # @!attribute [rw] rest_api_id
6431
5248
  # The string identifier of the associated RestApi.
6432
5249
  # @return [String]
@@ -6454,22 +5271,6 @@ module Aws::APIGateway
6454
5271
 
6455
5272
  # A request to change information about the BasePathMapping resource.
6456
5273
  #
6457
- # @note When making an API call, you may pass UpdateBasePathMappingRequest
6458
- # data as a hash:
6459
- #
6460
- # {
6461
- # domain_name: "String", # required
6462
- # base_path: "String", # required
6463
- # patch_operations: [
6464
- # {
6465
- # op: "add", # accepts add, remove, replace, move, copy, test
6466
- # path: "String",
6467
- # value: "String",
6468
- # from: "String",
6469
- # },
6470
- # ],
6471
- # }
6472
- #
6473
5274
  # @!attribute [rw] domain_name
6474
5275
  # The domain name of the BasePathMapping resource to change.
6475
5276
  # @return [String]
@@ -6499,21 +5300,6 @@ module Aws::APIGateway
6499
5300
 
6500
5301
  # A request to change information about an ClientCertificate resource.
6501
5302
  #
6502
- # @note When making an API call, you may pass UpdateClientCertificateRequest
6503
- # data as a hash:
6504
- #
6505
- # {
6506
- # client_certificate_id: "String", # required
6507
- # patch_operations: [
6508
- # {
6509
- # op: "add", # accepts add, remove, replace, move, copy, test
6510
- # path: "String",
6511
- # value: "String",
6512
- # from: "String",
6513
- # },
6514
- # ],
6515
- # }
6516
- #
6517
5303
  # @!attribute [rw] client_certificate_id
6518
5304
  # The identifier of the ClientCertificate resource to be updated.
6519
5305
  # @return [String]
@@ -6537,22 +5323,6 @@ module Aws::APIGateway
6537
5323
  # Requests API Gateway to change information about a Deployment
6538
5324
  # resource.
6539
5325
  #
6540
- # @note When making an API call, you may pass UpdateDeploymentRequest
6541
- # data as a hash:
6542
- #
6543
- # {
6544
- # rest_api_id: "String", # required
6545
- # deployment_id: "String", # required
6546
- # patch_operations: [
6547
- # {
6548
- # op: "add", # accepts add, remove, replace, move, copy, test
6549
- # path: "String",
6550
- # value: "String",
6551
- # from: "String",
6552
- # },
6553
- # ],
6554
- # }
6555
- #
6556
5326
  # @!attribute [rw] rest_api_id
6557
5327
  # The string identifier of the associated RestApi.
6558
5328
  # @return [String]
@@ -6581,22 +5351,6 @@ module Aws::APIGateway
6581
5351
 
6582
5352
  # Updates an existing documentation part of a given API.
6583
5353
  #
6584
- # @note When making an API call, you may pass UpdateDocumentationPartRequest
6585
- # data as a hash:
6586
- #
6587
- # {
6588
- # rest_api_id: "String", # required
6589
- # documentation_part_id: "String", # required
6590
- # patch_operations: [
6591
- # {
6592
- # op: "add", # accepts add, remove, replace, move, copy, test
6593
- # path: "String",
6594
- # value: "String",
6595
- # from: "String",
6596
- # },
6597
- # ],
6598
- # }
6599
- #
6600
5354
  # @!attribute [rw] rest_api_id
6601
5355
  # The string identifier of the associated RestApi.
6602
5356
  # @return [String]
@@ -6624,22 +5378,6 @@ module Aws::APIGateway
6624
5378
 
6625
5379
  # Updates an existing documentation version of an API.
6626
5380
  #
6627
- # @note When making an API call, you may pass UpdateDocumentationVersionRequest
6628
- # data as a hash:
6629
- #
6630
- # {
6631
- # rest_api_id: "String", # required
6632
- # documentation_version: "String", # required
6633
- # patch_operations: [
6634
- # {
6635
- # op: "add", # accepts add, remove, replace, move, copy, test
6636
- # path: "String",
6637
- # value: "String",
6638
- # from: "String",
6639
- # },
6640
- # ],
6641
- # }
6642
- #
6643
5381
  # @!attribute [rw] rest_api_id
6644
5382
  # The string identifier of the associated RestApi..
6645
5383
  # @return [String]
@@ -6667,21 +5405,6 @@ module Aws::APIGateway
6667
5405
 
6668
5406
  # A request to change information about the DomainName resource.
6669
5407
  #
6670
- # @note When making an API call, you may pass UpdateDomainNameRequest
6671
- # data as a hash:
6672
- #
6673
- # {
6674
- # domain_name: "String", # required
6675
- # patch_operations: [
6676
- # {
6677
- # op: "add", # accepts add, remove, replace, move, copy, test
6678
- # path: "String",
6679
- # value: "String",
6680
- # from: "String",
6681
- # },
6682
- # ],
6683
- # }
6684
- #
6685
5408
  # @!attribute [rw] domain_name
6686
5409
  # The name of the DomainName resource to be changed.
6687
5410
  # @return [String]
@@ -6705,22 +5428,6 @@ module Aws::APIGateway
6705
5428
  # Updates a GatewayResponse of a specified response type on the given
6706
5429
  # RestApi.
6707
5430
  #
6708
- # @note When making an API call, you may pass UpdateGatewayResponseRequest
6709
- # data as a hash:
6710
- #
6711
- # {
6712
- # rest_api_id: "String", # required
6713
- # 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, WAF_FILTERED
6714
- # patch_operations: [
6715
- # {
6716
- # op: "add", # accepts add, remove, replace, move, copy, test
6717
- # path: "String",
6718
- # value: "String",
6719
- # from: "String",
6720
- # },
6721
- # ],
6722
- # }
6723
- #
6724
5431
  # @!attribute [rw] rest_api_id
6725
5432
  # The string identifier of the associated RestApi.
6726
5433
  # @return [String]
@@ -6748,23 +5455,6 @@ module Aws::APIGateway
6748
5455
 
6749
5456
  # Represents an update integration request.
6750
5457
  #
6751
- # @note When making an API call, you may pass UpdateIntegrationRequest
6752
- # data as a hash:
6753
- #
6754
- # {
6755
- # rest_api_id: "String", # required
6756
- # resource_id: "String", # required
6757
- # http_method: "String", # required
6758
- # patch_operations: [
6759
- # {
6760
- # op: "add", # accepts add, remove, replace, move, copy, test
6761
- # path: "String",
6762
- # value: "String",
6763
- # from: "String",
6764
- # },
6765
- # ],
6766
- # }
6767
- #
6768
5458
  # @!attribute [rw] rest_api_id
6769
5459
  # The string identifier of the associated RestApi.
6770
5460
  # @return [String]
@@ -6797,24 +5487,6 @@ module Aws::APIGateway
6797
5487
 
6798
5488
  # Represents an update integration response request.
6799
5489
  #
6800
- # @note When making an API call, you may pass UpdateIntegrationResponseRequest
6801
- # data as a hash:
6802
- #
6803
- # {
6804
- # rest_api_id: "String", # required
6805
- # resource_id: "String", # required
6806
- # http_method: "String", # required
6807
- # status_code: "StatusCode", # required
6808
- # patch_operations: [
6809
- # {
6810
- # op: "add", # accepts add, remove, replace, move, copy, test
6811
- # path: "String",
6812
- # value: "String",
6813
- # from: "String",
6814
- # },
6815
- # ],
6816
- # }
6817
- #
6818
5490
  # @!attribute [rw] rest_api_id
6819
5491
  # The string identifier of the associated RestApi.
6820
5492
  # @return [String]
@@ -6853,23 +5525,6 @@ module Aws::APIGateway
6853
5525
 
6854
5526
  # Request to update an existing Method resource.
6855
5527
  #
6856
- # @note When making an API call, you may pass UpdateMethodRequest
6857
- # data as a hash:
6858
- #
6859
- # {
6860
- # rest_api_id: "String", # required
6861
- # resource_id: "String", # required
6862
- # http_method: "String", # required
6863
- # patch_operations: [
6864
- # {
6865
- # op: "add", # accepts add, remove, replace, move, copy, test
6866
- # path: "String",
6867
- # value: "String",
6868
- # from: "String",
6869
- # },
6870
- # ],
6871
- # }
6872
- #
6873
5528
  # @!attribute [rw] rest_api_id
6874
5529
  # The string identifier of the associated RestApi.
6875
5530
  # @return [String]
@@ -6902,24 +5557,6 @@ module Aws::APIGateway
6902
5557
 
6903
5558
  # A request to update an existing MethodResponse resource.
6904
5559
  #
6905
- # @note When making an API call, you may pass UpdateMethodResponseRequest
6906
- # data as a hash:
6907
- #
6908
- # {
6909
- # rest_api_id: "String", # required
6910
- # resource_id: "String", # required
6911
- # http_method: "String", # required
6912
- # status_code: "StatusCode", # required
6913
- # patch_operations: [
6914
- # {
6915
- # op: "add", # accepts add, remove, replace, move, copy, test
6916
- # path: "String",
6917
- # value: "String",
6918
- # from: "String",
6919
- # },
6920
- # ],
6921
- # }
6922
- #
6923
5560
  # @!attribute [rw] rest_api_id
6924
5561
  # The string identifier of the associated RestApi.
6925
5562
  # @return [String]
@@ -6957,22 +5594,6 @@ module Aws::APIGateway
6957
5594
 
6958
5595
  # Request to update an existing model in an existing RestApi resource.
6959
5596
  #
6960
- # @note When making an API call, you may pass UpdateModelRequest
6961
- # data as a hash:
6962
- #
6963
- # {
6964
- # rest_api_id: "String", # required
6965
- # model_name: "String", # required
6966
- # patch_operations: [
6967
- # {
6968
- # op: "add", # accepts add, remove, replace, move, copy, test
6969
- # path: "String",
6970
- # value: "String",
6971
- # from: "String",
6972
- # },
6973
- # ],
6974
- # }
6975
- #
6976
5597
  # @!attribute [rw] rest_api_id
6977
5598
  # The string identifier of the associated RestApi.
6978
5599
  # @return [String]
@@ -7000,22 +5621,6 @@ module Aws::APIGateway
7000
5621
 
7001
5622
  # Updates a RequestValidator of a given RestApi.
7002
5623
  #
7003
- # @note When making an API call, you may pass UpdateRequestValidatorRequest
7004
- # data as a hash:
7005
- #
7006
- # {
7007
- # rest_api_id: "String", # required
7008
- # request_validator_id: "String", # required
7009
- # patch_operations: [
7010
- # {
7011
- # op: "add", # accepts add, remove, replace, move, copy, test
7012
- # path: "String",
7013
- # value: "String",
7014
- # from: "String",
7015
- # },
7016
- # ],
7017
- # }
7018
- #
7019
5624
  # @!attribute [rw] rest_api_id
7020
5625
  # The string identifier of the associated RestApi.
7021
5626
  # @return [String]
@@ -7043,22 +5648,6 @@ module Aws::APIGateway
7043
5648
 
7044
5649
  # Request to change information about a Resource resource.
7045
5650
  #
7046
- # @note When making an API call, you may pass UpdateResourceRequest
7047
- # data as a hash:
7048
- #
7049
- # {
7050
- # rest_api_id: "String", # required
7051
- # resource_id: "String", # required
7052
- # patch_operations: [
7053
- # {
7054
- # op: "add", # accepts add, remove, replace, move, copy, test
7055
- # path: "String",
7056
- # value: "String",
7057
- # from: "String",
7058
- # },
7059
- # ],
7060
- # }
7061
- #
7062
5651
  # @!attribute [rw] rest_api_id
7063
5652
  # The string identifier of the associated RestApi.
7064
5653
  # @return [String]
@@ -7086,21 +5675,6 @@ module Aws::APIGateway
7086
5675
 
7087
5676
  # Request to update an existing RestApi resource in your collection.
7088
5677
  #
7089
- # @note When making an API call, you may pass UpdateRestApiRequest
7090
- # data as a hash:
7091
- #
7092
- # {
7093
- # rest_api_id: "String", # required
7094
- # patch_operations: [
7095
- # {
7096
- # op: "add", # accepts add, remove, replace, move, copy, test
7097
- # path: "String",
7098
- # value: "String",
7099
- # from: "String",
7100
- # },
7101
- # ],
7102
- # }
7103
- #
7104
5678
  # @!attribute [rw] rest_api_id
7105
5679
  # The string identifier of the associated RestApi.
7106
5680
  # @return [String]
@@ -7123,22 +5697,6 @@ module Aws::APIGateway
7123
5697
 
7124
5698
  # Requests API Gateway to change information about a Stage resource.
7125
5699
  #
7126
- # @note When making an API call, you may pass UpdateStageRequest
7127
- # data as a hash:
7128
- #
7129
- # {
7130
- # rest_api_id: "String", # required
7131
- # stage_name: "String", # required
7132
- # patch_operations: [
7133
- # {
7134
- # op: "add", # accepts add, remove, replace, move, copy, test
7135
- # path: "String",
7136
- # value: "String",
7137
- # from: "String",
7138
- # },
7139
- # ],
7140
- # }
7141
- #
7142
5700
  # @!attribute [rw] rest_api_id
7143
5701
  # The string identifier of the associated RestApi.
7144
5702
  # @return [String]
@@ -7166,21 +5724,6 @@ module Aws::APIGateway
7166
5724
 
7167
5725
  # The PATCH request to update a usage plan of a given plan Id.
7168
5726
  #
7169
- # @note When making an API call, you may pass UpdateUsagePlanRequest
7170
- # data as a hash:
7171
- #
7172
- # {
7173
- # usage_plan_id: "String", # required
7174
- # patch_operations: [
7175
- # {
7176
- # op: "add", # accepts add, remove, replace, move, copy, test
7177
- # path: "String",
7178
- # value: "String",
7179
- # from: "String",
7180
- # },
7181
- # ],
7182
- # }
7183
- #
7184
5727
  # @!attribute [rw] usage_plan_id
7185
5728
  # The Id of the to-be-updated usage plan.
7186
5729
  # @return [String]
@@ -7204,22 +5747,6 @@ module Aws::APIGateway
7204
5747
  # The PATCH request to grant a temporary extension to the remaining
7205
5748
  # quota of a usage plan associated with a specified API key.
7206
5749
  #
7207
- # @note When making an API call, you may pass UpdateUsageRequest
7208
- # data as a hash:
7209
- #
7210
- # {
7211
- # usage_plan_id: "String", # required
7212
- # key_id: "String", # required
7213
- # patch_operations: [
7214
- # {
7215
- # op: "add", # accepts add, remove, replace, move, copy, test
7216
- # path: "String",
7217
- # value: "String",
7218
- # from: "String",
7219
- # },
7220
- # ],
7221
- # }
7222
- #
7223
5750
  # @!attribute [rw] usage_plan_id
7224
5751
  # The Id of the usage plan associated with the usage data.
7225
5752
  # @return [String]
@@ -7248,21 +5775,6 @@ module Aws::APIGateway
7248
5775
 
7249
5776
  # Updates an existing VpcLink of a specified identifier.
7250
5777
  #
7251
- # @note When making an API call, you may pass UpdateVpcLinkRequest
7252
- # data as a hash:
7253
- #
7254
- # {
7255
- # vpc_link_id: "String", # required
7256
- # patch_operations: [
7257
- # {
7258
- # op: "add", # accepts add, remove, replace, move, copy, test
7259
- # path: "String",
7260
- # value: "String",
7261
- # from: "String",
7262
- # },
7263
- # ],
7264
- # }
7265
- #
7266
5778
  # @!attribute [rw] vpc_link_id
7267
5779
  # The identifier of the VpcLink. It is used in an Integration to
7268
5780
  # reference this VpcLink.