aws-sdk-apigateway 1.9.0 → 1.10.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: f00d08b5cb94857cdb5c87951ec35a9487699a66
4
- data.tar.gz: b8600cb912484bf24bd34f4e458c439876c536ef
3
+ metadata.gz: 6ea9b35c945782365efcabb04af42664ed0b15ff
4
+ data.tar.gz: f36e1c6820f78c33b88e16e8bd33bffc56742ab4
5
5
  SHA512:
6
- metadata.gz: 96a52394a1b05ba946ad13b52cf4bf74a76e50f8c9344976008f7dc7e434b0fbd41a4efe802f0dc6ff7262ea8497350ec686a21c404b58be03153bfb5c92df2b
7
- data.tar.gz: 382e089aac2ec94d6356308148089cbfb49c3a43f7c2bb3ed6198480197c639174a700aa04604e64dd143c32e8689215b0bbe5d9d7fe2530b228f4313b0a4ed3
6
+ metadata.gz: c0aea8a1b1092316634cd29b56a8ae3f78ce27907d967cb8dec11507c6b0d54ba1f69e272cc6bdfd25934be29e316e9b2af49db384d40a93dd2b41b8215872e0
7
+ data.tar.gz: e8ea20f13908b5176442391c489efad743ba56c0f769b071f7c09373a4c916f443d6226aa64621b5f7180cd66f225b04608d34c7caf9f3933a4bf3a6ca805ca1
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-apigateway/customizations'
42
42
  # @service
43
43
  module Aws::APIGateway
44
44
 
45
- GEM_VERSION = '1.9.0'
45
+ GEM_VERSION = '1.10.0'
46
46
 
47
47
  end
@@ -241,7 +241,7 @@ module Aws::APIGateway
241
241
  # [1]: http://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html
242
242
  #
243
243
  # @option params [required, String] :rest_api_id
244
- # The string identifier of the associated RestApi.
244
+ # \[Required\] The string identifier of the associated RestApi.
245
245
  #
246
246
  # @option params [required, String] :name
247
247
  # \[Required\] The name of the authorizer.
@@ -284,11 +284,11 @@ module Aws::APIGateway
284
284
  #
285
285
  # @option params [String] :identity_source
286
286
  # The identity source for which authorization is requested. * For a
287
- # `TOKEN` authorizer, this is required and specifies the request
288
- # header mapping expression for the custom header holding the
289
- # authorization token submitted by the client. For example, if the
290
- # token header name is `Auth`, the header mapping expression is
291
- # `method.request.header.Auth`.
287
+ # `TOKEN` or `COGNITO_USER_POOLS` authorizer, this is required
288
+ # and specifies the request header mapping expression for the custom
289
+ # header holding the authorization token submitted by the client. For
290
+ # example, if the token header name is `Auth`, the header mapping
291
+ # expression is `method.request.header.Auth`.
292
292
  # * For the `REQUEST` authorizer, this is required when authorization
293
293
  # caching is enabled. The value is a comma-separated string of one or
294
294
  # more mapping expressions of the specified request parameters. For
@@ -304,16 +304,15 @@ module Aws::APIGateway
304
304
  # function. The valid value is a string of comma-separated mapping
305
305
  # expressions of the specified request parameters. When the
306
306
  # authorization caching is not enabled, this property is optional.
307
- # * For a `COGNITO_USER_POOLS` authorizer, this property is not used.
308
307
  #
309
308
  # @option params [String] :identity_validation_expression
310
309
  # A validation expression for the incoming identity token. For `TOKEN`
311
310
  # authorizers, this value is a regular expression. API Gateway will
312
- # match the incoming token from the client against the specified regular
313
- # expression. It will invoke the authorizer's Lambda function there is
314
- # a match. Otherwise, it will return a 401 Unauthorized response without
315
- # calling the Lambda function. The validation expression does not apply
316
- # to the `REQUEST` authorizer.
311
+ # match the `aud` field of the incoming token from the client against
312
+ # the specified regular expression. It will invoke the authorizer's
313
+ # Lambda function when there is a match. Otherwise, it will return a 401
314
+ # Unauthorized response without calling the Lambda function. The
315
+ # validation expression does not apply to the `REQUEST` authorizer.
317
316
  #
318
317
  # @option params [Integer] :authorizer_result_ttl_in_seconds
319
318
  # The TTL in seconds of cached authorizer results. If it equals 0,
@@ -373,7 +372,8 @@ module Aws::APIGateway
373
372
  # Creates a new BasePathMapping resource.
374
373
  #
375
374
  # @option params [required, String] :domain_name
376
- # The domain name of the BasePathMapping resource to create.
375
+ # \[Required\] The domain name of the BasePathMapping resource to
376
+ # create.
377
377
  #
378
378
  # @option params [String] :base_path
379
379
  # The base path name that callers of the API must provide as part of the
@@ -382,7 +382,7 @@ module Aws::APIGateway
382
382
  # callers to specify a base path name after the domain name.
383
383
  #
384
384
  # @option params [required, String] :rest_api_id
385
- # The string identifier of the associated RestApi.
385
+ # \[Required\] The string identifier of the associated RestApi.
386
386
  #
387
387
  # @option params [String] :stage
388
388
  # The name of the API's stage that you want to use for this mapping.
@@ -421,7 +421,7 @@ module Aws::APIGateway
421
421
  # callable over the internet.
422
422
  #
423
423
  # @option params [required, String] :rest_api_id
424
- # The string identifier of the associated RestApi.
424
+ # \[Required\] The string identifier of the associated RestApi.
425
425
  #
426
426
  # @option params [String] :stage_name
427
427
  # The name of the Stage resource for the Deployment resource to create.
@@ -588,7 +588,7 @@ module Aws::APIGateway
588
588
  # Creates a new domain name.
589
589
  #
590
590
  # @option params [required, String] :domain_name
591
- # (Required) The name of the DomainName resource.
591
+ # \[Required\] The name of the DomainName resource.
592
592
  #
593
593
  # @option params [String] :certificate_name
594
594
  # The user-friendly name of the certificate that will be used by
@@ -685,24 +685,25 @@ module Aws::APIGateway
685
685
  # Adds a new Model resource to an existing RestApi resource.
686
686
  #
687
687
  # @option params [required, String] :rest_api_id
688
- # The RestApi identifier under which the Model will be created.
688
+ # \[Required\] The RestApi identifier under which the Model will be
689
+ # created.
689
690
  #
690
691
  # @option params [required, String] :name
691
- # The name of the model. Must be alphanumeric.
692
+ # \[Required\] The name of the model. Must be alphanumeric.
692
693
  #
693
694
  # @option params [String] :description
694
695
  # The description of the model.
695
696
  #
696
697
  # @option params [String] :schema
697
698
  # The schema for the model. For `application/json` models, this should
698
- # be [JSON-schema draft v4][1] model.
699
+ # be [JSON schema draft 4][1] model.
699
700
  #
700
701
  #
701
702
  #
702
- # [1]: http://json-schema.org/documentation.html
703
+ # [1]: https://tools.ietf.org/html/draft-zyp-json-schema-04
703
704
  #
704
705
  # @option params [required, String] :content_type
705
- # The content-type for the model.
706
+ # \[Required\] The content-type for the model.
706
707
  #
707
708
  # @return [Types::Model] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
708
709
  #
@@ -740,7 +741,7 @@ module Aws::APIGateway
740
741
  # Creates a ReqeustValidator of a given RestApi.
741
742
  #
742
743
  # @option params [required, String] :rest_api_id
743
- # The string identifier of the associated RestApi.
744
+ # \[Required\] The string identifier of the associated RestApi.
744
745
  #
745
746
  # @option params [String] :name
746
747
  # The name of the to-be-created RequestValidator.
@@ -787,10 +788,10 @@ module Aws::APIGateway
787
788
  # Creates a Resource resource.
788
789
  #
789
790
  # @option params [required, String] :rest_api_id
790
- # The string identifier of the associated RestApi.
791
+ # \[Required\] The string identifier of the associated RestApi.
791
792
  #
792
793
  # @option params [required, String] :parent_id
793
- # The parent resource's identifier.
794
+ # \[Required\] The parent resource's identifier.
794
795
  #
795
796
  # @option params [required, String] :path_part
796
797
  # The last path segment for this resource.
@@ -871,7 +872,7 @@ module Aws::APIGateway
871
872
  # Creates a new RestApi resource.
872
873
  #
873
874
  # @option params [required, String] :name
874
- # The name of the RestApi.
875
+ # \[Required\] The name of the RestApi.
875
876
  #
876
877
  # @option params [String] :description
877
878
  # The description of the RestApi.
@@ -887,15 +888,16 @@ module Aws::APIGateway
887
888
  # the RestApi supports only UTF-8-encoded text payloads.
888
889
  #
889
890
  # @option params [Integer] :minimum_compression_size
890
- # A nullable integer used to enable (non-negative between 0 and 10485760
891
- # (10M) bytes, inclusive) or disable (null) compression on an API. When
892
- # compression is enabled, compression or decompression are not applied
893
- # on the payload if the payload size is smaller than this value. Setting
894
- # it to zero allows compression for any payload size.
891
+ # A nullable integer that is used to enable compression (with
892
+ # non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable
893
+ # compression (with a null value) on an API. When compression is
894
+ # enabled, compression or decompression is not applied on the payload if
895
+ # the payload size is smaller than this value. Setting it to zero allows
896
+ # compression for any payload size.
895
897
  #
896
898
  # @option params [String] :api_key_source
897
- # The source of the API key for metring requests according to a usage
898
- # plan. Valid values are * `HEADER` to read the API key from the
899
+ # The source of the API key for metering requests according to a usage
900
+ # plan. Valid values are: * `HEADER` to read the API key from the
899
901
  # `X-API-Key` header of a
900
902
  # request.
901
903
  # * `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from
@@ -905,6 +907,9 @@ module Aws::APIGateway
905
907
  # The endpoint configuration of this RestApi showing the endpoint types
906
908
  # of the API.
907
909
  #
910
+ # @option params [String] :policy
911
+ # A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
912
+ #
908
913
  # @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
909
914
  #
910
915
  # * {Types::RestApi#id #id} => String
@@ -917,6 +922,7 @@ module Aws::APIGateway
917
922
  # * {Types::RestApi#minimum_compression_size #minimum_compression_size} => Integer
918
923
  # * {Types::RestApi#api_key_source #api_key_source} => String
919
924
  # * {Types::RestApi#endpoint_configuration #endpoint_configuration} => Types::EndpointConfiguration
925
+ # * {Types::RestApi#policy #policy} => String
920
926
  #
921
927
  # @example Request syntax with placeholder values
922
928
  #
@@ -931,6 +937,7 @@ module Aws::APIGateway
931
937
  # endpoint_configuration: {
932
938
  # types: ["REGIONAL"], # accepts REGIONAL, EDGE
933
939
  # },
940
+ # policy: "String",
934
941
  # })
935
942
  #
936
943
  # @example Response structure
@@ -948,6 +955,7 @@ module Aws::APIGateway
948
955
  # resp.api_key_source #=> String, one of "HEADER", "AUTHORIZER"
949
956
  # resp.endpoint_configuration.types #=> Array
950
957
  # resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE"
958
+ # resp.policy #=> String
951
959
  #
952
960
  # @overload create_rest_api(params = {})
953
961
  # @param [Hash] params ({})
@@ -960,7 +968,7 @@ module Aws::APIGateway
960
968
  # for the API.
961
969
  #
962
970
  # @option params [required, String] :rest_api_id
963
- # The string identifier of the associated RestApi.
971
+ # \[Required\] The string identifier of the associated RestApi.
964
972
  #
965
973
  # @option params [required, String] :stage_name
966
974
  # \[Required\] The name for the Stage resource.
@@ -990,9 +998,9 @@ module Aws::APIGateway
990
998
  # The canary deployment settings of this stage.
991
999
  #
992
1000
  # @option params [Hash<String,String>] :tags
993
- # Key/Value map of strings. Valid character set is \[a-zA-Z+-=.\_:/\].
994
- # Tag key can be up to 128 characters and must not start with "aws:".
995
- # Tag value can be up to 256 characters.
1001
+ # The key-value map of strings. The valid character set is
1002
+ # \[a-zA-Z+-=.\_:/\]. The tag key can be up to 128 characters and must
1003
+ # not start with `aws:`. The tag value can be up to 256 characters.
996
1004
  #
997
1005
  # @return [Types::Stage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
998
1006
  #
@@ -1084,7 +1092,7 @@ module Aws::APIGateway
1084
1092
  # the associated API stages, specified in the payload.
1085
1093
  #
1086
1094
  # @option params [required, String] :name
1087
- # The name of the usage plan.
1095
+ # \[Required\] The name of the usage plan.
1088
1096
  #
1089
1097
  # @option params [String] :description
1090
1098
  # The description of the usage plan.
@@ -1156,15 +1164,16 @@ module Aws::APIGateway
1156
1164
  # plan.
1157
1165
  #
1158
1166
  # @option params [required, String] :usage_plan_id
1159
- # The Id of the UsagePlan resource representing the usage plan
1160
- # containing the to-be-created UsagePlanKey resource representing a plan
1161
- # customer.
1167
+ # \[Required\] The Id of the UsagePlan resource representing the usage
1168
+ # plan containing the to-be-created UsagePlanKey resource representing a
1169
+ # plan customer.
1162
1170
  #
1163
1171
  # @option params [required, String] :key_id
1164
- # The identifier of a UsagePlanKey resource for a plan customer.
1172
+ # \[Required\] The identifier of a UsagePlanKey resource for a plan
1173
+ # customer.
1165
1174
  #
1166
1175
  # @option params [required, String] :key_type
1167
- # The type of a UsagePlanKey resource for a plan customer.
1176
+ # \[Required\] The type of a UsagePlanKey resource for a plan customer.
1168
1177
  #
1169
1178
  # @return [Types::UsagePlanKey] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1170
1179
  #
@@ -1248,7 +1257,7 @@ module Aws::APIGateway
1248
1257
  # Deletes the ApiKey resource.
1249
1258
  #
1250
1259
  # @option params [required, String] :api_key
1251
- # The identifier of the ApiKey resource to be deleted.
1260
+ # \[Required\] The identifier of the ApiKey resource to be deleted.
1252
1261
  #
1253
1262
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1254
1263
  #
@@ -1276,10 +1285,10 @@ module Aws::APIGateway
1276
1285
  # [1]: http://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html
1277
1286
  #
1278
1287
  # @option params [required, String] :rest_api_id
1279
- # The string identifier of the associated RestApi.
1288
+ # \[Required\] The string identifier of the associated RestApi.
1280
1289
  #
1281
1290
  # @option params [required, String] :authorizer_id
1282
- # The identifier of the Authorizer resource.
1291
+ # \[Required\] The identifier of the Authorizer resource.
1283
1292
  #
1284
1293
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1285
1294
  #
@@ -1300,10 +1309,12 @@ module Aws::APIGateway
1300
1309
  # Deletes the BasePathMapping resource.
1301
1310
  #
1302
1311
  # @option params [required, String] :domain_name
1303
- # The domain name of the BasePathMapping resource to delete.
1312
+ # \[Required\] The domain name of the BasePathMapping resource to
1313
+ # delete.
1304
1314
  #
1305
1315
  # @option params [required, String] :base_path
1306
- # The base path name of the BasePathMapping resource to delete.
1316
+ # \[Required\] The base path name of the BasePathMapping resource to
1317
+ # delete.
1307
1318
  #
1308
1319
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1309
1320
  #
@@ -1324,7 +1335,8 @@ module Aws::APIGateway
1324
1335
  # Deletes the ClientCertificate resource.
1325
1336
  #
1326
1337
  # @option params [required, String] :client_certificate_id
1327
- # The identifier of the ClientCertificate resource to be deleted.
1338
+ # \[Required\] The identifier of the ClientCertificate resource to be
1339
+ # deleted.
1328
1340
  #
1329
1341
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1330
1342
  #
@@ -1345,10 +1357,10 @@ module Aws::APIGateway
1345
1357
  # if there are no Stage resources associated with it.
1346
1358
  #
1347
1359
  # @option params [required, String] :rest_api_id
1348
- # The string identifier of the associated RestApi.
1360
+ # \[Required\] The string identifier of the associated RestApi.
1349
1361
  #
1350
1362
  # @option params [required, String] :deployment_id
1351
- # The identifier of the Deployment resource to delete.
1363
+ # \[Required\] The identifier of the Deployment resource to delete.
1352
1364
  #
1353
1365
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1354
1366
  #
@@ -1414,7 +1426,7 @@ module Aws::APIGateway
1414
1426
  # Deletes the DomainName resource.
1415
1427
  #
1416
1428
  # @option params [required, String] :domain_name
1417
- # The name of the DomainName resource to be deleted.
1429
+ # \[Required\] The name of the DomainName resource to be deleted.
1418
1430
  #
1419
1431
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1420
1432
  #
@@ -1435,10 +1447,11 @@ module Aws::APIGateway
1435
1447
  # type on the given RestApi and resets it with the default settings.
1436
1448
  #
1437
1449
  # @option params [required, String] :rest_api_id
1438
- # The string identifier of the associated RestApi.
1450
+ # \[Required\] The string identifier of the associated RestApi.
1439
1451
  #
1440
1452
  # @option params [required, String] :response_type
1441
- # The response type of the associated GatewayResponse. Valid values are
1453
+ # \[Required\] The response type of the associated GatewayResponse.
1454
+ # Valid values are
1442
1455
  # * ACCESS\_DENIED
1443
1456
  # * API\_CONFIGURATION\_ERROR
1444
1457
  # * AUTHORIZER\_FAILURE
@@ -1458,7 +1471,7 @@ module Aws::APIGateway
1458
1471
  # * RESOURCE\_NOT\_FOUND
1459
1472
  # * THROTTLED
1460
1473
  # * UNAUTHORIZED
1461
- # * UNSUPPORTED\_MEDIA\_TYPES
1474
+ # * UNSUPPORTED\_MEDIA\_TYPE
1462
1475
  #
1463
1476
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1464
1477
  #
@@ -1479,13 +1492,14 @@ module Aws::APIGateway
1479
1492
  # Represents a delete integration.
1480
1493
  #
1481
1494
  # @option params [required, String] :rest_api_id
1482
- # The string identifier of the associated RestApi.
1495
+ # \[Required\] The string identifier of the associated RestApi.
1483
1496
  #
1484
1497
  # @option params [required, String] :resource_id
1485
- # Specifies a delete integration request's resource identifier.
1498
+ # \[Required\] Specifies a delete integration request's resource
1499
+ # identifier.
1486
1500
  #
1487
1501
  # @option params [required, String] :http_method
1488
- # Specifies a delete integration request's HTTP method.
1502
+ # \[Required\] Specifies a delete integration request's HTTP method.
1489
1503
  #
1490
1504
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1491
1505
  #
@@ -1507,17 +1521,19 @@ module Aws::APIGateway
1507
1521
  # Represents a delete integration response.
1508
1522
  #
1509
1523
  # @option params [required, String] :rest_api_id
1510
- # The string identifier of the associated RestApi.
1524
+ # \[Required\] The string identifier of the associated RestApi.
1511
1525
  #
1512
1526
  # @option params [required, String] :resource_id
1513
- # Specifies a delete integration response request's resource
1514
- # identifier.
1527
+ # \[Required\] Specifies a delete integration response request's
1528
+ # resource identifier.
1515
1529
  #
1516
1530
  # @option params [required, String] :http_method
1517
- # Specifies a delete integration response request's HTTP method.
1531
+ # \[Required\] Specifies a delete integration response request's HTTP
1532
+ # method.
1518
1533
  #
1519
1534
  # @option params [required, String] :status_code
1520
- # Specifies a delete integration response request's status code.
1535
+ # \[Required\] Specifies a delete integration response request's status
1536
+ # code.
1521
1537
  #
1522
1538
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1523
1539
  #
@@ -1540,13 +1556,13 @@ module Aws::APIGateway
1540
1556
  # Deletes an existing Method resource.
1541
1557
  #
1542
1558
  # @option params [required, String] :rest_api_id
1543
- # The string identifier of the associated RestApi.
1559
+ # \[Required\] The string identifier of the associated RestApi.
1544
1560
  #
1545
1561
  # @option params [required, String] :resource_id
1546
- # The Resource identifier for the Method resource.
1562
+ # \[Required\] The Resource identifier for the Method resource.
1547
1563
  #
1548
1564
  # @option params [required, String] :http_method
1549
- # The HTTP verb of the Method resource.
1565
+ # \[Required\] The HTTP verb of the Method resource.
1550
1566
  #
1551
1567
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1552
1568
  #
@@ -1568,16 +1584,17 @@ module Aws::APIGateway
1568
1584
  # Deletes an existing MethodResponse resource.
1569
1585
  #
1570
1586
  # @option params [required, String] :rest_api_id
1571
- # The string identifier of the associated RestApi.
1587
+ # \[Required\] The string identifier of the associated RestApi.
1572
1588
  #
1573
1589
  # @option params [required, String] :resource_id
1574
- # The Resource identifier for the MethodResponse resource.
1590
+ # \[Required\] The Resource identifier for the MethodResponse resource.
1575
1591
  #
1576
1592
  # @option params [required, String] :http_method
1577
- # The HTTP verb of the Method resource.
1593
+ # \[Required\] The HTTP verb of the Method resource.
1578
1594
  #
1579
1595
  # @option params [required, String] :status_code
1580
- # The status code identifier for the MethodResponse resource.
1596
+ # \[Required\] The status code identifier for the MethodResponse
1597
+ # resource.
1581
1598
  #
1582
1599
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1583
1600
  #
@@ -1600,10 +1617,10 @@ module Aws::APIGateway
1600
1617
  # Deletes a model.
1601
1618
  #
1602
1619
  # @option params [required, String] :rest_api_id
1603
- # The string identifier of the associated RestApi.
1620
+ # \[Required\] The string identifier of the associated RestApi.
1604
1621
  #
1605
1622
  # @option params [required, String] :model_name
1606
- # The name of the model to delete.
1623
+ # \[Required\] The name of the model to delete.
1607
1624
  #
1608
1625
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1609
1626
  #
@@ -1624,7 +1641,7 @@ module Aws::APIGateway
1624
1641
  # Deletes a RequestValidator of a given RestApi.
1625
1642
  #
1626
1643
  # @option params [required, String] :rest_api_id
1627
- # The string identifier of the associated RestApi.
1644
+ # \[Required\] The string identifier of the associated RestApi.
1628
1645
  #
1629
1646
  # @option params [required, String] :request_validator_id
1630
1647
  # \[Required\] The identifier of the RequestValidator to be deleted.
@@ -1648,10 +1665,10 @@ module Aws::APIGateway
1648
1665
  # Deletes a Resource resource.
1649
1666
  #
1650
1667
  # @option params [required, String] :rest_api_id
1651
- # The string identifier of the associated RestApi.
1668
+ # \[Required\] The string identifier of the associated RestApi.
1652
1669
  #
1653
1670
  # @option params [required, String] :resource_id
1654
- # The identifier of the Resource resource.
1671
+ # \[Required\] The identifier of the Resource resource.
1655
1672
  #
1656
1673
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1657
1674
  #
@@ -1672,7 +1689,7 @@ module Aws::APIGateway
1672
1689
  # Deletes the specified API.
1673
1690
  #
1674
1691
  # @option params [required, String] :rest_api_id
1675
- # The string identifier of the associated RestApi.
1692
+ # \[Required\] The string identifier of the associated RestApi.
1676
1693
  #
1677
1694
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1678
1695
  #
@@ -1692,10 +1709,10 @@ module Aws::APIGateway
1692
1709
  # Deletes a Stage resource.
1693
1710
  #
1694
1711
  # @option params [required, String] :rest_api_id
1695
- # The string identifier of the associated RestApi.
1712
+ # \[Required\] The string identifier of the associated RestApi.
1696
1713
  #
1697
1714
  # @option params [required, String] :stage_name
1698
- # The name of the Stage resource to delete.
1715
+ # \[Required\] The name of the Stage resource to delete.
1699
1716
  #
1700
1717
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1701
1718
  #
@@ -1716,7 +1733,7 @@ module Aws::APIGateway
1716
1733
  # Deletes a usage plan of a given plan Id.
1717
1734
  #
1718
1735
  # @option params [required, String] :usage_plan_id
1719
- # The Id of the to-be-deleted usage plan.
1736
+ # \[Required\] The Id of the to-be-deleted usage plan.
1720
1737
  #
1721
1738
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1722
1739
  #
@@ -1737,12 +1754,12 @@ module Aws::APIGateway
1737
1754
  # associated usage plan.
1738
1755
  #
1739
1756
  # @option params [required, String] :usage_plan_id
1740
- # The Id of the UsagePlan resource representing the usage plan
1741
- # containing the to-be-deleted UsagePlanKey resource representing a plan
1742
- # customer.
1757
+ # \[Required\] The Id of the UsagePlan resource representing the usage
1758
+ # plan containing the to-be-deleted UsagePlanKey resource representing a
1759
+ # plan customer.
1743
1760
  #
1744
1761
  # @option params [required, String] :key_id
1745
- # The Id of the UsagePlanKey resource to be deleted.
1762
+ # \[Required\] The Id of the UsagePlanKey resource to be deleted.
1746
1763
  #
1747
1764
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1748
1765
  #
@@ -1808,10 +1825,10 @@ module Aws::APIGateway
1808
1825
  # Flushes a stage's cache.
1809
1826
  #
1810
1827
  # @option params [required, String] :rest_api_id
1811
- # The string identifier of the associated RestApi.
1828
+ # \[Required\] The string identifier of the associated RestApi.
1812
1829
  #
1813
1830
  # @option params [required, String] :stage_name
1814
- # The name of the stage to flush its cache.
1831
+ # \[Required\] The name of the stage to flush its cache.
1815
1832
  #
1816
1833
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1817
1834
  #
@@ -1891,7 +1908,7 @@ module Aws::APIGateway
1891
1908
  # Gets information about the current ApiKey resource.
1892
1909
  #
1893
1910
  # @option params [required, String] :api_key
1894
- # The identifier of the ApiKey resource.
1911
+ # \[Required\] The identifier of the ApiKey resource.
1895
1912
  #
1896
1913
  # @option params [Boolean] :include_value
1897
1914
  # A boolean flag to specify whether (`true`) or not (`false`) the result
@@ -1942,7 +1959,8 @@ module Aws::APIGateway
1942
1959
  # The current pagination position in the paged result set.
1943
1960
  #
1944
1961
  # @option params [Integer] :limit
1945
- # The maximum number of returned results per page.
1962
+ # The maximum number of returned results per page. The default value is
1963
+ # 25 and the maximum value is 500.
1946
1964
  #
1947
1965
  # @option params [String] :name_query
1948
1966
  # The name of queried API keys.
@@ -2006,10 +2024,10 @@ module Aws::APIGateway
2006
2024
  # [1]: http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html
2007
2025
  #
2008
2026
  # @option params [required, String] :rest_api_id
2009
- # The string identifier of the associated RestApi.
2027
+ # \[Required\] The string identifier of the associated RestApi.
2010
2028
  #
2011
2029
  # @option params [required, String] :authorizer_id
2012
- # The identifier of the Authorizer resource.
2030
+ # \[Required\] The identifier of the Authorizer resource.
2013
2031
  #
2014
2032
  # @return [Types::Authorizer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2015
2033
  #
@@ -2063,13 +2081,14 @@ module Aws::APIGateway
2063
2081
  # [1]: http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html
2064
2082
  #
2065
2083
  # @option params [required, String] :rest_api_id
2066
- # The string identifier of the associated RestApi.
2084
+ # \[Required\] The string identifier of the associated RestApi.
2067
2085
  #
2068
2086
  # @option params [String] :position
2069
2087
  # The current pagination position in the paged result set.
2070
2088
  #
2071
2089
  # @option params [Integer] :limit
2072
- # The maximum number of returned results per page.
2090
+ # The maximum number of returned results per page. The default value is
2091
+ # 25 and the maximum value is 500.
2073
2092
  #
2074
2093
  # @return [Types::Authorizers] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2075
2094
  #
@@ -2110,13 +2129,15 @@ module Aws::APIGateway
2110
2129
  # Describe a BasePathMapping resource.
2111
2130
  #
2112
2131
  # @option params [required, String] :domain_name
2113
- # The domain name of the BasePathMapping resource to be described.
2132
+ # \[Required\] The domain name of the BasePathMapping resource to be
2133
+ # described.
2114
2134
  #
2115
2135
  # @option params [required, String] :base_path
2116
- # The base path name that callers of the API must provide as part of the
2117
- # URL after the domain name. This value must be unique for all of the
2118
- # mappings across a single API. Leave this blank if you do not want
2119
- # callers to specify any base path name after the domain name.
2136
+ # \[Required\] The base path name that callers of the API must provide
2137
+ # as part of the URL after the domain name. This value must be unique
2138
+ # for all of the mappings across a single API. Leave this blank if you
2139
+ # do not want callers to specify any base path name after the domain
2140
+ # name.
2120
2141
  #
2121
2142
  # @return [Types::BasePathMapping] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2122
2143
  #
@@ -2147,14 +2168,14 @@ module Aws::APIGateway
2147
2168
  # Represents a collection of BasePathMapping resources.
2148
2169
  #
2149
2170
  # @option params [required, String] :domain_name
2150
- # The domain name of a BasePathMapping resource.
2171
+ # \[Required\] The domain name of a BasePathMapping resource.
2151
2172
  #
2152
2173
  # @option params [String] :position
2153
2174
  # The current pagination position in the paged result set.
2154
2175
  #
2155
2176
  # @option params [Integer] :limit
2156
- # The maximum number of returned results per page. The value is 25 by
2157
- # default and could be between 1 - 500.
2177
+ # The maximum number of returned results per page. The default value is
2178
+ # 25 and the maximum value is 500.
2158
2179
  #
2159
2180
  # @return [Types::BasePathMappings] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2160
2181
  #
@@ -2187,7 +2208,8 @@ module Aws::APIGateway
2187
2208
  # Gets information about the current ClientCertificate resource.
2188
2209
  #
2189
2210
  # @option params [required, String] :client_certificate_id
2190
- # The identifier of the ClientCertificate resource to be described.
2211
+ # \[Required\] The identifier of the ClientCertificate resource to be
2212
+ # described.
2191
2213
  #
2192
2214
  # @return [Types::ClientCertificate] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2193
2215
  #
@@ -2224,8 +2246,8 @@ module Aws::APIGateway
2224
2246
  # The current pagination position in the paged result set.
2225
2247
  #
2226
2248
  # @option params [Integer] :limit
2227
- # The maximum number of returned results per page. The value is 25 by
2228
- # default and could be between 1 - 500.
2249
+ # The maximum number of returned results per page. The default value is
2250
+ # 25 and the maximum value is 500.
2229
2251
  #
2230
2252
  # @return [Types::ClientCertificates] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2231
2253
  #
@@ -2259,10 +2281,11 @@ module Aws::APIGateway
2259
2281
  # Gets information about a Deployment resource.
2260
2282
  #
2261
2283
  # @option params [required, String] :rest_api_id
2262
- # The string identifier of the associated RestApi.
2284
+ # \[Required\] The string identifier of the associated RestApi.
2263
2285
  #
2264
2286
  # @option params [required, String] :deployment_id
2265
- # The identifier of the Deployment resource to get information about.
2287
+ # \[Required\] The identifier of the Deployment resource to get
2288
+ # information about.
2266
2289
  #
2267
2290
  # @option params [Array<String>] :embed
2268
2291
  # A query parameter to retrieve the specified embedded resources of the
@@ -2312,14 +2335,14 @@ module Aws::APIGateway
2312
2335
  # Gets information about a Deployments collection.
2313
2336
  #
2314
2337
  # @option params [required, String] :rest_api_id
2315
- # The string identifier of the associated RestApi.
2338
+ # \[Required\] The string identifier of the associated RestApi.
2316
2339
  #
2317
2340
  # @option params [String] :position
2318
2341
  # The current pagination position in the paged result set.
2319
2342
  #
2320
2343
  # @option params [Integer] :limit
2321
- # The maximum number of returned results per page. The value is 25 by
2322
- # default and could be between 1 - 500.
2344
+ # The maximum number of returned results per page. The default value is
2345
+ # 25 and the maximum value is 500.
2323
2346
  #
2324
2347
  # @return [Types::Deployments] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2325
2348
  #
@@ -2405,7 +2428,8 @@ module Aws::APIGateway
2405
2428
  # The current pagination position in the paged result set.
2406
2429
  #
2407
2430
  # @option params [Integer] :limit
2408
- # The maximum number of returned results per page.
2431
+ # The maximum number of returned results per page. The default value is
2432
+ # 25 and the maximum value is 500.
2409
2433
  #
2410
2434
  # @option params [String] :location_status
2411
2435
  # The status of the API documentation parts to retrieve. Valid values
@@ -2489,7 +2513,8 @@ module Aws::APIGateway
2489
2513
  # The current pagination position in the paged result set.
2490
2514
  #
2491
2515
  # @option params [Integer] :limit
2492
- # The maximum number of returned results per page.
2516
+ # The maximum number of returned results per page. The default value is
2517
+ # 25 and the maximum value is 500.
2493
2518
  #
2494
2519
  # @return [Types::DocumentationVersions] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2495
2520
  #
@@ -2523,7 +2548,7 @@ module Aws::APIGateway
2523
2548
  # intuitive URL that can be called.
2524
2549
  #
2525
2550
  # @option params [required, String] :domain_name
2526
- # The name of the DomainName resource.
2551
+ # \[Required\] The name of the DomainName resource.
2527
2552
  #
2528
2553
  # @return [Types::DomainName] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2529
2554
  #
@@ -2573,8 +2598,8 @@ module Aws::APIGateway
2573
2598
  # The current pagination position in the paged result set.
2574
2599
  #
2575
2600
  # @option params [Integer] :limit
2576
- # The maximum number of returned results per page. The value is 25 by
2577
- # default and could be between 1 - 500.
2601
+ # The maximum number of returned results per page. The default value is
2602
+ # 25 and the maximum value is 500.
2578
2603
  #
2579
2604
  # @return [Types::DomainNames] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2580
2605
  #
@@ -2615,13 +2640,14 @@ module Aws::APIGateway
2615
2640
  # Exports a deployed version of a RestApi in a specified format.
2616
2641
  #
2617
2642
  # @option params [required, String] :rest_api_id
2618
- # The string identifier of the associated RestApi.
2643
+ # \[Required\] The string identifier of the associated RestApi.
2619
2644
  #
2620
2645
  # @option params [required, String] :stage_name
2621
- # The name of the Stage that will be exported.
2646
+ # \[Required\] The name of the Stage that will be exported.
2622
2647
  #
2623
2648
  # @option params [required, String] :export_type
2624
- # The type of export. Currently only 'swagger' is supported.
2649
+ # \[Required\] The type of export. Currently only 'swagger' is
2650
+ # supported.
2625
2651
  #
2626
2652
  # @option params [Hash<String,String>] :parameters
2627
2653
  # A key-value map of query string parameters that specify properties of
@@ -2674,10 +2700,11 @@ module Aws::APIGateway
2674
2700
  # RestApi.
2675
2701
  #
2676
2702
  # @option params [required, String] :rest_api_id
2677
- # The string identifier of the associated RestApi.
2703
+ # \[Required\] The string identifier of the associated RestApi.
2678
2704
  #
2679
2705
  # @option params [required, String] :response_type
2680
- # The response type of the associated GatewayResponse. Valid values are
2706
+ # \[Required\] The response type of the associated GatewayResponse.
2707
+ # Valid values are
2681
2708
  # * ACCESS\_DENIED
2682
2709
  # * API\_CONFIGURATION\_ERROR
2683
2710
  # * AUTHORIZER\_FAILURE
@@ -2697,7 +2724,7 @@ module Aws::APIGateway
2697
2724
  # * RESOURCE\_NOT\_FOUND
2698
2725
  # * THROTTLED
2699
2726
  # * UNAUTHORIZED
2700
- # * UNSUPPORTED\_MEDIA\_TYPES
2727
+ # * UNSUPPORTED\_MEDIA\_TYPE
2701
2728
  #
2702
2729
  # @return [Types::GatewayResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2703
2730
  #
@@ -2737,7 +2764,7 @@ module Aws::APIGateway
2737
2764
  # collection for the supported response types.
2738
2765
  #
2739
2766
  # @option params [required, String] :rest_api_id
2740
- # The string identifier of the associated RestApi.
2767
+ # \[Required\] The string identifier of the associated RestApi.
2741
2768
  #
2742
2769
  # @option params [String] :position
2743
2770
  # The current pagination position in the paged result set. The
@@ -2745,9 +2772,9 @@ module Aws::APIGateway
2745
2772
  # position does not apply here.
2746
2773
  #
2747
2774
  # @option params [Integer] :limit
2748
- # The maximum number of returned results per page. The GatewayResponses
2749
- # collection does not support pagination and the limit does not apply
2750
- # here.
2775
+ # The maximum number of returned results per page. The default value is
2776
+ # 25 and the maximum value is 500. The GatewayResponses collection does
2777
+ # not support pagination and the limit does not apply here.
2751
2778
  #
2752
2779
  # @return [Types::GatewayResponses] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2753
2780
  #
@@ -2784,13 +2811,14 @@ module Aws::APIGateway
2784
2811
  # Get the integration settings.
2785
2812
  #
2786
2813
  # @option params [required, String] :rest_api_id
2787
- # The string identifier of the associated RestApi.
2814
+ # \[Required\] The string identifier of the associated RestApi.
2788
2815
  #
2789
2816
  # @option params [required, String] :resource_id
2790
- # Specifies a get integration request's resource identifier
2817
+ # \[Required\] Specifies a get integration request's resource
2818
+ # identifier
2791
2819
  #
2792
2820
  # @option params [required, String] :http_method
2793
- # Specifies a get integration request's HTTP method.
2821
+ # \[Required\] Specifies a get integration request's HTTP method.
2794
2822
  #
2795
2823
  # @return [Types::Integration] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2796
2824
  #
@@ -2854,16 +2882,19 @@ module Aws::APIGateway
2854
2882
  # Represents a get integration response.
2855
2883
  #
2856
2884
  # @option params [required, String] :rest_api_id
2857
- # The string identifier of the associated RestApi.
2885
+ # \[Required\] The string identifier of the associated RestApi.
2858
2886
  #
2859
2887
  # @option params [required, String] :resource_id
2860
- # Specifies a get integration response request's resource identifier.
2888
+ # \[Required\] Specifies a get integration response request's resource
2889
+ # identifier.
2861
2890
  #
2862
2891
  # @option params [required, String] :http_method
2863
- # Specifies a get integration response request's HTTP method.
2892
+ # \[Required\] Specifies a get integration response request's HTTP
2893
+ # method.
2864
2894
  #
2865
2895
  # @option params [required, String] :status_code
2866
- # Specifies a get integration response request's status code.
2896
+ # \[Required\] Specifies a get integration response request's status
2897
+ # code.
2867
2898
  #
2868
2899
  # @return [Types::IntegrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2869
2900
  #
@@ -2902,13 +2933,13 @@ module Aws::APIGateway
2902
2933
  # Describe an existing Method resource.
2903
2934
  #
2904
2935
  # @option params [required, String] :rest_api_id
2905
- # The string identifier of the associated RestApi.
2936
+ # \[Required\] The string identifier of the associated RestApi.
2906
2937
  #
2907
2938
  # @option params [required, String] :resource_id
2908
- # The Resource identifier for the Method resource.
2939
+ # \[Required\] The Resource identifier for the Method resource.
2909
2940
  #
2910
2941
  # @option params [required, String] :http_method
2911
- # Specifies the method request's HTTP method type.
2942
+ # \[Required\] Specifies the method request's HTTP method type.
2912
2943
  #
2913
2944
  # @return [Types::Method] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2914
2945
  #
@@ -2987,16 +3018,16 @@ module Aws::APIGateway
2987
3018
  # Describes a MethodResponse resource.
2988
3019
  #
2989
3020
  # @option params [required, String] :rest_api_id
2990
- # The string identifier of the associated RestApi.
3021
+ # \[Required\] The string identifier of the associated RestApi.
2991
3022
  #
2992
3023
  # @option params [required, String] :resource_id
2993
- # The Resource identifier for the MethodResponse resource.
3024
+ # \[Required\] The Resource identifier for the MethodResponse resource.
2994
3025
  #
2995
3026
  # @option params [required, String] :http_method
2996
- # The HTTP verb of the Method resource.
3027
+ # \[Required\] The HTTP verb of the Method resource.
2997
3028
  #
2998
3029
  # @option params [required, String] :status_code
2999
- # The status code for the MethodResponse resource.
3030
+ # \[Required\] The status code for the MethodResponse resource.
3000
3031
  #
3001
3032
  # @return [Types::MethodResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3002
3033
  #
@@ -3031,10 +3062,10 @@ module Aws::APIGateway
3031
3062
  # Describes an existing model defined for a RestApi resource.
3032
3063
  #
3033
3064
  # @option params [required, String] :rest_api_id
3034
- # The RestApi identifier under which the Model exists.
3065
+ # \[Required\] The RestApi identifier under which the Model exists.
3035
3066
  #
3036
3067
  # @option params [required, String] :model_name
3037
- # The name of the model as an identifier.
3068
+ # \[Required\] The name of the model as an identifier.
3038
3069
  #
3039
3070
  # @option params [Boolean] :flatten
3040
3071
  # A query parameter of a Boolean value to resolve (`true`) all external
@@ -3076,10 +3107,10 @@ module Aws::APIGateway
3076
3107
  # payload into the structure of a model.
3077
3108
  #
3078
3109
  # @option params [required, String] :rest_api_id
3079
- # The string identifier of the associated RestApi.
3110
+ # \[Required\] The string identifier of the associated RestApi.
3080
3111
  #
3081
3112
  # @option params [required, String] :model_name
3082
- # The name of the model for which to generate a template.
3113
+ # \[Required\] The name of the model for which to generate a template.
3083
3114
  #
3084
3115
  # @return [Types::Template] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3085
3116
  #
@@ -3106,14 +3137,14 @@ module Aws::APIGateway
3106
3137
  # Describes existing Models defined for a RestApi resource.
3107
3138
  #
3108
3139
  # @option params [required, String] :rest_api_id
3109
- # The string identifier of the associated RestApi.
3140
+ # \[Required\] The string identifier of the associated RestApi.
3110
3141
  #
3111
3142
  # @option params [String] :position
3112
3143
  # The current pagination position in the paged result set.
3113
3144
  #
3114
3145
  # @option params [Integer] :limit
3115
- # The maximum number of returned results per page. The value is 25 by
3116
- # default and could be between 1 - 500.
3146
+ # The maximum number of returned results per page. The default value is
3147
+ # 25 and the maximum value is 500.
3117
3148
  #
3118
3149
  # @return [Types::Models] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3119
3150
  #
@@ -3148,7 +3179,7 @@ module Aws::APIGateway
3148
3179
  # Gets a RequestValidator of a given RestApi.
3149
3180
  #
3150
3181
  # @option params [required, String] :rest_api_id
3151
- # The string identifier of the associated RestApi.
3182
+ # \[Required\] The string identifier of the associated RestApi.
3152
3183
  #
3153
3184
  # @option params [required, String] :request_validator_id
3154
3185
  # \[Required\] The identifier of the RequestValidator to be retrieved.
@@ -3184,13 +3215,14 @@ module Aws::APIGateway
3184
3215
  # Gets the RequestValidators collection of a given RestApi.
3185
3216
  #
3186
3217
  # @option params [required, String] :rest_api_id
3187
- # The string identifier of the associated RestApi.
3218
+ # \[Required\] The string identifier of the associated RestApi.
3188
3219
  #
3189
3220
  # @option params [String] :position
3190
3221
  # The current pagination position in the paged result set.
3191
3222
  #
3192
3223
  # @option params [Integer] :limit
3193
- # The maximum number of returned results per page.
3224
+ # The maximum number of returned results per page. The default value is
3225
+ # 25 and the maximum value is 500.
3194
3226
  #
3195
3227
  # @return [Types::RequestValidators] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3196
3228
  #
@@ -3224,10 +3256,10 @@ module Aws::APIGateway
3224
3256
  # Lists information about a resource.
3225
3257
  #
3226
3258
  # @option params [required, String] :rest_api_id
3227
- # The string identifier of the associated RestApi.
3259
+ # \[Required\] The string identifier of the associated RestApi.
3228
3260
  #
3229
3261
  # @option params [required, String] :resource_id
3230
- # The identifier for the Resource resource.
3262
+ # \[Required\] The identifier for the Resource resource.
3231
3263
  #
3232
3264
  # @option params [Array<String>] :embed
3233
3265
  # A query parameter to retrieve the specified resources embedded in the
@@ -3314,14 +3346,14 @@ module Aws::APIGateway
3314
3346
  # Lists information about a collection of Resource resources.
3315
3347
  #
3316
3348
  # @option params [required, String] :rest_api_id
3317
- # The string identifier of the associated RestApi.
3349
+ # \[Required\] The string identifier of the associated RestApi.
3318
3350
  #
3319
3351
  # @option params [String] :position
3320
3352
  # The current pagination position in the paged result set.
3321
3353
  #
3322
3354
  # @option params [Integer] :limit
3323
- # The maximum number of returned results per page. The value is 25 by
3324
- # default and could be between 1 - 500.
3355
+ # The maximum number of returned results per page. The default value is
3356
+ # 25 and the maximum value is 500.
3325
3357
  #
3326
3358
  # @option params [Array<String>] :embed
3327
3359
  # A query parameter used to retrieve the specified resources embedded in
@@ -3408,7 +3440,7 @@ module Aws::APIGateway
3408
3440
  # Lists the RestApi resource in the collection.
3409
3441
  #
3410
3442
  # @option params [required, String] :rest_api_id
3411
- # The identifier of the RestApi resource.
3443
+ # \[Required\] The string identifier of the associated RestApi.
3412
3444
  #
3413
3445
  # @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3414
3446
  #
@@ -3422,6 +3454,7 @@ module Aws::APIGateway
3422
3454
  # * {Types::RestApi#minimum_compression_size #minimum_compression_size} => Integer
3423
3455
  # * {Types::RestApi#api_key_source #api_key_source} => String
3424
3456
  # * {Types::RestApi#endpoint_configuration #endpoint_configuration} => Types::EndpointConfiguration
3457
+ # * {Types::RestApi#policy #policy} => String
3425
3458
  #
3426
3459
  # @example Request syntax with placeholder values
3427
3460
  #
@@ -3444,6 +3477,7 @@ module Aws::APIGateway
3444
3477
  # resp.api_key_source #=> String, one of "HEADER", "AUTHORIZER"
3445
3478
  # resp.endpoint_configuration.types #=> Array
3446
3479
  # resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE"
3480
+ # resp.policy #=> String
3447
3481
  #
3448
3482
  # @overload get_rest_api(params = {})
3449
3483
  # @param [Hash] params ({})
@@ -3458,8 +3492,8 @@ module Aws::APIGateway
3458
3492
  # The current pagination position in the paged result set.
3459
3493
  #
3460
3494
  # @option params [Integer] :limit
3461
- # The maximum number of returned results per page. The value is 25 by
3462
- # default and could be between 1 - 500.
3495
+ # The maximum number of returned results per page. The default value is
3496
+ # 25 and the maximum value is 500.
3463
3497
  #
3464
3498
  # @return [Types::RestApis] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3465
3499
  #
@@ -3490,6 +3524,7 @@ module Aws::APIGateway
3490
3524
  # resp.items[0].api_key_source #=> String, one of "HEADER", "AUTHORIZER"
3491
3525
  # resp.items[0].endpoint_configuration.types #=> Array
3492
3526
  # resp.items[0].endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE"
3527
+ # resp.items[0].policy #=> String
3493
3528
  #
3494
3529
  # @overload get_rest_apis(params = {})
3495
3530
  # @param [Hash] params ({})
@@ -3501,15 +3536,15 @@ module Aws::APIGateway
3501
3536
  # Generates a client SDK for a RestApi and Stage.
3502
3537
  #
3503
3538
  # @option params [required, String] :rest_api_id
3504
- # The string identifier of the associated RestApi.
3539
+ # \[Required\] The string identifier of the associated RestApi.
3505
3540
  #
3506
3541
  # @option params [required, String] :stage_name
3507
- # The name of the Stage that the SDK will use.
3542
+ # \[Required\] The name of the Stage that the SDK will use.
3508
3543
  #
3509
3544
  # @option params [required, String] :sdk_type
3510
- # The language for the generated SDK. Currently `java`, `javascript`,
3511
- # `android`, `objectivec` (for iOS), `swift` (for iOS), and `ruby` are
3512
- # supported.
3545
+ # \[Required\] The language for the generated SDK. Currently `java`,
3546
+ # `javascript`, `android`, `objectivec` (for iOS), `swift` (for iOS),
3547
+ # and `ruby` are supported.
3513
3548
  #
3514
3549
  # @option params [Hash<String,String>] :parameters
3515
3550
  # A string-to-string key-value map of query parameters
@@ -3551,7 +3586,7 @@ module Aws::APIGateway
3551
3586
  end
3552
3587
 
3553
3588
  # @option params [required, String] :id
3554
- # The identifier of the queried SdkType instance.
3589
+ # \[Required\] The identifier of the queried SdkType instance.
3555
3590
  #
3556
3591
  # @return [Types::SdkType] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3557
3592
  #
@@ -3589,7 +3624,8 @@ module Aws::APIGateway
3589
3624
  # The current pagination position in the paged result set.
3590
3625
  #
3591
3626
  # @option params [Integer] :limit
3592
- # The maximum number of returned results per page.
3627
+ # The maximum number of returned results per page. The default value is
3628
+ # 25 and the maximum value is 500.
3593
3629
  #
3594
3630
  # @return [Types::SdkTypes] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3595
3631
  #
@@ -3627,10 +3663,10 @@ module Aws::APIGateway
3627
3663
  # Gets information about a Stage resource.
3628
3664
  #
3629
3665
  # @option params [required, String] :rest_api_id
3630
- # The string identifier of the associated RestApi.
3666
+ # \[Required\] The string identifier of the associated RestApi.
3631
3667
  #
3632
3668
  # @option params [required, String] :stage_name
3633
- # The name of the Stage resource to get information about.
3669
+ # \[Required\] The name of the Stage resource to get information about.
3634
3670
  #
3635
3671
  # @return [Types::Stage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3636
3672
  #
@@ -3702,7 +3738,7 @@ module Aws::APIGateway
3702
3738
  # Gets information about one or more Stage resources.
3703
3739
  #
3704
3740
  # @option params [required, String] :rest_api_id
3705
- # The string identifier of the associated RestApi.
3741
+ # \[Required\] The string identifier of the associated RestApi.
3706
3742
  #
3707
3743
  # @option params [String] :deployment_id
3708
3744
  # The stages' deployment identifiers.
@@ -3764,8 +3800,9 @@ module Aws::APIGateway
3764
3800
  # Gets the Tags collection for a given resource.
3765
3801
  #
3766
3802
  # @option params [required, String] :resource_arn
3767
- # \[Required\] The ARN of a resource that can be tagged. At present,
3768
- # Stage is the only taggable resource.
3803
+ # \[Required\] The ARN of a resource that can be tagged. The resource
3804
+ # ARN must be URL-encoded. At present, Stage is the only taggable
3805
+ # resource.
3769
3806
  #
3770
3807
  # @option params [String] :position
3771
3808
  # (Not currently supported) The current pagination position in the paged
@@ -3773,7 +3810,7 @@ module Aws::APIGateway
3773
3810
  #
3774
3811
  # @option params [Integer] :limit
3775
3812
  # (Not currently supported) The maximum number of returned results per
3776
- # page.
3813
+ # page. The default value is 25 and the maximum value is 500.
3777
3814
  #
3778
3815
  # @return [Types::Tags] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3779
3816
  #
@@ -3802,22 +3839,23 @@ module Aws::APIGateway
3802
3839
  # Gets the usage data of a usage plan in a specified time interval.
3803
3840
  #
3804
3841
  # @option params [required, String] :usage_plan_id
3805
- # The Id of the usage plan associated with the usage data.
3842
+ # \[Required\] The Id of the usage plan associated with the usage data.
3806
3843
  #
3807
3844
  # @option params [String] :key_id
3808
3845
  # The Id of the API key associated with the resultant usage data.
3809
3846
  #
3810
3847
  # @option params [required, String] :start_date
3811
- # The starting date (e.g., 2016-01-01) of the usage data.
3848
+ # \[Required\] The starting date (e.g., 2016-01-01) of the usage data.
3812
3849
  #
3813
3850
  # @option params [required, String] :end_date
3814
- # The ending date (e.g., 2016-12-31) of the usage data.
3851
+ # \[Required\] The ending date (e.g., 2016-12-31) of the usage data.
3815
3852
  #
3816
3853
  # @option params [String] :position
3817
3854
  # The current pagination position in the paged result set.
3818
3855
  #
3819
3856
  # @option params [Integer] :limit
3820
- # The maximum number of returned results per page.
3857
+ # The maximum number of returned results per page. The default value is
3858
+ # 25 and the maximum value is 500.
3821
3859
  #
3822
3860
  # @return [Types::Usage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3823
3861
  #
@@ -3859,7 +3897,7 @@ module Aws::APIGateway
3859
3897
  # Gets a usage plan of a given plan identifier.
3860
3898
  #
3861
3899
  # @option params [required, String] :usage_plan_id
3862
- # The identifier of the UsagePlan resource to be retrieved.
3900
+ # \[Required\] The identifier of the UsagePlan resource to be retrieved.
3863
3901
  #
3864
3902
  # @return [Types::UsagePlan] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3865
3903
  #
@@ -3902,13 +3940,13 @@ module Aws::APIGateway
3902
3940
  # Gets a usage plan key of a given key identifier.
3903
3941
  #
3904
3942
  # @option params [required, String] :usage_plan_id
3905
- # The Id of the UsagePlan resource representing the usage plan
3906
- # containing the to-be-retrieved UsagePlanKey resource representing a
3907
- # plan customer.
3943
+ # \[Required\] The Id of the UsagePlan resource representing the usage
3944
+ # plan containing the to-be-retrieved UsagePlanKey resource representing
3945
+ # a plan customer.
3908
3946
  #
3909
3947
  # @option params [required, String] :key_id
3910
- # The key Id of the to-be-retrieved UsagePlanKey resource representing a
3911
- # plan customer.
3948
+ # \[Required\] The key Id of the to-be-retrieved UsagePlanKey resource
3949
+ # representing a plan customer.
3912
3950
  #
3913
3951
  # @return [Types::UsagePlanKey] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3914
3952
  #
@@ -3942,15 +3980,16 @@ module Aws::APIGateway
3942
3980
  # specified usage plan.
3943
3981
  #
3944
3982
  # @option params [required, String] :usage_plan_id
3945
- # The Id of the UsagePlan resource representing the usage plan
3946
- # containing the to-be-retrieved UsagePlanKey resource representing a
3947
- # plan customer.
3983
+ # \[Required\] The Id of the UsagePlan resource representing the usage
3984
+ # plan containing the to-be-retrieved UsagePlanKey resource representing
3985
+ # a plan customer.
3948
3986
  #
3949
3987
  # @option params [String] :position
3950
3988
  # The current pagination position in the paged result set.
3951
3989
  #
3952
3990
  # @option params [Integer] :limit
3953
- # The maximum number of returned results per page.
3991
+ # The maximum number of returned results per page. The default value is
3992
+ # 25 and the maximum value is 500.
3954
3993
  #
3955
3994
  # @option params [String] :name_query
3956
3995
  # A query parameter specifying the name of the to-be-returned usage plan
@@ -3995,7 +4034,8 @@ module Aws::APIGateway
3995
4034
  # The identifier of the API key associated with the usage plans.
3996
4035
  #
3997
4036
  # @option params [Integer] :limit
3998
- # The maximum number of returned results per page.
4037
+ # The maximum number of returned results per page. The default value is
4038
+ # 25 and the maximum value is 500.
3999
4039
  #
4000
4040
  # @return [Types::UsagePlans] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4001
4041
  #
@@ -4079,7 +4119,8 @@ module Aws::APIGateway
4079
4119
  # The current pagination position in the paged result set.
4080
4120
  #
4081
4121
  # @option params [Integer] :limit
4082
- # The maximum number of returned results per page.
4122
+ # The maximum number of returned results per page. The default value is
4123
+ # 25 and the maximum value is 500.
4083
4124
  #
4084
4125
  # @return [Types::VpcLinks] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4085
4126
  #
@@ -4238,9 +4279,9 @@ module Aws::APIGateway
4238
4279
  # aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json
4239
4280
  #
4240
4281
  # @option params [required, String, IO] :body
4241
- # The POST request body containing external API definitions. Currently,
4242
- # only Swagger definition JSON files are supported. The maximum size of
4243
- # the API definition file is 2MB.
4282
+ # \[Required\] The POST request body containing external API
4283
+ # definitions. Currently, only Swagger definition JSON files are
4284
+ # supported. The maximum size of the API definition file is 2MB.
4244
4285
  #
4245
4286
  # @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4246
4287
  #
@@ -4254,6 +4295,7 @@ module Aws::APIGateway
4254
4295
  # * {Types::RestApi#minimum_compression_size #minimum_compression_size} => Integer
4255
4296
  # * {Types::RestApi#api_key_source #api_key_source} => String
4256
4297
  # * {Types::RestApi#endpoint_configuration #endpoint_configuration} => Types::EndpointConfiguration
4298
+ # * {Types::RestApi#policy #policy} => String
4257
4299
  #
4258
4300
  # @example Request syntax with placeholder values
4259
4301
  #
@@ -4280,6 +4322,7 @@ module Aws::APIGateway
4280
4322
  # resp.api_key_source #=> String, one of "HEADER", "AUTHORIZER"
4281
4323
  # resp.endpoint_configuration.types #=> Array
4282
4324
  # resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE"
4325
+ # resp.policy #=> String
4283
4326
  #
4284
4327
  # @overload import_rest_api(params = {})
4285
4328
  # @param [Hash] params ({})
@@ -4292,10 +4335,11 @@ module Aws::APIGateway
4292
4335
  # type and status code on the given RestApi.
4293
4336
  #
4294
4337
  # @option params [required, String] :rest_api_id
4295
- # The string identifier of the associated RestApi.
4338
+ # \[Required\] The string identifier of the associated RestApi.
4296
4339
  #
4297
4340
  # @option params [required, String] :response_type
4298
- # The response type of the associated GatewayResponse. Valid values are
4341
+ # \[Required\] The response type of the associated GatewayResponse.
4342
+ # Valid values are
4299
4343
  # * ACCESS\_DENIED
4300
4344
  # * API\_CONFIGURATION\_ERROR
4301
4345
  # * AUTHORIZER\_FAILURE
@@ -4315,7 +4359,7 @@ module Aws::APIGateway
4315
4359
  # * RESOURCE\_NOT\_FOUND
4316
4360
  # * THROTTLED
4317
4361
  # * UNAUTHORIZED
4318
- # * UNSUPPORTED\_MEDIA\_TYPES
4362
+ # * UNSUPPORTED\_MEDIA\_TYPE
4319
4363
  #
4320
4364
  # @option params [String] :status_code
4321
4365
  # The HTTP status code of the GatewayResponse.
@@ -4370,16 +4414,16 @@ module Aws::APIGateway
4370
4414
  # Sets up a method's integration.
4371
4415
  #
4372
4416
  # @option params [required, String] :rest_api_id
4373
- # The string identifier of the associated RestApi.
4417
+ # \[Required\] The string identifier of the associated RestApi.
4374
4418
  #
4375
4419
  # @option params [required, String] :resource_id
4376
- # Specifies a put integration request's resource ID.
4420
+ # \[Required\] Specifies a put integration request's resource ID.
4377
4421
  #
4378
4422
  # @option params [required, String] :http_method
4379
- # Specifies a put integration request's HTTP method.
4423
+ # \[Required\] Specifies a put integration request's HTTP method.
4380
4424
  #
4381
4425
  # @option params [required, String] :type
4382
- # Specifies a put integration input's type.
4426
+ # \[Required\] Specifies a put integration input's type.
4383
4427
  #
4384
4428
  # @option params [String] :integration_http_method
4385
4429
  # Specifies a put integration HTTP method. When the integration type is
@@ -4574,17 +4618,19 @@ module Aws::APIGateway
4574
4618
  # Represents a put integration.
4575
4619
  #
4576
4620
  # @option params [required, String] :rest_api_id
4577
- # The string identifier of the associated RestApi.
4621
+ # \[Required\] The string identifier of the associated RestApi.
4578
4622
  #
4579
4623
  # @option params [required, String] :resource_id
4580
- # Specifies a put integration response request's resource identifier.
4624
+ # \[Required\] Specifies a put integration response request's resource
4625
+ # identifier.
4581
4626
  #
4582
4627
  # @option params [required, String] :http_method
4583
- # Specifies a put integration response request's HTTP method.
4628
+ # \[Required\] Specifies a put integration response request's HTTP
4629
+ # method.
4584
4630
  #
4585
4631
  # @option params [required, String] :status_code
4586
- # Specifies the status code that is used to map the integration response
4587
- # to an existing MethodResponse.
4632
+ # \[Required\] Specifies the status code that is used to map the
4633
+ # integration response to an existing MethodResponse.
4588
4634
  #
4589
4635
  # @option params [String] :selection_pattern
4590
4636
  # Specifies the selection pattern of a put integration response.
@@ -4665,23 +4711,24 @@ module Aws::APIGateway
4665
4711
  # Add a method to an existing Resource resource.
4666
4712
  #
4667
4713
  # @option params [required, String] :rest_api_id
4668
- # The string identifier of the associated RestApi.
4714
+ # \[Required\] The string identifier of the associated RestApi.
4669
4715
  #
4670
4716
  # @option params [required, String] :resource_id
4671
- # The Resource identifier for the new Method resource.
4717
+ # \[Required\] The Resource identifier for the new Method resource.
4672
4718
  #
4673
4719
  # @option params [required, String] :http_method
4674
- # Specifies the method request's HTTP method type.
4720
+ # \[Required\] Specifies the method request's HTTP method type.
4675
4721
  #
4676
4722
  # @option params [required, String] :authorization_type
4677
- # The method's authorization type. Valid values are `NONE` for open
4678
- # access, `AWS_IAM` for using AWS IAM permissions, `CUSTOM` for using a
4679
- # custom authorizer, or `COGNITO_USER_POOLS` for using a Cognito user
4680
- # pool.
4723
+ # \[Required\] The method's authorization type. Valid values are `NONE`
4724
+ # for open access, `AWS_IAM` for using AWS IAM permissions, `CUSTOM` for
4725
+ # using a custom authorizer, or `COGNITO_USER_POOLS` for using a Cognito
4726
+ # user pool.
4681
4727
  #
4682
4728
  # @option params [String] :authorizer_id
4683
4729
  # Specifies the identifier of an Authorizer to use on this Method, if
4684
- # the type is CUSTOM.
4730
+ # the type is CUSTOM or COGNITO\_USER\_POOLS. The authorizer identifier
4731
+ # is generated by API Gateway when you created the authorizer.
4685
4732
  #
4686
4733
  # @option params [Boolean] :api_key_required
4687
4734
  # Specifies whether the method required a valid ApiKey.
@@ -4718,9 +4765,9 @@ module Aws::APIGateway
4718
4765
  #
4719
4766
  # @option params [Array<String>] :authorization_scopes
4720
4767
  # A list of authorization scopes configured on the method. The scopes
4721
- # are used with a `COGNITO_USER_POOL` authorizer to authorize the method
4722
- # invocation. The authorization works by matching the method scopes
4723
- # against the scopes parsed from the access token in the incoming
4768
+ # are used with a `COGNITO_USER_POOLS` authorizer to authorize the
4769
+ # method invocation. The authorization works by matching the method
4770
+ # scopes against the scopes parsed from the access token in the incoming
4724
4771
  # request. The method invocation is authorized if any method scopes
4725
4772
  # matches a claimed scope in the access token. Otherwise, the invocation
4726
4773
  # is not authorized. When the method scope is configured, the client
@@ -4816,16 +4863,16 @@ module Aws::APIGateway
4816
4863
  # Adds a MethodResponse to an existing Method resource.
4817
4864
  #
4818
4865
  # @option params [required, String] :rest_api_id
4819
- # The string identifier of the associated RestApi.
4866
+ # \[Required\] The string identifier of the associated RestApi.
4820
4867
  #
4821
4868
  # @option params [required, String] :resource_id
4822
- # The Resource identifier for the Method resource.
4869
+ # \[Required\] The Resource identifier for the Method resource.
4823
4870
  #
4824
4871
  # @option params [required, String] :http_method
4825
- # The HTTP verb of the Method resource.
4872
+ # \[Required\] The HTTP verb of the Method resource.
4826
4873
  #
4827
4874
  # @option params [required, String] :status_code
4828
- # The method response's status code.
4875
+ # \[Required\] The method response's status code.
4829
4876
  #
4830
4877
  # @option params [Hash<String,Boolean>] :response_parameters
4831
4878
  # A key-value map specifying required or optional response parameters
@@ -4890,7 +4937,7 @@ module Aws::APIGateway
4890
4937
  # overwriting the existing API.
4891
4938
  #
4892
4939
  # @option params [required, String] :rest_api_id
4893
- # The string identifier of the associated RestApi.
4940
+ # \[Required\] The string identifier of the associated RestApi.
4894
4941
  #
4895
4942
  # @option params [String] :mode
4896
4943
  # The `mode` query parameter to specify the update mode. Valid values
@@ -4910,9 +4957,9 @@ module Aws::APIGateway
4910
4957
  # ignore=documentation --body 'file:///path/to/imported-api-body.json`.
4911
4958
  #
4912
4959
  # @option params [required, String, IO] :body
4913
- # The PUT request body containing external API definitions. Currently,
4914
- # only Swagger definition JSON files are supported. The maximum size of
4915
- # the API definition file is 2MB.
4960
+ # \[Required\] The PUT request body containing external API definitions.
4961
+ # Currently, only Swagger definition JSON files are supported. The
4962
+ # maximum size of the API definition file is 2MB.
4916
4963
  #
4917
4964
  # @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4918
4965
  #
@@ -4926,6 +4973,7 @@ module Aws::APIGateway
4926
4973
  # * {Types::RestApi#minimum_compression_size #minimum_compression_size} => Integer
4927
4974
  # * {Types::RestApi#api_key_source #api_key_source} => String
4928
4975
  # * {Types::RestApi#endpoint_configuration #endpoint_configuration} => Types::EndpointConfiguration
4976
+ # * {Types::RestApi#policy #policy} => String
4929
4977
  #
4930
4978
  # @example Request syntax with placeholder values
4931
4979
  #
@@ -4954,6 +5002,7 @@ module Aws::APIGateway
4954
5002
  # resp.api_key_source #=> String, one of "HEADER", "AUTHORIZER"
4955
5003
  # resp.endpoint_configuration.types #=> Array
4956
5004
  # resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE"
5005
+ # resp.policy #=> String
4957
5006
  #
4958
5007
  # @overload put_rest_api(params = {})
4959
5008
  # @param [Hash] params ({})
@@ -4962,16 +5011,17 @@ module Aws::APIGateway
4962
5011
  req.send_request(options)
4963
5012
  end
4964
5013
 
4965
- # Adds or updates Tags on a gievn resource.
5014
+ # Adds or updates a tag on a given resource.
4966
5015
  #
4967
5016
  # @option params [required, String] :resource_arn
4968
- # \[Required\] The ARN of a resource that can be tagged. At present,
4969
- # Stage is the only taggable resource.
5017
+ # \[Required\] The ARN of a resource that can be tagged. The resource
5018
+ # ARN must be URL-encoded. At present, Stage is the only taggable
5019
+ # resource.
4970
5020
  #
4971
5021
  # @option params [required, Hash<String,String>] :tags
4972
- # \[Required\] Key/Value map of strings. Valid character set is
4973
- # \[a-zA-Z+-=.\_:/\]. Tag key can be up to 128 characters and must not
4974
- # start with "aws:". Tag value can be up to 256 characters.
5022
+ # \[Required\] The key-value map of strings. The valid character set is
5023
+ # \[a-zA-Z+-=.\_:/\]. The tag key can be up to 128 characters and must
5024
+ # not start with `aws:`. The tag value can be up to 256 characters.
4975
5025
  #
4976
5026
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4977
5027
  #
@@ -5003,10 +5053,11 @@ module Aws::APIGateway
5003
5053
  # [1]: http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html
5004
5054
  #
5005
5055
  # @option params [required, String] :rest_api_id
5006
- # The string identifier of the associated RestApi.
5056
+ # \[Required\] The string identifier of the associated RestApi.
5007
5057
  #
5008
5058
  # @option params [required, String] :authorizer_id
5009
- # Specifies a test invoke authorizer request's Authorizer ID.
5059
+ # \[Required\] Specifies a test invoke authorizer request's Authorizer
5060
+ # ID.
5010
5061
  #
5011
5062
  # @option params [Hash<String,String>] :headers
5012
5063
  # \[Required\] A key-value map of headers to simulate an incoming
@@ -5081,13 +5132,13 @@ module Aws::APIGateway
5081
5132
  # parameters, and an incoming request body.
5082
5133
  #
5083
5134
  # @option params [required, String] :rest_api_id
5084
- # The string identifier of the associated RestApi.
5135
+ # \[Required\] The string identifier of the associated RestApi.
5085
5136
  #
5086
5137
  # @option params [required, String] :resource_id
5087
- # Specifies a test invoke method request's resource ID.
5138
+ # \[Required\] Specifies a test invoke method request's resource ID.
5088
5139
  #
5089
5140
  # @option params [required, String] :http_method
5090
- # Specifies a test invoke method request's HTTP method.
5141
+ # \[Required\] Specifies a test invoke method request's HTTP method.
5091
5142
  #
5092
5143
  # @option params [String] :path_with_query_string
5093
5144
  # The URI path, including query string, of the simulated invocation
@@ -5150,14 +5201,15 @@ module Aws::APIGateway
5150
5201
  req.send_request(options)
5151
5202
  end
5152
5203
 
5153
- # Removes Tags from a given resource.
5204
+ # Removes a tag from a given resource.
5154
5205
  #
5155
5206
  # @option params [required, String] :resource_arn
5156
- # \[Required\] The ARN of a resource that can be tagged. At present,
5157
- # Stage is the only taggable resource.
5207
+ # \[Required\] The ARN of a resource that can be tagged. The resource
5208
+ # ARN must be URL-encoded. At present, Stage is the only taggable
5209
+ # resource.
5158
5210
  #
5159
5211
  # @option params [required, Array<String>] :tag_keys
5160
- # The Tag keys to delete.
5212
+ # \[Required\] The Tag keys to delete.
5161
5213
  #
5162
5214
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5163
5215
  #
@@ -5220,7 +5272,7 @@ module Aws::APIGateway
5220
5272
  # Changes information about an ApiKey resource.
5221
5273
  #
5222
5274
  # @option params [required, String] :api_key
5223
- # The identifier of the ApiKey resource to be updated.
5275
+ # \[Required\] The identifier of the ApiKey resource to be updated.
5224
5276
  #
5225
5277
  # @option params [Array<Types::PatchOperation>] :patch_operations
5226
5278
  # A list of update operations to be applied to the specified resource
@@ -5283,10 +5335,10 @@ module Aws::APIGateway
5283
5335
  # [1]: http://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html
5284
5336
  #
5285
5337
  # @option params [required, String] :rest_api_id
5286
- # The string identifier of the associated RestApi.
5338
+ # \[Required\] The string identifier of the associated RestApi.
5287
5339
  #
5288
5340
  # @option params [required, String] :authorizer_id
5289
- # The identifier of the Authorizer resource.
5341
+ # \[Required\] The identifier of the Authorizer resource.
5290
5342
  #
5291
5343
  # @option params [Array<Types::PatchOperation>] :patch_operations
5292
5344
  # A list of update operations to be applied to the specified resource
@@ -5344,10 +5396,11 @@ module Aws::APIGateway
5344
5396
  # Changes information about the BasePathMapping resource.
5345
5397
  #
5346
5398
  # @option params [required, String] :domain_name
5347
- # The domain name of the BasePathMapping resource to change.
5399
+ # \[Required\] The domain name of the BasePathMapping resource to
5400
+ # change.
5348
5401
  #
5349
5402
  # @option params [required, String] :base_path
5350
- # The base path of the BasePathMapping resource to change.
5403
+ # \[Required\] The base path of the BasePathMapping resource to change.
5351
5404
  #
5352
5405
  # @option params [Array<Types::PatchOperation>] :patch_operations
5353
5406
  # A list of update operations to be applied to the specified resource
@@ -5390,7 +5443,8 @@ module Aws::APIGateway
5390
5443
  # Changes information about an ClientCertificate resource.
5391
5444
  #
5392
5445
  # @option params [required, String] :client_certificate_id
5393
- # The identifier of the ClientCertificate resource to be updated.
5446
+ # \[Required\] The identifier of the ClientCertificate resource to be
5447
+ # updated.
5394
5448
  #
5395
5449
  # @option params [Array<Types::PatchOperation>] :patch_operations
5396
5450
  # A list of update operations to be applied to the specified resource
@@ -5436,7 +5490,7 @@ module Aws::APIGateway
5436
5490
  # Changes information about a Deployment resource.
5437
5491
  #
5438
5492
  # @option params [required, String] :rest_api_id
5439
- # The string identifier of the associated RestApi.
5493
+ # \[Required\] The string identifier of the associated RestApi.
5440
5494
  #
5441
5495
  # @option params [required, String] :deployment_id
5442
5496
  # The replacement identifier for the Deployment resource to change
@@ -5581,7 +5635,7 @@ module Aws::APIGateway
5581
5635
  # Changes information about the DomainName resource.
5582
5636
  #
5583
5637
  # @option params [required, String] :domain_name
5584
- # The name of the DomainName resource to be changed.
5638
+ # \[Required\] The name of the DomainName resource to be changed.
5585
5639
  #
5586
5640
  # @option params [Array<Types::PatchOperation>] :patch_operations
5587
5641
  # A list of update operations to be applied to the specified resource
@@ -5641,10 +5695,11 @@ module Aws::APIGateway
5641
5695
  # RestApi.
5642
5696
  #
5643
5697
  # @option params [required, String] :rest_api_id
5644
- # The string identifier of the associated RestApi.
5698
+ # \[Required\] The string identifier of the associated RestApi.
5645
5699
  #
5646
5700
  # @option params [required, String] :response_type
5647
- # The response type of the associated GatewayResponse. Valid values are
5701
+ # \[Required\] The response type of the associated GatewayResponse.
5702
+ # Valid values are
5648
5703
  # * ACCESS\_DENIED
5649
5704
  # * API\_CONFIGURATION\_ERROR
5650
5705
  # * AUTHORIZER\_FAILURE
@@ -5664,7 +5719,7 @@ module Aws::APIGateway
5664
5719
  # * RESOURCE\_NOT\_FOUND
5665
5720
  # * THROTTLED
5666
5721
  # * UNAUTHORIZED
5667
- # * UNSUPPORTED\_MEDIA\_TYPES
5722
+ # * UNSUPPORTED\_MEDIA\_TYPE
5668
5723
  #
5669
5724
  # @option params [Array<Types::PatchOperation>] :patch_operations
5670
5725
  # A list of update operations to be applied to the specified resource
@@ -5713,13 +5768,14 @@ module Aws::APIGateway
5713
5768
  # Represents an update integration.
5714
5769
  #
5715
5770
  # @option params [required, String] :rest_api_id
5716
- # The string identifier of the associated RestApi.
5771
+ # \[Required\] The string identifier of the associated RestApi.
5717
5772
  #
5718
5773
  # @option params [required, String] :resource_id
5719
- # Represents an update integration request's resource identifier.
5774
+ # \[Required\] Represents an update integration request's resource
5775
+ # identifier.
5720
5776
  #
5721
5777
  # @option params [required, String] :http_method
5722
- # Represents an update integration request's HTTP method.
5778
+ # \[Required\] Represents an update integration request's HTTP method.
5723
5779
  #
5724
5780
  # @option params [Array<Types::PatchOperation>] :patch_operations
5725
5781
  # A list of update operations to be applied to the specified resource
@@ -5795,17 +5851,19 @@ module Aws::APIGateway
5795
5851
  # Represents an update integration response.
5796
5852
  #
5797
5853
  # @option params [required, String] :rest_api_id
5798
- # The string identifier of the associated RestApi.
5854
+ # \[Required\] The string identifier of the associated RestApi.
5799
5855
  #
5800
5856
  # @option params [required, String] :resource_id
5801
- # Specifies an update integration response request's resource
5802
- # identifier.
5857
+ # \[Required\] Specifies an update integration response request's
5858
+ # resource identifier.
5803
5859
  #
5804
5860
  # @option params [required, String] :http_method
5805
- # Specifies an update integration response request's HTTP method.
5861
+ # \[Required\] Specifies an update integration response request's HTTP
5862
+ # method.
5806
5863
  #
5807
5864
  # @option params [required, String] :status_code
5808
- # Specifies an update integration response request's status code.
5865
+ # \[Required\] Specifies an update integration response request's
5866
+ # status code.
5809
5867
  #
5810
5868
  # @option params [Array<Types::PatchOperation>] :patch_operations
5811
5869
  # A list of update operations to be applied to the specified resource
@@ -5856,13 +5914,13 @@ module Aws::APIGateway
5856
5914
  # Updates an existing Method resource.
5857
5915
  #
5858
5916
  # @option params [required, String] :rest_api_id
5859
- # The string identifier of the associated RestApi.
5917
+ # \[Required\] The string identifier of the associated RestApi.
5860
5918
  #
5861
5919
  # @option params [required, String] :resource_id
5862
- # The Resource identifier for the Method resource.
5920
+ # \[Required\] The Resource identifier for the Method resource.
5863
5921
  #
5864
5922
  # @option params [required, String] :http_method
5865
- # The HTTP verb of the Method resource.
5923
+ # \[Required\] The HTTP verb of the Method resource.
5866
5924
  #
5867
5925
  # @option params [Array<Types::PatchOperation>] :patch_operations
5868
5926
  # A list of update operations to be applied to the specified resource
@@ -5953,16 +6011,16 @@ module Aws::APIGateway
5953
6011
  # Updates an existing MethodResponse resource.
5954
6012
  #
5955
6013
  # @option params [required, String] :rest_api_id
5956
- # The string identifier of the associated RestApi.
6014
+ # \[Required\] The string identifier of the associated RestApi.
5957
6015
  #
5958
6016
  # @option params [required, String] :resource_id
5959
- # The Resource identifier for the MethodResponse resource.
6017
+ # \[Required\] The Resource identifier for the MethodResponse resource.
5960
6018
  #
5961
6019
  # @option params [required, String] :http_method
5962
- # The HTTP verb of the Method resource.
6020
+ # \[Required\] The HTTP verb of the Method resource.
5963
6021
  #
5964
6022
  # @option params [required, String] :status_code
5965
- # The status code for the MethodResponse resource.
6023
+ # \[Required\] The status code for the MethodResponse resource.
5966
6024
  #
5967
6025
  # @option params [Array<Types::PatchOperation>] :patch_operations
5968
6026
  # A list of update operations to be applied to the specified resource
@@ -6009,10 +6067,10 @@ module Aws::APIGateway
6009
6067
  # Changes information about a model.
6010
6068
  #
6011
6069
  # @option params [required, String] :rest_api_id
6012
- # The string identifier of the associated RestApi.
6070
+ # \[Required\] The string identifier of the associated RestApi.
6013
6071
  #
6014
6072
  # @option params [required, String] :model_name
6015
- # The name of the model to update.
6073
+ # \[Required\] The name of the model to update.
6016
6074
  #
6017
6075
  # @option params [Array<Types::PatchOperation>] :patch_operations
6018
6076
  # A list of update operations to be applied to the specified resource
@@ -6059,7 +6117,7 @@ module Aws::APIGateway
6059
6117
  # Updates a RequestValidator of a given RestApi.
6060
6118
  #
6061
6119
  # @option params [required, String] :rest_api_id
6062
- # The string identifier of the associated RestApi.
6120
+ # \[Required\] The string identifier of the associated RestApi.
6063
6121
  #
6064
6122
  # @option params [required, String] :request_validator_id
6065
6123
  # \[Required\] The identifier of RequestValidator to be updated.
@@ -6107,10 +6165,10 @@ module Aws::APIGateway
6107
6165
  # Changes information about a Resource resource.
6108
6166
  #
6109
6167
  # @option params [required, String] :rest_api_id
6110
- # The string identifier of the associated RestApi.
6168
+ # \[Required\] The string identifier of the associated RestApi.
6111
6169
  #
6112
6170
  # @option params [required, String] :resource_id
6113
- # The identifier of the Resource resource.
6171
+ # \[Required\] The identifier of the Resource resource.
6114
6172
  #
6115
6173
  # @option params [Array<Types::PatchOperation>] :patch_operations
6116
6174
  # A list of update operations to be applied to the specified resource
@@ -6199,7 +6257,7 @@ module Aws::APIGateway
6199
6257
  # Changes information about the specified API.
6200
6258
  #
6201
6259
  # @option params [required, String] :rest_api_id
6202
- # The string identifier of the associated RestApi.
6260
+ # \[Required\] The string identifier of the associated RestApi.
6203
6261
  #
6204
6262
  # @option params [Array<Types::PatchOperation>] :patch_operations
6205
6263
  # A list of update operations to be applied to the specified resource
@@ -6217,6 +6275,7 @@ module Aws::APIGateway
6217
6275
  # * {Types::RestApi#minimum_compression_size #minimum_compression_size} => Integer
6218
6276
  # * {Types::RestApi#api_key_source #api_key_source} => String
6219
6277
  # * {Types::RestApi#endpoint_configuration #endpoint_configuration} => Types::EndpointConfiguration
6278
+ # * {Types::RestApi#policy #policy} => String
6220
6279
  #
6221
6280
  # @example Request syntax with placeholder values
6222
6281
  #
@@ -6247,6 +6306,7 @@ module Aws::APIGateway
6247
6306
  # resp.api_key_source #=> String, one of "HEADER", "AUTHORIZER"
6248
6307
  # resp.endpoint_configuration.types #=> Array
6249
6308
  # resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE"
6309
+ # resp.policy #=> String
6250
6310
  #
6251
6311
  # @overload update_rest_api(params = {})
6252
6312
  # @param [Hash] params ({})
@@ -6258,10 +6318,11 @@ module Aws::APIGateway
6258
6318
  # Changes information about a Stage resource.
6259
6319
  #
6260
6320
  # @option params [required, String] :rest_api_id
6261
- # The string identifier of the associated RestApi.
6321
+ # \[Required\] The string identifier of the associated RestApi.
6262
6322
  #
6263
6323
  # @option params [required, String] :stage_name
6264
- # The name of the Stage resource to change information about.
6324
+ # \[Required\] The name of the Stage resource to change information
6325
+ # about.
6265
6326
  #
6266
6327
  # @option params [Array<Types::PatchOperation>] :patch_operations
6267
6328
  # A list of update operations to be applied to the specified resource
@@ -6346,11 +6407,11 @@ module Aws::APIGateway
6346
6407
  # associated with a specified API key.
6347
6408
  #
6348
6409
  # @option params [required, String] :usage_plan_id
6349
- # The Id of the usage plan associated with the usage data.
6410
+ # \[Required\] The Id of the usage plan associated with the usage data.
6350
6411
  #
6351
6412
  # @option params [required, String] :key_id
6352
- # The identifier of the API key associated with the usage plan in which
6353
- # a temporary extension is granted to the remaining quota.
6413
+ # \[Required\] The identifier of the API key associated with the usage
6414
+ # plan in which a temporary extension is granted to the remaining quota.
6354
6415
  #
6355
6416
  # @option params [Array<Types::PatchOperation>] :patch_operations
6356
6417
  # A list of update operations to be applied to the specified resource
@@ -6400,7 +6461,7 @@ module Aws::APIGateway
6400
6461
  # Updates a usage plan of a given plan Id.
6401
6462
  #
6402
6463
  # @option params [required, String] :usage_plan_id
6403
- # The Id of the to-be-updated usage plan.
6464
+ # \[Required\] The Id of the to-be-updated usage plan.
6404
6465
  #
6405
6466
  # @option params [Array<Types::PatchOperation>] :patch_operations
6406
6467
  # A list of update operations to be applied to the specified resource
@@ -6515,7 +6576,7 @@ module Aws::APIGateway
6515
6576
  params: params,
6516
6577
  config: config)
6517
6578
  context[:gem_name] = 'aws-sdk-apigateway'
6518
- context[:gem_version] = '1.9.0'
6579
+ context[:gem_version] = '1.10.0'
6519
6580
  Seahorse::Client::Request.new(handlers, context)
6520
6581
  end
6521
6582