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.
@@ -430,6 +430,7 @@ module Aws::APIGateway
430
430
  CreateRestApiRequest.add_member(:minimum_compression_size, Shapes::ShapeRef.new(shape: NullableInteger, location_name: "minimumCompressionSize"))
431
431
  CreateRestApiRequest.add_member(:api_key_source, Shapes::ShapeRef.new(shape: ApiKeySourceType, location_name: "apiKeySource"))
432
432
  CreateRestApiRequest.add_member(:endpoint_configuration, Shapes::ShapeRef.new(shape: EndpointConfiguration, location_name: "endpointConfiguration"))
433
+ CreateRestApiRequest.add_member(:policy, Shapes::ShapeRef.new(shape: String, location_name: "policy"))
433
434
  CreateRestApiRequest.struct_class = Types::CreateRestApiRequest
434
435
 
435
436
  CreateStageRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
@@ -1137,6 +1138,7 @@ module Aws::APIGateway
1137
1138
  RestApi.add_member(:minimum_compression_size, Shapes::ShapeRef.new(shape: NullableInteger, location_name: "minimumCompressionSize"))
1138
1139
  RestApi.add_member(:api_key_source, Shapes::ShapeRef.new(shape: ApiKeySourceType, location_name: "apiKeySource"))
1139
1140
  RestApi.add_member(:endpoint_configuration, Shapes::ShapeRef.new(shape: EndpointConfiguration, location_name: "endpointConfiguration"))
1141
+ RestApi.add_member(:policy, Shapes::ShapeRef.new(shape: String, location_name: "policy"))
1140
1142
  RestApi.struct_class = Types::RestApi
1141
1143
 
1142
1144
  RestApis.add_member(:position, Shapes::ShapeRef.new(shape: String, location_name: "position"))
@@ -256,11 +256,10 @@ module Aws::APIGateway
256
256
  # @return [String]
257
257
  #
258
258
  # @!attribute [rw] type
259
- # \[Required\] The authorizer type. Valid values are `TOKEN` for a
260
- # Lambda function using a single authorization token submitted in a
261
- # custom header, `REQUEST` for a Lambda function using incoming
262
- # request parameters, and `COGNITO_USER_POOLS` for using an Amazon
263
- # Cognito user pool.
259
+ # The authorizer type. Valid values are `TOKEN` for a Lambda function
260
+ # using a single authorization token submitted in a custom header,
261
+ # `REQUEST` for a Lambda function using incoming request parameters,
262
+ # and `COGNITO_USER_POOLS` for using an Amazon Cognito user pool.
264
263
  # @return [String]
265
264
  #
266
265
  # @!attribute [rw] provider_arns
@@ -298,11 +297,11 @@ module Aws::APIGateway
298
297
  #
299
298
  # @!attribute [rw] identity_source
300
299
  # The identity source for which authorization is requested. * For a
301
- # `TOKEN` authorizer, this is required and specifies the
302
- # request header mapping expression for the custom header holding
303
- # the authorization token submitted by the client. For example, if
304
- # the token header name is `Auth`, the header mapping expression is
305
- # `method.request.header.Auth`.
300
+ # `TOKEN` or `COGNITO_USER_POOLS` authorizer, this is required
301
+ # and specifies the request header mapping expression for the custom
302
+ # header holding the authorization token submitted by the client.
303
+ # For example, if the token header name is `Auth`, the header
304
+ # mapping expression is `method.request.header.Auth`.
306
305
  # * For the `REQUEST` authorizer, this is required when authorization
307
306
  # caching is enabled. The value is a comma-separated string of one
308
307
  # or more mapping expressions of the specified request parameters.
@@ -318,17 +317,16 @@ module Aws::APIGateway
318
317
  # function. The valid value is a string of comma-separated mapping
319
318
  # expressions of the specified request parameters. When the
320
319
  # authorization caching is not enabled, this property is optional.
321
- # * For a `COGNITO_USER_POOLS` authorizer, this property is not used.
322
320
  # @return [String]
323
321
  #
324
322
  # @!attribute [rw] identity_validation_expression
325
323
  # A validation expression for the incoming identity token. For `TOKEN`
326
324
  # authorizers, this value is a regular expression. API Gateway will
327
- # match the incoming token from the client against the specified
328
- # regular expression. It will invoke the authorizer's Lambda function
329
- # there is a match. Otherwise, it will return a 401 Unauthorized
330
- # response without calling the Lambda function. The validation
331
- # expression does not apply to the `REQUEST` authorizer.
325
+ # match the `aud` field of the incoming token from the client against
326
+ # the specified regular expression. It will invoke the authorizer's
327
+ # Lambda function when there is a match. Otherwise, it will return a
328
+ # 401 Unauthorized response without calling the Lambda function. The
329
+ # validation expression does not apply to the `REQUEST` authorizer.
332
330
  # @return [String]
333
331
  #
334
332
  # @!attribute [rw] authorizer_result_ttl_in_seconds
@@ -628,7 +626,7 @@ module Aws::APIGateway
628
626
  # }
629
627
  #
630
628
  # @!attribute [rw] rest_api_id
631
- # The string identifier of the associated RestApi.
629
+ # \[Required\] The string identifier of the associated RestApi.
632
630
  # @return [String]
633
631
  #
634
632
  # @!attribute [rw] name
@@ -678,11 +676,11 @@ module Aws::APIGateway
678
676
  #
679
677
  # @!attribute [rw] identity_source
680
678
  # The identity source for which authorization is requested. * For a
681
- # `TOKEN` authorizer, this is required and specifies the
682
- # request header mapping expression for the custom header holding
683
- # the authorization token submitted by the client. For example, if
684
- # the token header name is `Auth`, the header mapping expression is
685
- # `method.request.header.Auth`.
679
+ # `TOKEN` or `COGNITO_USER_POOLS` authorizer, this is required
680
+ # and specifies the request header mapping expression for the custom
681
+ # header holding the authorization token submitted by the client.
682
+ # For example, if the token header name is `Auth`, the header
683
+ # mapping expression is `method.request.header.Auth`.
686
684
  # * For the `REQUEST` authorizer, this is required when authorization
687
685
  # caching is enabled. The value is a comma-separated string of one
688
686
  # or more mapping expressions of the specified request parameters.
@@ -698,17 +696,16 @@ module Aws::APIGateway
698
696
  # function. The valid value is a string of comma-separated mapping
699
697
  # expressions of the specified request parameters. When the
700
698
  # authorization caching is not enabled, this property is optional.
701
- # * For a `COGNITO_USER_POOLS` authorizer, this property is not used.
702
699
  # @return [String]
703
700
  #
704
701
  # @!attribute [rw] identity_validation_expression
705
702
  # A validation expression for the incoming identity token. For `TOKEN`
706
703
  # authorizers, this value is a regular expression. API Gateway will
707
- # match the incoming token from the client against the specified
708
- # regular expression. It will invoke the authorizer's Lambda function
709
- # there is a match. Otherwise, it will return a 401 Unauthorized
710
- # response without calling the Lambda function. The validation
711
- # expression does not apply to the `REQUEST` authorizer.
704
+ # match the `aud` field of the incoming token from the client against
705
+ # the specified regular expression. It will invoke the authorizer's
706
+ # Lambda function when there is a match. Otherwise, it will return a
707
+ # 401 Unauthorized response without calling the Lambda function. The
708
+ # validation expression does not apply to the `REQUEST` authorizer.
712
709
  # @return [String]
713
710
  #
714
711
  # @!attribute [rw] authorizer_result_ttl_in_seconds
@@ -745,7 +742,8 @@ module Aws::APIGateway
745
742
  # }
746
743
  #
747
744
  # @!attribute [rw] domain_name
748
- # The domain name of the BasePathMapping resource to create.
745
+ # \[Required\] The domain name of the BasePathMapping resource to
746
+ # create.
749
747
  # @return [String]
750
748
  #
751
749
  # @!attribute [rw] base_path
@@ -756,7 +754,7 @@ module Aws::APIGateway
756
754
  # @return [String]
757
755
  #
758
756
  # @!attribute [rw] rest_api_id
759
- # The string identifier of the associated RestApi.
757
+ # \[Required\] The string identifier of the associated RestApi.
760
758
  # @return [String]
761
759
  #
762
760
  # @!attribute [rw] stage
@@ -798,7 +796,7 @@ module Aws::APIGateway
798
796
  # }
799
797
  #
800
798
  # @!attribute [rw] rest_api_id
801
- # The string identifier of the associated RestApi.
799
+ # \[Required\] The string identifier of the associated RestApi.
802
800
  # @return [String]
803
801
  #
804
802
  # @!attribute [rw] stage_name
@@ -945,7 +943,7 @@ module Aws::APIGateway
945
943
  # }
946
944
  #
947
945
  # @!attribute [rw] domain_name
948
- # (Required) The name of the DomainName resource.
946
+ # \[Required\] The name of the DomainName resource.
949
947
  # @return [String]
950
948
  #
951
949
  # @!attribute [rw] certificate_name
@@ -1024,11 +1022,12 @@ module Aws::APIGateway
1024
1022
  # }
1025
1023
  #
1026
1024
  # @!attribute [rw] rest_api_id
1027
- # The RestApi identifier under which the Model will be created.
1025
+ # \[Required\] The RestApi identifier under which the Model will be
1026
+ # created.
1028
1027
  # @return [String]
1029
1028
  #
1030
1029
  # @!attribute [rw] name
1031
- # The name of the model. Must be alphanumeric.
1030
+ # \[Required\] The name of the model. Must be alphanumeric.
1032
1031
  # @return [String]
1033
1032
  #
1034
1033
  # @!attribute [rw] description
@@ -1037,15 +1036,15 @@ module Aws::APIGateway
1037
1036
  #
1038
1037
  # @!attribute [rw] schema
1039
1038
  # The schema for the model. For `application/json` models, this should
1040
- # be [JSON-schema draft v4][1] model.
1039
+ # be [JSON schema draft 4][1] model.
1041
1040
  #
1042
1041
  #
1043
1042
  #
1044
- # [1]: http://json-schema.org/documentation.html
1043
+ # [1]: https://tools.ietf.org/html/draft-zyp-json-schema-04
1045
1044
  # @return [String]
1046
1045
  #
1047
1046
  # @!attribute [rw] content_type
1048
- # The content-type for the model.
1047
+ # \[Required\] The content-type for the model.
1049
1048
  # @return [String]
1050
1049
  #
1051
1050
  class CreateModelRequest < Struct.new(
@@ -1070,7 +1069,7 @@ module Aws::APIGateway
1070
1069
  # }
1071
1070
  #
1072
1071
  # @!attribute [rw] rest_api_id
1073
- # The string identifier of the associated RestApi.
1072
+ # \[Required\] The string identifier of the associated RestApi.
1074
1073
  # @return [String]
1075
1074
  #
1076
1075
  # @!attribute [rw] name
@@ -1108,11 +1107,11 @@ module Aws::APIGateway
1108
1107
  # }
1109
1108
  #
1110
1109
  # @!attribute [rw] rest_api_id
1111
- # The string identifier of the associated RestApi.
1110
+ # \[Required\] The string identifier of the associated RestApi.
1112
1111
  # @return [String]
1113
1112
  #
1114
1113
  # @!attribute [rw] parent_id
1115
- # The parent resource's identifier.
1114
+ # \[Required\] The parent resource's identifier.
1116
1115
  # @return [String]
1117
1116
  #
1118
1117
  # @!attribute [rw] path_part
@@ -1142,10 +1141,11 @@ module Aws::APIGateway
1142
1141
  # endpoint_configuration: {
1143
1142
  # types: ["REGIONAL"], # accepts REGIONAL, EDGE
1144
1143
  # },
1144
+ # policy: "String",
1145
1145
  # }
1146
1146
  #
1147
1147
  # @!attribute [rw] name
1148
- # The name of the RestApi.
1148
+ # \[Required\] The name of the RestApi.
1149
1149
  # @return [String]
1150
1150
  #
1151
1151
  # @!attribute [rw] description
@@ -1166,16 +1166,17 @@ module Aws::APIGateway
1166
1166
  # @return [Array<String>]
1167
1167
  #
1168
1168
  # @!attribute [rw] minimum_compression_size
1169
- # A nullable integer used to enable (non-negative between 0 and
1170
- # 10485760 (10M) bytes, inclusive) or disable (null) compression on an
1171
- # API. When compression is enabled, compression or decompression are
1172
- # not applied on the payload if the payload size is smaller than this
1173
- # value. Setting it to zero allows compression for any payload size.
1169
+ # A nullable integer that is used to enable compression (with
1170
+ # non-negative between 0 and 10485760 (10M) bytes, inclusive) or
1171
+ # disable compression (with a null value) on an API. When compression
1172
+ # is enabled, compression or decompression is not applied on the
1173
+ # payload if the payload size is smaller than this value. Setting it
1174
+ # to zero allows compression for any payload size.
1174
1175
  # @return [Integer]
1175
1176
  #
1176
1177
  # @!attribute [rw] api_key_source
1177
- # The source of the API key for metring requests according to a usage
1178
- # plan. Valid values are * `HEADER` to read the API key from the
1178
+ # The source of the API key for metering requests according to a usage
1179
+ # plan. Valid values are: * `HEADER` to read the API key from the
1179
1180
  # `X-API-Key` header of a
1180
1181
  # request.
1181
1182
  # * `AUTHORIZER` to read the API key from the `UsageIdentifierKey`
@@ -1187,6 +1188,10 @@ module Aws::APIGateway
1187
1188
  # types of the API.
1188
1189
  # @return [Types::EndpointConfiguration]
1189
1190
  #
1191
+ # @!attribute [rw] policy
1192
+ # A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
1193
+ # @return [String]
1194
+ #
1190
1195
  class CreateRestApiRequest < Struct.new(
1191
1196
  :name,
1192
1197
  :description,
@@ -1195,7 +1200,8 @@ module Aws::APIGateway
1195
1200
  :binary_media_types,
1196
1201
  :minimum_compression_size,
1197
1202
  :api_key_source,
1198
- :endpoint_configuration)
1203
+ :endpoint_configuration,
1204
+ :policy)
1199
1205
  include Aws::Structure
1200
1206
  end
1201
1207
 
@@ -1229,7 +1235,7 @@ module Aws::APIGateway
1229
1235
  # }
1230
1236
  #
1231
1237
  # @!attribute [rw] rest_api_id
1232
- # The string identifier of the associated RestApi.
1238
+ # \[Required\] The string identifier of the associated RestApi.
1233
1239
  # @return [String]
1234
1240
  #
1235
1241
  # @!attribute [rw] stage_name
@@ -1268,9 +1274,9 @@ module Aws::APIGateway
1268
1274
  # @return [Types::CanarySettings]
1269
1275
  #
1270
1276
  # @!attribute [rw] tags
1271
- # Key/Value map of strings. Valid character set is \[a-zA-Z+-=.\_:/\].
1272
- # Tag key can be up to 128 characters and must not start with
1273
- # "aws:". Tag value can be up to 256 characters.
1277
+ # The key-value map of strings. The valid character set is
1278
+ # \[a-zA-Z+-=.\_:/\]. The tag key can be up to 128 characters and must
1279
+ # not start with `aws:`. The tag value can be up to 256 characters.
1274
1280
  # @return [Hash<String,String>]
1275
1281
  #
1276
1282
  class CreateStageRequest < Struct.new(
@@ -1300,17 +1306,19 @@ module Aws::APIGateway
1300
1306
  # }
1301
1307
  #
1302
1308
  # @!attribute [rw] usage_plan_id
1303
- # The Id of the UsagePlan resource representing the usage plan
1304
- # containing the to-be-created UsagePlanKey resource representing a
1305
- # plan customer.
1309
+ # \[Required\] The Id of the UsagePlan resource representing the usage
1310
+ # plan containing the to-be-created UsagePlanKey resource representing
1311
+ # a plan customer.
1306
1312
  # @return [String]
1307
1313
  #
1308
1314
  # @!attribute [rw] key_id
1309
- # The identifier of a UsagePlanKey resource for a plan customer.
1315
+ # \[Required\] The identifier of a UsagePlanKey resource for a plan
1316
+ # customer.
1310
1317
  # @return [String]
1311
1318
  #
1312
1319
  # @!attribute [rw] key_type
1313
- # The type of a UsagePlanKey resource for a plan customer.
1320
+ # \[Required\] The type of a UsagePlanKey resource for a plan
1321
+ # customer.
1314
1322
  # @return [String]
1315
1323
  #
1316
1324
  class CreateUsagePlanKeyRequest < Struct.new(
@@ -1348,7 +1356,7 @@ module Aws::APIGateway
1348
1356
  # }
1349
1357
  #
1350
1358
  # @!attribute [rw] name
1351
- # The name of the usage plan.
1359
+ # \[Required\] The name of the usage plan.
1352
1360
  # @return [String]
1353
1361
  #
1354
1362
  # @!attribute [rw] description
@@ -1421,7 +1429,7 @@ module Aws::APIGateway
1421
1429
  # }
1422
1430
  #
1423
1431
  # @!attribute [rw] api_key
1424
- # The identifier of the ApiKey resource to be deleted.
1432
+ # \[Required\] The identifier of the ApiKey resource to be deleted.
1425
1433
  # @return [String]
1426
1434
  #
1427
1435
  class DeleteApiKeyRequest < Struct.new(
@@ -1440,11 +1448,11 @@ module Aws::APIGateway
1440
1448
  # }
1441
1449
  #
1442
1450
  # @!attribute [rw] rest_api_id
1443
- # The string identifier of the associated RestApi.
1451
+ # \[Required\] The string identifier of the associated RestApi.
1444
1452
  # @return [String]
1445
1453
  #
1446
1454
  # @!attribute [rw] authorizer_id
1447
- # The identifier of the Authorizer resource.
1455
+ # \[Required\] The identifier of the Authorizer resource.
1448
1456
  # @return [String]
1449
1457
  #
1450
1458
  class DeleteAuthorizerRequest < Struct.new(
@@ -1464,11 +1472,13 @@ module Aws::APIGateway
1464
1472
  # }
1465
1473
  #
1466
1474
  # @!attribute [rw] domain_name
1467
- # The domain name of the BasePathMapping resource to delete.
1475
+ # \[Required\] The domain name of the BasePathMapping resource to
1476
+ # delete.
1468
1477
  # @return [String]
1469
1478
  #
1470
1479
  # @!attribute [rw] base_path
1471
- # The base path name of the BasePathMapping resource to delete.
1480
+ # \[Required\] The base path name of the BasePathMapping resource to
1481
+ # delete.
1472
1482
  # @return [String]
1473
1483
  #
1474
1484
  class DeleteBasePathMappingRequest < Struct.new(
@@ -1487,7 +1497,8 @@ module Aws::APIGateway
1487
1497
  # }
1488
1498
  #
1489
1499
  # @!attribute [rw] client_certificate_id
1490
- # The identifier of the ClientCertificate resource to be deleted.
1500
+ # \[Required\] The identifier of the ClientCertificate resource to be
1501
+ # deleted.
1491
1502
  # @return [String]
1492
1503
  #
1493
1504
  class DeleteClientCertificateRequest < Struct.new(
@@ -1506,11 +1517,11 @@ module Aws::APIGateway
1506
1517
  # }
1507
1518
  #
1508
1519
  # @!attribute [rw] rest_api_id
1509
- # The string identifier of the associated RestApi.
1520
+ # \[Required\] The string identifier of the associated RestApi.
1510
1521
  # @return [String]
1511
1522
  #
1512
1523
  # @!attribute [rw] deployment_id
1513
- # The identifier of the Deployment resource to delete.
1524
+ # \[Required\] The identifier of the Deployment resource to delete.
1514
1525
  # @return [String]
1515
1526
  #
1516
1527
  class DeleteDeploymentRequest < Struct.new(
@@ -1578,7 +1589,7 @@ module Aws::APIGateway
1578
1589
  # }
1579
1590
  #
1580
1591
  # @!attribute [rw] domain_name
1581
- # The name of the DomainName resource to be deleted.
1592
+ # \[Required\] The name of the DomainName resource to be deleted.
1582
1593
  # @return [String]
1583
1594
  #
1584
1595
  class DeleteDomainNameRequest < Struct.new(
@@ -1598,11 +1609,12 @@ module Aws::APIGateway
1598
1609
  # }
1599
1610
  #
1600
1611
  # @!attribute [rw] rest_api_id
1601
- # The string identifier of the associated RestApi.
1612
+ # \[Required\] The string identifier of the associated RestApi.
1602
1613
  # @return [String]
1603
1614
  #
1604
1615
  # @!attribute [rw] response_type
1605
- # The response type of the associated GatewayResponse. Valid values
1616
+ # \[Required\] The response type of the associated GatewayResponse.
1617
+ # Valid values
1606
1618
  # are * ACCESS\_DENIED
1607
1619
  # * API\_CONFIGURATION\_ERROR
1608
1620
  # * AUTHORIZER\_FAILURE
@@ -1622,7 +1634,7 @@ module Aws::APIGateway
1622
1634
  # * RESOURCE\_NOT\_FOUND
1623
1635
  # * THROTTLED
1624
1636
  # * UNAUTHORIZED
1625
- # * UNSUPPORTED\_MEDIA\_TYPES
1637
+ # * UNSUPPORTED\_MEDIA\_TYPE
1626
1638
  # @return [String]
1627
1639
  #
1628
1640
  class DeleteGatewayResponseRequest < Struct.new(
@@ -1643,15 +1655,16 @@ module Aws::APIGateway
1643
1655
  # }
1644
1656
  #
1645
1657
  # @!attribute [rw] rest_api_id
1646
- # The string identifier of the associated RestApi.
1658
+ # \[Required\] The string identifier of the associated RestApi.
1647
1659
  # @return [String]
1648
1660
  #
1649
1661
  # @!attribute [rw] resource_id
1650
- # Specifies a delete integration request's resource identifier.
1662
+ # \[Required\] Specifies a delete integration request's resource
1663
+ # identifier.
1651
1664
  # @return [String]
1652
1665
  #
1653
1666
  # @!attribute [rw] http_method
1654
- # Specifies a delete integration request's HTTP method.
1667
+ # \[Required\] Specifies a delete integration request's HTTP method.
1655
1668
  # @return [String]
1656
1669
  #
1657
1670
  class DeleteIntegrationRequest < Struct.new(
@@ -1674,20 +1687,22 @@ module Aws::APIGateway
1674
1687
  # }
1675
1688
  #
1676
1689
  # @!attribute [rw] rest_api_id
1677
- # The string identifier of the associated RestApi.
1690
+ # \[Required\] The string identifier of the associated RestApi.
1678
1691
  # @return [String]
1679
1692
  #
1680
1693
  # @!attribute [rw] resource_id
1681
- # Specifies a delete integration response request's resource
1682
- # identifier.
1694
+ # \[Required\] Specifies a delete integration response request's
1695
+ # resource identifier.
1683
1696
  # @return [String]
1684
1697
  #
1685
1698
  # @!attribute [rw] http_method
1686
- # Specifies a delete integration response request's HTTP method.
1699
+ # \[Required\] Specifies a delete integration response request's HTTP
1700
+ # method.
1687
1701
  # @return [String]
1688
1702
  #
1689
1703
  # @!attribute [rw] status_code
1690
- # Specifies a delete integration response request's status code.
1704
+ # \[Required\] Specifies a delete integration response request's
1705
+ # status code.
1691
1706
  # @return [String]
1692
1707
  #
1693
1708
  class DeleteIntegrationResponseRequest < Struct.new(
@@ -1710,15 +1725,15 @@ module Aws::APIGateway
1710
1725
  # }
1711
1726
  #
1712
1727
  # @!attribute [rw] rest_api_id
1713
- # The string identifier of the associated RestApi.
1728
+ # \[Required\] The string identifier of the associated RestApi.
1714
1729
  # @return [String]
1715
1730
  #
1716
1731
  # @!attribute [rw] resource_id
1717
- # The Resource identifier for the Method resource.
1732
+ # \[Required\] The Resource identifier for the Method resource.
1718
1733
  # @return [String]
1719
1734
  #
1720
1735
  # @!attribute [rw] http_method
1721
- # The HTTP verb of the Method resource.
1736
+ # \[Required\] The HTTP verb of the Method resource.
1722
1737
  # @return [String]
1723
1738
  #
1724
1739
  class DeleteMethodRequest < Struct.new(
@@ -1741,19 +1756,21 @@ module Aws::APIGateway
1741
1756
  # }
1742
1757
  #
1743
1758
  # @!attribute [rw] rest_api_id
1744
- # The string identifier of the associated RestApi.
1759
+ # \[Required\] The string identifier of the associated RestApi.
1745
1760
  # @return [String]
1746
1761
  #
1747
1762
  # @!attribute [rw] resource_id
1748
- # The Resource identifier for the MethodResponse resource.
1763
+ # \[Required\] The Resource identifier for the MethodResponse
1764
+ # resource.
1749
1765
  # @return [String]
1750
1766
  #
1751
1767
  # @!attribute [rw] http_method
1752
- # The HTTP verb of the Method resource.
1768
+ # \[Required\] The HTTP verb of the Method resource.
1753
1769
  # @return [String]
1754
1770
  #
1755
1771
  # @!attribute [rw] status_code
1756
- # The status code identifier for the MethodResponse resource.
1772
+ # \[Required\] The status code identifier for the MethodResponse
1773
+ # resource.
1757
1774
  # @return [String]
1758
1775
  #
1759
1776
  class DeleteMethodResponseRequest < Struct.new(
@@ -1775,11 +1792,11 @@ module Aws::APIGateway
1775
1792
  # }
1776
1793
  #
1777
1794
  # @!attribute [rw] rest_api_id
1778
- # The string identifier of the associated RestApi.
1795
+ # \[Required\] The string identifier of the associated RestApi.
1779
1796
  # @return [String]
1780
1797
  #
1781
1798
  # @!attribute [rw] model_name
1782
- # The name of the model to delete.
1799
+ # \[Required\] The name of the model to delete.
1783
1800
  # @return [String]
1784
1801
  #
1785
1802
  class DeleteModelRequest < Struct.new(
@@ -1799,7 +1816,7 @@ module Aws::APIGateway
1799
1816
  # }
1800
1817
  #
1801
1818
  # @!attribute [rw] rest_api_id
1802
- # The string identifier of the associated RestApi.
1819
+ # \[Required\] The string identifier of the associated RestApi.
1803
1820
  # @return [String]
1804
1821
  #
1805
1822
  # @!attribute [rw] request_validator_id
@@ -1823,11 +1840,11 @@ module Aws::APIGateway
1823
1840
  # }
1824
1841
  #
1825
1842
  # @!attribute [rw] rest_api_id
1826
- # The string identifier of the associated RestApi.
1843
+ # \[Required\] The string identifier of the associated RestApi.
1827
1844
  # @return [String]
1828
1845
  #
1829
1846
  # @!attribute [rw] resource_id
1830
- # The identifier of the Resource resource.
1847
+ # \[Required\] The identifier of the Resource resource.
1831
1848
  # @return [String]
1832
1849
  #
1833
1850
  class DeleteResourceRequest < Struct.new(
@@ -1846,7 +1863,7 @@ module Aws::APIGateway
1846
1863
  # }
1847
1864
  #
1848
1865
  # @!attribute [rw] rest_api_id
1849
- # The string identifier of the associated RestApi.
1866
+ # \[Required\] The string identifier of the associated RestApi.
1850
1867
  # @return [String]
1851
1868
  #
1852
1869
  class DeleteRestApiRequest < Struct.new(
@@ -1865,11 +1882,11 @@ module Aws::APIGateway
1865
1882
  # }
1866
1883
  #
1867
1884
  # @!attribute [rw] rest_api_id
1868
- # The string identifier of the associated RestApi.
1885
+ # \[Required\] The string identifier of the associated RestApi.
1869
1886
  # @return [String]
1870
1887
  #
1871
1888
  # @!attribute [rw] stage_name
1872
- # The name of the Stage resource to delete.
1889
+ # \[Required\] The name of the Stage resource to delete.
1873
1890
  # @return [String]
1874
1891
  #
1875
1892
  class DeleteStageRequest < Struct.new(
@@ -1890,13 +1907,13 @@ module Aws::APIGateway
1890
1907
  # }
1891
1908
  #
1892
1909
  # @!attribute [rw] usage_plan_id
1893
- # The Id of the UsagePlan resource representing the usage plan
1894
- # containing the to-be-deleted UsagePlanKey resource representing a
1895
- # plan customer.
1910
+ # \[Required\] The Id of the UsagePlan resource representing the usage
1911
+ # plan containing the to-be-deleted UsagePlanKey resource representing
1912
+ # a plan customer.
1896
1913
  # @return [String]
1897
1914
  #
1898
1915
  # @!attribute [rw] key_id
1899
- # The Id of the UsagePlanKey resource to be deleted.
1916
+ # \[Required\] The Id of the UsagePlanKey resource to be deleted.
1900
1917
  # @return [String]
1901
1918
  #
1902
1919
  class DeleteUsagePlanKeyRequest < Struct.new(
@@ -1915,7 +1932,7 @@ module Aws::APIGateway
1915
1932
  # }
1916
1933
  #
1917
1934
  # @!attribute [rw] usage_plan_id
1918
- # The Id of the to-be-deleted usage plan.
1935
+ # \[Required\] The Id of the to-be-deleted usage plan.
1919
1936
  # @return [String]
1920
1937
  #
1921
1938
  class DeleteUsagePlanRequest < Struct.new(
@@ -2166,13 +2183,13 @@ module Aws::APIGateway
2166
2183
  # }
2167
2184
  #
2168
2185
  # @!attribute [rw] type
2169
- # The type of API entity to which the documentation content applies.
2170
- # It is a valid and required field for API entity types of `API`,
2171
- # `AUTHORIZER`, `MODEL`, `RESOURCE`, `METHOD`, `PATH_PARAMETER`,
2172
- # `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`,
2173
- # `RESPONSE_HEADER`, and `RESPONSE_BODY`. Content inheritance does not
2174
- # apply to any entity of the `API`, `AUTHORIZER`, `METHOD`, `MODEL`,
2175
- # `REQUEST_BODY`, or `RESOURCE` type.
2186
+ # \[Required\] The type of API entity to which the documentation
2187
+ # content applies. Valid values are `API`, `AUTHORIZER`, `MODEL`,
2188
+ # `RESOURCE`, `METHOD`, `PATH_PARAMETER`, `QUERY_PARAMETER`,
2189
+ # `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`, `RESPONSE_HEADER`, and
2190
+ # `RESPONSE_BODY`. Content inheritance does not apply to any entity of
2191
+ # the `API`, `AUTHORIZER`, `METHOD`, `MODEL`, `REQUEST_BODY`, or
2192
+ # `RESOURCE` type.
2176
2193
  # @return [String]
2177
2194
  #
2178
2195
  # @!attribute [rw] path
@@ -2340,7 +2357,8 @@ module Aws::APIGateway
2340
2357
  # [1]: http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html
2341
2358
  #
2342
2359
  # @!attribute [rw] domain_name
2343
- # The name of the DomainName resource.
2360
+ # The custom domain name as an API host name, for example,
2361
+ # `my-api.example.com`.
2344
2362
  # @return [String]
2345
2363
  #
2346
2364
  # @!attribute [rw] certificate_name
@@ -2537,11 +2555,11 @@ module Aws::APIGateway
2537
2555
  # }
2538
2556
  #
2539
2557
  # @!attribute [rw] rest_api_id
2540
- # The string identifier of the associated RestApi.
2558
+ # \[Required\] The string identifier of the associated RestApi.
2541
2559
  # @return [String]
2542
2560
  #
2543
2561
  # @!attribute [rw] stage_name
2544
- # The name of the stage to flush its cache.
2562
+ # \[Required\] The name of the stage to flush its cache.
2545
2563
  # @return [String]
2546
2564
  #
2547
2565
  class FlushStageCacheRequest < Struct.new(
@@ -2610,7 +2628,7 @@ module Aws::APIGateway
2610
2628
  # * RESOURCE\_NOT\_FOUND
2611
2629
  # * THROTTLED
2612
2630
  # * UNAUTHORIZED
2613
- # * UNSUPPORTED\_MEDIA\_TYPES
2631
+ # * UNSUPPORTED\_MEDIA\_TYPE
2614
2632
  # @return [String]
2615
2633
  #
2616
2634
  # @!attribute [rw] status_code
@@ -2732,7 +2750,7 @@ module Aws::APIGateway
2732
2750
  # }
2733
2751
  #
2734
2752
  # @!attribute [rw] api_key
2735
- # The identifier of the ApiKey resource.
2753
+ # \[Required\] The identifier of the ApiKey resource.
2736
2754
  # @return [String]
2737
2755
  #
2738
2756
  # @!attribute [rw] include_value
@@ -2764,7 +2782,8 @@ module Aws::APIGateway
2764
2782
  # @return [String]
2765
2783
  #
2766
2784
  # @!attribute [rw] limit
2767
- # The maximum number of returned results per page.
2785
+ # The maximum number of returned results per page. The default value
2786
+ # is 25 and the maximum value is 500.
2768
2787
  # @return [Integer]
2769
2788
  #
2770
2789
  # @!attribute [rw] name_query
@@ -2801,11 +2820,11 @@ module Aws::APIGateway
2801
2820
  # }
2802
2821
  #
2803
2822
  # @!attribute [rw] rest_api_id
2804
- # The string identifier of the associated RestApi.
2823
+ # \[Required\] The string identifier of the associated RestApi.
2805
2824
  # @return [String]
2806
2825
  #
2807
2826
  # @!attribute [rw] authorizer_id
2808
- # The identifier of the Authorizer resource.
2827
+ # \[Required\] The identifier of the Authorizer resource.
2809
2828
  # @return [String]
2810
2829
  #
2811
2830
  class GetAuthorizerRequest < Struct.new(
@@ -2826,7 +2845,7 @@ module Aws::APIGateway
2826
2845
  # }
2827
2846
  #
2828
2847
  # @!attribute [rw] rest_api_id
2829
- # The string identifier of the associated RestApi.
2848
+ # \[Required\] The string identifier of the associated RestApi.
2830
2849
  # @return [String]
2831
2850
  #
2832
2851
  # @!attribute [rw] position
@@ -2834,7 +2853,8 @@ module Aws::APIGateway
2834
2853
  # @return [String]
2835
2854
  #
2836
2855
  # @!attribute [rw] limit
2837
- # The maximum number of returned results per page.
2856
+ # The maximum number of returned results per page. The default value
2857
+ # is 25 and the maximum value is 500.
2838
2858
  # @return [Integer]
2839
2859
  #
2840
2860
  class GetAuthorizersRequest < Struct.new(
@@ -2855,14 +2875,16 @@ module Aws::APIGateway
2855
2875
  # }
2856
2876
  #
2857
2877
  # @!attribute [rw] domain_name
2858
- # The domain name of the BasePathMapping resource to be described.
2878
+ # \[Required\] The domain name of the BasePathMapping resource to be
2879
+ # described.
2859
2880
  # @return [String]
2860
2881
  #
2861
2882
  # @!attribute [rw] base_path
2862
- # The base path name that callers of the API must provide as part of
2863
- # the URL after the domain name. This value must be unique for all of
2864
- # the mappings across a single API. Leave this blank if you do not
2865
- # want callers to specify any base path name after the domain name.
2883
+ # \[Required\] The base path name that callers of the API must provide
2884
+ # as part of the URL after the domain name. This value must be unique
2885
+ # for all of the mappings across a single API. Leave this blank if you
2886
+ # do not want callers to specify any base path name after the domain
2887
+ # name.
2866
2888
  # @return [String]
2867
2889
  #
2868
2890
  class GetBasePathMappingRequest < Struct.new(
@@ -2884,7 +2906,7 @@ module Aws::APIGateway
2884
2906
  # }
2885
2907
  #
2886
2908
  # @!attribute [rw] domain_name
2887
- # The domain name of a BasePathMapping resource.
2909
+ # \[Required\] The domain name of a BasePathMapping resource.
2888
2910
  # @return [String]
2889
2911
  #
2890
2912
  # @!attribute [rw] position
@@ -2892,8 +2914,8 @@ module Aws::APIGateway
2892
2914
  # @return [String]
2893
2915
  #
2894
2916
  # @!attribute [rw] limit
2895
- # The maximum number of returned results per page. The value is 25 by
2896
- # default and could be between 1 - 500.
2917
+ # The maximum number of returned results per page. The default value
2918
+ # is 25 and the maximum value is 500.
2897
2919
  # @return [Integer]
2898
2920
  #
2899
2921
  class GetBasePathMappingsRequest < Struct.new(
@@ -2914,7 +2936,8 @@ module Aws::APIGateway
2914
2936
  # }
2915
2937
  #
2916
2938
  # @!attribute [rw] client_certificate_id
2917
- # The identifier of the ClientCertificate resource to be described.
2939
+ # \[Required\] The identifier of the ClientCertificate resource to be
2940
+ # described.
2918
2941
  # @return [String]
2919
2942
  #
2920
2943
  class GetClientCertificateRequest < Struct.new(
@@ -2938,8 +2961,8 @@ module Aws::APIGateway
2938
2961
  # @return [String]
2939
2962
  #
2940
2963
  # @!attribute [rw] limit
2941
- # The maximum number of returned results per page. The value is 25 by
2942
- # default and could be between 1 - 500.
2964
+ # The maximum number of returned results per page. The default value
2965
+ # is 25 and the maximum value is 500.
2943
2966
  # @return [Integer]
2944
2967
  #
2945
2968
  class GetClientCertificatesRequest < Struct.new(
@@ -2960,11 +2983,12 @@ module Aws::APIGateway
2960
2983
  # }
2961
2984
  #
2962
2985
  # @!attribute [rw] rest_api_id
2963
- # The string identifier of the associated RestApi.
2986
+ # \[Required\] The string identifier of the associated RestApi.
2964
2987
  # @return [String]
2965
2988
  #
2966
2989
  # @!attribute [rw] deployment_id
2967
- # The identifier of the Deployment resource to get information about.
2990
+ # \[Required\] The identifier of the Deployment resource to get
2991
+ # information about.
2968
2992
  # @return [String]
2969
2993
  #
2970
2994
  # @!attribute [rw] embed
@@ -3001,7 +3025,7 @@ module Aws::APIGateway
3001
3025
  # }
3002
3026
  #
3003
3027
  # @!attribute [rw] rest_api_id
3004
- # The string identifier of the associated RestApi.
3028
+ # \[Required\] The string identifier of the associated RestApi.
3005
3029
  # @return [String]
3006
3030
  #
3007
3031
  # @!attribute [rw] position
@@ -3009,8 +3033,8 @@ module Aws::APIGateway
3009
3033
  # @return [String]
3010
3034
  #
3011
3035
  # @!attribute [rw] limit
3012
- # The maximum number of returned results per page. The value is 25 by
3013
- # default and could be between 1 - 500.
3036
+ # The maximum number of returned results per page. The default value
3037
+ # is 25 and the maximum value is 500.
3014
3038
  # @return [Integer]
3015
3039
  #
3016
3040
  class GetDeploymentsRequest < Struct.new(
@@ -3081,7 +3105,8 @@ module Aws::APIGateway
3081
3105
  # @return [String]
3082
3106
  #
3083
3107
  # @!attribute [rw] limit
3084
- # The maximum number of returned results per page.
3108
+ # The maximum number of returned results per page. The default value
3109
+ # is 25 and the maximum value is 500.
3085
3110
  # @return [Integer]
3086
3111
  #
3087
3112
  # @!attribute [rw] location_status
@@ -3147,7 +3172,8 @@ module Aws::APIGateway
3147
3172
  # @return [String]
3148
3173
  #
3149
3174
  # @!attribute [rw] limit
3150
- # The maximum number of returned results per page.
3175
+ # The maximum number of returned results per page. The default value
3176
+ # is 25 and the maximum value is 500.
3151
3177
  # @return [Integer]
3152
3178
  #
3153
3179
  class GetDocumentationVersionsRequest < Struct.new(
@@ -3167,7 +3193,7 @@ module Aws::APIGateway
3167
3193
  # }
3168
3194
  #
3169
3195
  # @!attribute [rw] domain_name
3170
- # The name of the DomainName resource.
3196
+ # \[Required\] The name of the DomainName resource.
3171
3197
  # @return [String]
3172
3198
  #
3173
3199
  class GetDomainNameRequest < Struct.new(
@@ -3190,8 +3216,8 @@ module Aws::APIGateway
3190
3216
  # @return [String]
3191
3217
  #
3192
3218
  # @!attribute [rw] limit
3193
- # The maximum number of returned results per page. The value is 25 by
3194
- # default and could be between 1 - 500.
3219
+ # The maximum number of returned results per page. The default value
3220
+ # is 25 and the maximum value is 500.
3195
3221
  # @return [Integer]
3196
3222
  #
3197
3223
  class GetDomainNamesRequest < Struct.new(
@@ -3216,15 +3242,16 @@ module Aws::APIGateway
3216
3242
  # }
3217
3243
  #
3218
3244
  # @!attribute [rw] rest_api_id
3219
- # The string identifier of the associated RestApi.
3245
+ # \[Required\] The string identifier of the associated RestApi.
3220
3246
  # @return [String]
3221
3247
  #
3222
3248
  # @!attribute [rw] stage_name
3223
- # The name of the Stage that will be exported.
3249
+ # \[Required\] The name of the Stage that will be exported.
3224
3250
  # @return [String]
3225
3251
  #
3226
3252
  # @!attribute [rw] export_type
3227
- # The type of export. Currently only 'swagger' is supported.
3253
+ # \[Required\] The type of export. Currently only 'swagger' is
3254
+ # supported.
3228
3255
  # @return [String]
3229
3256
  #
3230
3257
  # @!attribute [rw] parameters
@@ -3266,11 +3293,12 @@ module Aws::APIGateway
3266
3293
  # }
3267
3294
  #
3268
3295
  # @!attribute [rw] rest_api_id
3269
- # The string identifier of the associated RestApi.
3296
+ # \[Required\] The string identifier of the associated RestApi.
3270
3297
  # @return [String]
3271
3298
  #
3272
3299
  # @!attribute [rw] response_type
3273
- # The response type of the associated GatewayResponse. Valid values
3300
+ # \[Required\] The response type of the associated GatewayResponse.
3301
+ # Valid values
3274
3302
  # are * ACCESS\_DENIED
3275
3303
  # * API\_CONFIGURATION\_ERROR
3276
3304
  # * AUTHORIZER\_FAILURE
@@ -3290,7 +3318,7 @@ module Aws::APIGateway
3290
3318
  # * RESOURCE\_NOT\_FOUND
3291
3319
  # * THROTTLED
3292
3320
  # * UNAUTHORIZED
3293
- # * UNSUPPORTED\_MEDIA\_TYPES
3321
+ # * UNSUPPORTED\_MEDIA\_TYPE
3294
3322
  # @return [String]
3295
3323
  #
3296
3324
  class GetGatewayResponseRequest < Struct.new(
@@ -3314,7 +3342,7 @@ module Aws::APIGateway
3314
3342
  # }
3315
3343
  #
3316
3344
  # @!attribute [rw] rest_api_id
3317
- # The string identifier of the associated RestApi.
3345
+ # \[Required\] The string identifier of the associated RestApi.
3318
3346
  # @return [String]
3319
3347
  #
3320
3348
  # @!attribute [rw] position
@@ -3324,9 +3352,9 @@ module Aws::APIGateway
3324
3352
  # @return [String]
3325
3353
  #
3326
3354
  # @!attribute [rw] limit
3327
- # The maximum number of returned results per page. The
3328
- # GatewayResponses collection does not support pagination and the
3329
- # limit does not apply here.
3355
+ # The maximum number of returned results per page. The default value
3356
+ # is 25 and the maximum value is 500. The GatewayResponses collection
3357
+ # does not support pagination and the limit does not apply here.
3330
3358
  # @return [Integer]
3331
3359
  #
3332
3360
  class GetGatewayResponsesRequest < Struct.new(
@@ -3348,15 +3376,16 @@ module Aws::APIGateway
3348
3376
  # }
3349
3377
  #
3350
3378
  # @!attribute [rw] rest_api_id
3351
- # The string identifier of the associated RestApi.
3379
+ # \[Required\] The string identifier of the associated RestApi.
3352
3380
  # @return [String]
3353
3381
  #
3354
3382
  # @!attribute [rw] resource_id
3355
- # Specifies a get integration request's resource identifier
3383
+ # \[Required\] Specifies a get integration request's resource
3384
+ # identifier
3356
3385
  # @return [String]
3357
3386
  #
3358
3387
  # @!attribute [rw] http_method
3359
- # Specifies a get integration request's HTTP method.
3388
+ # \[Required\] Specifies a get integration request's HTTP method.
3360
3389
  # @return [String]
3361
3390
  #
3362
3391
  class GetIntegrationRequest < Struct.new(
@@ -3379,19 +3408,22 @@ module Aws::APIGateway
3379
3408
  # }
3380
3409
  #
3381
3410
  # @!attribute [rw] rest_api_id
3382
- # The string identifier of the associated RestApi.
3411
+ # \[Required\] The string identifier of the associated RestApi.
3383
3412
  # @return [String]
3384
3413
  #
3385
3414
  # @!attribute [rw] resource_id
3386
- # Specifies a get integration response request's resource identifier.
3415
+ # \[Required\] Specifies a get integration response request's
3416
+ # resource identifier.
3387
3417
  # @return [String]
3388
3418
  #
3389
3419
  # @!attribute [rw] http_method
3390
- # Specifies a get integration response request's HTTP method.
3420
+ # \[Required\] Specifies a get integration response request's HTTP
3421
+ # method.
3391
3422
  # @return [String]
3392
3423
  #
3393
3424
  # @!attribute [rw] status_code
3394
- # Specifies a get integration response request's status code.
3425
+ # \[Required\] Specifies a get integration response request's status
3426
+ # code.
3395
3427
  # @return [String]
3396
3428
  #
3397
3429
  class GetIntegrationResponseRequest < Struct.new(
@@ -3414,15 +3446,15 @@ module Aws::APIGateway
3414
3446
  # }
3415
3447
  #
3416
3448
  # @!attribute [rw] rest_api_id
3417
- # The string identifier of the associated RestApi.
3449
+ # \[Required\] The string identifier of the associated RestApi.
3418
3450
  # @return [String]
3419
3451
  #
3420
3452
  # @!attribute [rw] resource_id
3421
- # The Resource identifier for the Method resource.
3453
+ # \[Required\] The Resource identifier for the Method resource.
3422
3454
  # @return [String]
3423
3455
  #
3424
3456
  # @!attribute [rw] http_method
3425
- # Specifies the method request's HTTP method type.
3457
+ # \[Required\] Specifies the method request's HTTP method type.
3426
3458
  # @return [String]
3427
3459
  #
3428
3460
  class GetMethodRequest < Struct.new(
@@ -3445,19 +3477,20 @@ module Aws::APIGateway
3445
3477
  # }
3446
3478
  #
3447
3479
  # @!attribute [rw] rest_api_id
3448
- # The string identifier of the associated RestApi.
3480
+ # \[Required\] The string identifier of the associated RestApi.
3449
3481
  # @return [String]
3450
3482
  #
3451
3483
  # @!attribute [rw] resource_id
3452
- # The Resource identifier for the MethodResponse resource.
3484
+ # \[Required\] The Resource identifier for the MethodResponse
3485
+ # resource.
3453
3486
  # @return [String]
3454
3487
  #
3455
3488
  # @!attribute [rw] http_method
3456
- # The HTTP verb of the Method resource.
3489
+ # \[Required\] The HTTP verb of the Method resource.
3457
3490
  # @return [String]
3458
3491
  #
3459
3492
  # @!attribute [rw] status_code
3460
- # The status code for the MethodResponse resource.
3493
+ # \[Required\] The status code for the MethodResponse resource.
3461
3494
  # @return [String]
3462
3495
  #
3463
3496
  class GetMethodResponseRequest < Struct.new(
@@ -3481,11 +3514,11 @@ module Aws::APIGateway
3481
3514
  # }
3482
3515
  #
3483
3516
  # @!attribute [rw] rest_api_id
3484
- # The RestApi identifier under which the Model exists.
3517
+ # \[Required\] The RestApi identifier under which the Model exists.
3485
3518
  # @return [String]
3486
3519
  #
3487
3520
  # @!attribute [rw] model_name
3488
- # The name of the model as an identifier.
3521
+ # \[Required\] The name of the model as an identifier.
3489
3522
  # @return [String]
3490
3523
  #
3491
3524
  # @!attribute [rw] flatten
@@ -3513,11 +3546,11 @@ module Aws::APIGateway
3513
3546
  # }
3514
3547
  #
3515
3548
  # @!attribute [rw] rest_api_id
3516
- # The string identifier of the associated RestApi.
3549
+ # \[Required\] The string identifier of the associated RestApi.
3517
3550
  # @return [String]
3518
3551
  #
3519
3552
  # @!attribute [rw] model_name
3520
- # The name of the model for which to generate a template.
3553
+ # \[Required\] The name of the model for which to generate a template.
3521
3554
  # @return [String]
3522
3555
  #
3523
3556
  class GetModelTemplateRequest < Struct.new(
@@ -3538,7 +3571,7 @@ module Aws::APIGateway
3538
3571
  # }
3539
3572
  #
3540
3573
  # @!attribute [rw] rest_api_id
3541
- # The string identifier of the associated RestApi.
3574
+ # \[Required\] The string identifier of the associated RestApi.
3542
3575
  # @return [String]
3543
3576
  #
3544
3577
  # @!attribute [rw] position
@@ -3546,8 +3579,8 @@ module Aws::APIGateway
3546
3579
  # @return [String]
3547
3580
  #
3548
3581
  # @!attribute [rw] limit
3549
- # The maximum number of returned results per page. The value is 25 by
3550
- # default and could be between 1 - 500.
3582
+ # The maximum number of returned results per page. The default value
3583
+ # is 25 and the maximum value is 500.
3551
3584
  # @return [Integer]
3552
3585
  #
3553
3586
  class GetModelsRequest < Struct.new(
@@ -3568,7 +3601,7 @@ module Aws::APIGateway
3568
3601
  # }
3569
3602
  #
3570
3603
  # @!attribute [rw] rest_api_id
3571
- # The string identifier of the associated RestApi.
3604
+ # \[Required\] The string identifier of the associated RestApi.
3572
3605
  # @return [String]
3573
3606
  #
3574
3607
  # @!attribute [rw] request_validator_id
@@ -3593,7 +3626,7 @@ module Aws::APIGateway
3593
3626
  # }
3594
3627
  #
3595
3628
  # @!attribute [rw] rest_api_id
3596
- # The string identifier of the associated RestApi.
3629
+ # \[Required\] The string identifier of the associated RestApi.
3597
3630
  # @return [String]
3598
3631
  #
3599
3632
  # @!attribute [rw] position
@@ -3601,7 +3634,8 @@ module Aws::APIGateway
3601
3634
  # @return [String]
3602
3635
  #
3603
3636
  # @!attribute [rw] limit
3604
- # The maximum number of returned results per page.
3637
+ # The maximum number of returned results per page. The default value
3638
+ # is 25 and the maximum value is 500.
3605
3639
  # @return [Integer]
3606
3640
  #
3607
3641
  class GetRequestValidatorsRequest < Struct.new(
@@ -3623,11 +3657,11 @@ module Aws::APIGateway
3623
3657
  # }
3624
3658
  #
3625
3659
  # @!attribute [rw] rest_api_id
3626
- # The string identifier of the associated RestApi.
3660
+ # \[Required\] The string identifier of the associated RestApi.
3627
3661
  # @return [String]
3628
3662
  #
3629
3663
  # @!attribute [rw] resource_id
3630
- # The identifier for the Resource resource.
3664
+ # \[Required\] The identifier for the Resource resource.
3631
3665
  # @return [String]
3632
3666
  #
3633
3667
  # @!attribute [rw] embed
@@ -3660,7 +3694,7 @@ module Aws::APIGateway
3660
3694
  # }
3661
3695
  #
3662
3696
  # @!attribute [rw] rest_api_id
3663
- # The string identifier of the associated RestApi.
3697
+ # \[Required\] The string identifier of the associated RestApi.
3664
3698
  # @return [String]
3665
3699
  #
3666
3700
  # @!attribute [rw] position
@@ -3668,8 +3702,8 @@ module Aws::APIGateway
3668
3702
  # @return [String]
3669
3703
  #
3670
3704
  # @!attribute [rw] limit
3671
- # The maximum number of returned results per page. The value is 25 by
3672
- # default and could be between 1 - 500.
3705
+ # The maximum number of returned results per page. The default value
3706
+ # is 25 and the maximum value is 500.
3673
3707
  # @return [Integer]
3674
3708
  #
3675
3709
  # @!attribute [rw] embed
@@ -3701,7 +3735,7 @@ module Aws::APIGateway
3701
3735
  # }
3702
3736
  #
3703
3737
  # @!attribute [rw] rest_api_id
3704
- # The identifier of the RestApi resource.
3738
+ # \[Required\] The string identifier of the associated RestApi.
3705
3739
  # @return [String]
3706
3740
  #
3707
3741
  class GetRestApiRequest < Struct.new(
@@ -3724,8 +3758,8 @@ module Aws::APIGateway
3724
3758
  # @return [String]
3725
3759
  #
3726
3760
  # @!attribute [rw] limit
3727
- # The maximum number of returned results per page. The value is 25 by
3728
- # default and could be between 1 - 500.
3761
+ # The maximum number of returned results per page. The default value
3762
+ # is 25 and the maximum value is 500.
3729
3763
  # @return [Integer]
3730
3764
  #
3731
3765
  class GetRestApisRequest < Struct.new(
@@ -3749,17 +3783,17 @@ module Aws::APIGateway
3749
3783
  # }
3750
3784
  #
3751
3785
  # @!attribute [rw] rest_api_id
3752
- # The string identifier of the associated RestApi.
3786
+ # \[Required\] The string identifier of the associated RestApi.
3753
3787
  # @return [String]
3754
3788
  #
3755
3789
  # @!attribute [rw] stage_name
3756
- # The name of the Stage that the SDK will use.
3790
+ # \[Required\] The name of the Stage that the SDK will use.
3757
3791
  # @return [String]
3758
3792
  #
3759
3793
  # @!attribute [rw] sdk_type
3760
- # The language for the generated SDK. Currently `java`, `javascript`,
3761
- # `android`, `objectivec` (for iOS), `swift` (for iOS), and `ruby` are
3762
- # supported.
3794
+ # \[Required\] The language for the generated SDK. Currently `java`,
3795
+ # `javascript`, `android`, `objectivec` (for iOS), `swift` (for iOS),
3796
+ # and `ruby` are supported.
3763
3797
  # @return [String]
3764
3798
  #
3765
3799
  # @!attribute [rw] parameters
@@ -3790,7 +3824,7 @@ module Aws::APIGateway
3790
3824
  # }
3791
3825
  #
3792
3826
  # @!attribute [rw] id
3793
- # The identifier of the queried SdkType instance.
3827
+ # \[Required\] The identifier of the queried SdkType instance.
3794
3828
  # @return [String]
3795
3829
  #
3796
3830
  class GetSdkTypeRequest < Struct.new(
@@ -3813,7 +3847,8 @@ module Aws::APIGateway
3813
3847
  # @return [String]
3814
3848
  #
3815
3849
  # @!attribute [rw] limit
3816
- # The maximum number of returned results per page.
3850
+ # The maximum number of returned results per page. The default value
3851
+ # is 25 and the maximum value is 500.
3817
3852
  # @return [Integer]
3818
3853
  #
3819
3854
  class GetSdkTypesRequest < Struct.new(
@@ -3833,11 +3868,12 @@ module Aws::APIGateway
3833
3868
  # }
3834
3869
  #
3835
3870
  # @!attribute [rw] rest_api_id
3836
- # The string identifier of the associated RestApi.
3871
+ # \[Required\] The string identifier of the associated RestApi.
3837
3872
  # @return [String]
3838
3873
  #
3839
3874
  # @!attribute [rw] stage_name
3840
- # The name of the Stage resource to get information about.
3875
+ # \[Required\] The name of the Stage resource to get information
3876
+ # about.
3841
3877
  # @return [String]
3842
3878
  #
3843
3879
  class GetStageRequest < Struct.new(
@@ -3858,7 +3894,7 @@ module Aws::APIGateway
3858
3894
  # }
3859
3895
  #
3860
3896
  # @!attribute [rw] rest_api_id
3861
- # The string identifier of the associated RestApi.
3897
+ # \[Required\] The string identifier of the associated RestApi.
3862
3898
  # @return [String]
3863
3899
  #
3864
3900
  # @!attribute [rw] deployment_id
@@ -3883,8 +3919,9 @@ module Aws::APIGateway
3883
3919
  # }
3884
3920
  #
3885
3921
  # @!attribute [rw] resource_arn
3886
- # \[Required\] The ARN of a resource that can be tagged. At present,
3887
- # Stage is the only taggable resource.
3922
+ # \[Required\] The ARN of a resource that can be tagged. The resource
3923
+ # ARN must be URL-encoded. At present, Stage is the only taggable
3924
+ # resource.
3888
3925
  # @return [String]
3889
3926
  #
3890
3927
  # @!attribute [rw] position
@@ -3894,7 +3931,7 @@ module Aws::APIGateway
3894
3931
  #
3895
3932
  # @!attribute [rw] limit
3896
3933
  # (Not currently supported) The maximum number of returned results per
3897
- # page.
3934
+ # page. The default value is 25 and the maximum value is 500.
3898
3935
  # @return [Integer]
3899
3936
  #
3900
3937
  class GetTagsRequest < Struct.new(
@@ -3915,14 +3952,14 @@ module Aws::APIGateway
3915
3952
  # }
3916
3953
  #
3917
3954
  # @!attribute [rw] usage_plan_id
3918
- # The Id of the UsagePlan resource representing the usage plan
3919
- # containing the to-be-retrieved UsagePlanKey resource representing a
3920
- # plan customer.
3955
+ # \[Required\] The Id of the UsagePlan resource representing the usage
3956
+ # plan containing the to-be-retrieved UsagePlanKey resource
3957
+ # representing a plan customer.
3921
3958
  # @return [String]
3922
3959
  #
3923
3960
  # @!attribute [rw] key_id
3924
- # The key Id of the to-be-retrieved UsagePlanKey resource representing
3925
- # a plan customer.
3961
+ # \[Required\] The key Id of the to-be-retrieved UsagePlanKey resource
3962
+ # representing a plan customer.
3926
3963
  # @return [String]
3927
3964
  #
3928
3965
  class GetUsagePlanKeyRequest < Struct.new(
@@ -3945,9 +3982,9 @@ module Aws::APIGateway
3945
3982
  # }
3946
3983
  #
3947
3984
  # @!attribute [rw] usage_plan_id
3948
- # The Id of the UsagePlan resource representing the usage plan
3949
- # containing the to-be-retrieved UsagePlanKey resource representing a
3950
- # plan customer.
3985
+ # \[Required\] The Id of the UsagePlan resource representing the usage
3986
+ # plan containing the to-be-retrieved UsagePlanKey resource
3987
+ # representing a plan customer.
3951
3988
  # @return [String]
3952
3989
  #
3953
3990
  # @!attribute [rw] position
@@ -3955,7 +3992,8 @@ module Aws::APIGateway
3955
3992
  # @return [String]
3956
3993
  #
3957
3994
  # @!attribute [rw] limit
3958
- # The maximum number of returned results per page.
3995
+ # The maximum number of returned results per page. The default value
3996
+ # is 25 and the maximum value is 500.
3959
3997
  # @return [Integer]
3960
3998
  #
3961
3999
  # @!attribute [rw] name_query
@@ -3981,7 +4019,8 @@ module Aws::APIGateway
3981
4019
  # }
3982
4020
  #
3983
4021
  # @!attribute [rw] usage_plan_id
3984
- # The identifier of the UsagePlan resource to be retrieved.
4022
+ # \[Required\] The identifier of the UsagePlan resource to be
4023
+ # retrieved.
3985
4024
  # @return [String]
3986
4025
  #
3987
4026
  class GetUsagePlanRequest < Struct.new(
@@ -4009,7 +4048,8 @@ module Aws::APIGateway
4009
4048
  # @return [String]
4010
4049
  #
4011
4050
  # @!attribute [rw] limit
4012
- # The maximum number of returned results per page.
4051
+ # The maximum number of returned results per page. The default value
4052
+ # is 25 and the maximum value is 500.
4013
4053
  # @return [Integer]
4014
4054
  #
4015
4055
  class GetUsagePlansRequest < Struct.new(
@@ -4035,7 +4075,8 @@ module Aws::APIGateway
4035
4075
  # }
4036
4076
  #
4037
4077
  # @!attribute [rw] usage_plan_id
4038
- # The Id of the usage plan associated with the usage data.
4078
+ # \[Required\] The Id of the usage plan associated with the usage
4079
+ # data.
4039
4080
  # @return [String]
4040
4081
  #
4041
4082
  # @!attribute [rw] key_id
@@ -4043,11 +4084,11 @@ module Aws::APIGateway
4043
4084
  # @return [String]
4044
4085
  #
4045
4086
  # @!attribute [rw] start_date
4046
- # The starting date (e.g., 2016-01-01) of the usage data.
4087
+ # \[Required\] The starting date (e.g., 2016-01-01) of the usage data.
4047
4088
  # @return [String]
4048
4089
  #
4049
4090
  # @!attribute [rw] end_date
4050
- # The ending date (e.g., 2016-12-31) of the usage data.
4091
+ # \[Required\] The ending date (e.g., 2016-12-31) of the usage data.
4051
4092
  # @return [String]
4052
4093
  #
4053
4094
  # @!attribute [rw] position
@@ -4055,7 +4096,8 @@ module Aws::APIGateway
4055
4096
  # @return [String]
4056
4097
  #
4057
4098
  # @!attribute [rw] limit
4058
- # The maximum number of returned results per page.
4099
+ # The maximum number of returned results per page. The default value
4100
+ # is 25 and the maximum value is 500.
4059
4101
  # @return [Integer]
4060
4102
  #
4061
4103
  class GetUsageRequest < Struct.new(
@@ -4103,7 +4145,8 @@ module Aws::APIGateway
4103
4145
  # @return [String]
4104
4146
  #
4105
4147
  # @!attribute [rw] limit
4106
- # The maximum number of returned results per page.
4148
+ # The maximum number of returned results per page. The default value
4149
+ # is 25 and the maximum value is 500.
4107
4150
  # @return [Integer]
4108
4151
  #
4109
4152
  class GetVpcLinksRequest < Struct.new(
@@ -4242,9 +4285,9 @@ module Aws::APIGateway
4242
4285
  # @return [Hash<String,String>]
4243
4286
  #
4244
4287
  # @!attribute [rw] body
4245
- # The POST request body containing external API definitions.
4246
- # Currently, only Swagger definition JSON files are supported. The
4247
- # maximum size of the API definition file is 2MB.
4288
+ # \[Required\] The POST request body containing external API
4289
+ # definitions. Currently, only Swagger definition JSON files are
4290
+ # supported. The maximum size of the API definition file is 2MB.
4248
4291
  # @return [String]
4249
4292
  #
4250
4293
  class ImportRestApiRequest < Struct.new(
@@ -4748,7 +4791,7 @@ module Aws::APIGateway
4748
4791
  #
4749
4792
  # @!attribute [rw] authorization_scopes
4750
4793
  # A list of authorization scopes configured on the method. The scopes
4751
- # are used with a `COGNITO_USER_POOL` authorizer to authorize the
4794
+ # are used with a `COGNITO_USER_POOLS` authorizer to authorize the
4752
4795
  # method invocation. The authorization works by matching the method
4753
4796
  # scopes against the scopes parsed from the access token in the
4754
4797
  # incoming request. The method invocation is authorized if any method
@@ -4989,7 +5032,7 @@ module Aws::APIGateway
4989
5032
  #
4990
5033
  # @!attribute [rw] schema
4991
5034
  # The schema for the model. For `application/json` models, this should
4992
- # be [JSON-schema draft v4][1] model. Do not include "\\*/"
5035
+ # be [JSON schema draft 4][1] model. Do not include "\\*/"
4993
5036
  # characters in the description of any properties because such
4994
5037
  # "\\*/" characters may be interpreted as the closing marker for
4995
5038
  # comments in some languages, such as Java or JavaScript, causing the
@@ -4997,7 +5040,7 @@ module Aws::APIGateway
4997
5040
  #
4998
5041
  #
4999
5042
  #
5000
- # [1]: http://json-schema.org/documentation.html
5043
+ # [1]: https://tools.ietf.org/html/draft-zyp-json-schema-04
5001
5044
  # @return [String]
5002
5045
  #
5003
5046
  # @!attribute [rw] content_type
@@ -5125,11 +5168,12 @@ module Aws::APIGateway
5125
5168
  # }
5126
5169
  #
5127
5170
  # @!attribute [rw] rest_api_id
5128
- # The string identifier of the associated RestApi.
5171
+ # \[Required\] The string identifier of the associated RestApi.
5129
5172
  # @return [String]
5130
5173
  #
5131
5174
  # @!attribute [rw] response_type
5132
- # The response type of the associated GatewayResponse. Valid values
5175
+ # \[Required\] The response type of the associated GatewayResponse.
5176
+ # Valid values
5133
5177
  # are * ACCESS\_DENIED
5134
5178
  # * API\_CONFIGURATION\_ERROR
5135
5179
  # * AUTHORIZER\_FAILURE
@@ -5149,7 +5193,7 @@ module Aws::APIGateway
5149
5193
  # * RESOURCE\_NOT\_FOUND
5150
5194
  # * THROTTLED
5151
5195
  # * UNAUTHORIZED
5152
- # * UNSUPPORTED\_MEDIA\_TYPES
5196
+ # * UNSUPPORTED\_MEDIA\_TYPE
5153
5197
  # @return [String]
5154
5198
  #
5155
5199
  # @!attribute [rw] status_code
@@ -5204,19 +5248,19 @@ module Aws::APIGateway
5204
5248
  # }
5205
5249
  #
5206
5250
  # @!attribute [rw] rest_api_id
5207
- # The string identifier of the associated RestApi.
5251
+ # \[Required\] The string identifier of the associated RestApi.
5208
5252
  # @return [String]
5209
5253
  #
5210
5254
  # @!attribute [rw] resource_id
5211
- # Specifies a put integration request's resource ID.
5255
+ # \[Required\] Specifies a put integration request's resource ID.
5212
5256
  # @return [String]
5213
5257
  #
5214
5258
  # @!attribute [rw] http_method
5215
- # Specifies a put integration request's HTTP method.
5259
+ # \[Required\] Specifies a put integration request's HTTP method.
5216
5260
  # @return [String]
5217
5261
  #
5218
5262
  # @!attribute [rw] type
5219
- # Specifies a put integration input's type.
5263
+ # \[Required\] Specifies a put integration input's type.
5220
5264
  # @return [String]
5221
5265
  #
5222
5266
  # @!attribute [rw] integration_http_method
@@ -5388,20 +5432,22 @@ module Aws::APIGateway
5388
5432
  # }
5389
5433
  #
5390
5434
  # @!attribute [rw] rest_api_id
5391
- # The string identifier of the associated RestApi.
5435
+ # \[Required\] The string identifier of the associated RestApi.
5392
5436
  # @return [String]
5393
5437
  #
5394
5438
  # @!attribute [rw] resource_id
5395
- # Specifies a put integration response request's resource identifier.
5439
+ # \[Required\] Specifies a put integration response request's
5440
+ # resource identifier.
5396
5441
  # @return [String]
5397
5442
  #
5398
5443
  # @!attribute [rw] http_method
5399
- # Specifies a put integration response request's HTTP method.
5444
+ # \[Required\] Specifies a put integration response request's HTTP
5445
+ # method.
5400
5446
  # @return [String]
5401
5447
  #
5402
5448
  # @!attribute [rw] status_code
5403
- # Specifies the status code that is used to map the integration
5404
- # response to an existing MethodResponse.
5449
+ # \[Required\] Specifies the status code that is used to map the
5450
+ # integration response to an existing MethodResponse.
5405
5451
  # @return [String]
5406
5452
  #
5407
5453
  # @!attribute [rw] selection_pattern
@@ -5479,27 +5525,29 @@ module Aws::APIGateway
5479
5525
  # }
5480
5526
  #
5481
5527
  # @!attribute [rw] rest_api_id
5482
- # The string identifier of the associated RestApi.
5528
+ # \[Required\] The string identifier of the associated RestApi.
5483
5529
  # @return [String]
5484
5530
  #
5485
5531
  # @!attribute [rw] resource_id
5486
- # The Resource identifier for the new Method resource.
5532
+ # \[Required\] The Resource identifier for the new Method resource.
5487
5533
  # @return [String]
5488
5534
  #
5489
5535
  # @!attribute [rw] http_method
5490
- # Specifies the method request's HTTP method type.
5536
+ # \[Required\] Specifies the method request's HTTP method type.
5491
5537
  # @return [String]
5492
5538
  #
5493
5539
  # @!attribute [rw] authorization_type
5494
- # The method's authorization type. Valid values are `NONE` for open
5495
- # access, `AWS_IAM` for using AWS IAM permissions, `CUSTOM` for using
5496
- # a custom authorizer, or `COGNITO_USER_POOLS` for using a Cognito
5497
- # user pool.
5540
+ # \[Required\] The method's authorization type. Valid values are
5541
+ # `NONE` for open access, `AWS_IAM` for using AWS IAM permissions,
5542
+ # `CUSTOM` for using a custom authorizer, or `COGNITO_USER_POOLS` for
5543
+ # using a Cognito user pool.
5498
5544
  # @return [String]
5499
5545
  #
5500
5546
  # @!attribute [rw] authorizer_id
5501
5547
  # Specifies the identifier of an Authorizer to use on this Method, if
5502
- # the type is CUSTOM.
5548
+ # the type is CUSTOM or COGNITO\_USER\_POOLS. The authorizer
5549
+ # identifier is generated by API Gateway when you created the
5550
+ # authorizer.
5503
5551
  # @return [String]
5504
5552
  #
5505
5553
  # @!attribute [rw] api_key_required
@@ -5542,7 +5590,7 @@ module Aws::APIGateway
5542
5590
  #
5543
5591
  # @!attribute [rw] authorization_scopes
5544
5592
  # A list of authorization scopes configured on the method. The scopes
5545
- # are used with a `COGNITO_USER_POOL` authorizer to authorize the
5593
+ # are used with a `COGNITO_USER_POOLS` authorizer to authorize the
5546
5594
  # method invocation. The authorization works by matching the method
5547
5595
  # scopes against the scopes parsed from the access token in the
5548
5596
  # incoming request. The method invocation is authorized if any method
@@ -5586,19 +5634,19 @@ module Aws::APIGateway
5586
5634
  # }
5587
5635
  #
5588
5636
  # @!attribute [rw] rest_api_id
5589
- # The string identifier of the associated RestApi.
5637
+ # \[Required\] The string identifier of the associated RestApi.
5590
5638
  # @return [String]
5591
5639
  #
5592
5640
  # @!attribute [rw] resource_id
5593
- # The Resource identifier for the Method resource.
5641
+ # \[Required\] The Resource identifier for the Method resource.
5594
5642
  # @return [String]
5595
5643
  #
5596
5644
  # @!attribute [rw] http_method
5597
- # The HTTP verb of the Method resource.
5645
+ # \[Required\] The HTTP verb of the Method resource.
5598
5646
  # @return [String]
5599
5647
  #
5600
5648
  # @!attribute [rw] status_code
5601
- # The method response's status code.
5649
+ # \[Required\] The method response's status code.
5602
5650
  # @return [String]
5603
5651
  #
5604
5652
  # @!attribute [rw] response_parameters
@@ -5652,7 +5700,7 @@ module Aws::APIGateway
5652
5700
  # }
5653
5701
  #
5654
5702
  # @!attribute [rw] rest_api_id
5655
- # The string identifier of the associated RestApi.
5703
+ # \[Required\] The string identifier of the associated RestApi.
5656
5704
  # @return [String]
5657
5705
  #
5658
5706
  # @!attribute [rw] mode
@@ -5677,9 +5725,9 @@ module Aws::APIGateway
5677
5725
  # @return [Hash<String,String>]
5678
5726
  #
5679
5727
  # @!attribute [rw] body
5680
- # The PUT request body containing external API definitions. Currently,
5681
- # only Swagger definition JSON files are supported. The maximum size
5682
- # of the API definition file is 2MB.
5728
+ # \[Required\] The PUT request body containing external API
5729
+ # definitions. Currently, only Swagger definition JSON files are
5730
+ # supported. The maximum size of the API definition file is 2MB.
5683
5731
  # @return [String]
5684
5732
  #
5685
5733
  class PutRestApiRequest < Struct.new(
@@ -5930,16 +5978,17 @@ module Aws::APIGateway
5930
5978
  # @return [Array<String>]
5931
5979
  #
5932
5980
  # @!attribute [rw] minimum_compression_size
5933
- # A nullable integer used to enable (non-negative between 0 and
5934
- # 10485760 (10M) bytes, inclusive) or disable (null) compression on an
5935
- # API. When compression is enabled, compression or decompression are
5936
- # not applied on the payload if the payload size is smaller than this
5937
- # value. Setting it to zero allows compression for any payload size.
5981
+ # A nullable integer that is used to enable compression (with
5982
+ # non-negative between 0 and 10485760 (10M) bytes, inclusive) or
5983
+ # disable compression (with a null value) on an API. When compression
5984
+ # is enabled, compression or decompression is not applied on the
5985
+ # payload if the payload size is smaller than this value. Setting it
5986
+ # to zero allows compression for any payload size.
5938
5987
  # @return [Integer]
5939
5988
  #
5940
5989
  # @!attribute [rw] api_key_source
5941
- # The source of the API key for metring requests according to a usage
5942
- # plan. Valid values are * `HEADER` to read the API key from the
5990
+ # The source of the API key for metering requests according to a usage
5991
+ # plan. Valid values are: * `HEADER` to read the API key from the
5943
5992
  # `X-API-Key` header of a
5944
5993
  # request.
5945
5994
  # * `AUTHORIZER` to read the API key from the `UsageIdentifierKey`
@@ -5951,6 +6000,10 @@ module Aws::APIGateway
5951
6000
  # types of the API.
5952
6001
  # @return [Types::EndpointConfiguration]
5953
6002
  #
6003
+ # @!attribute [rw] policy
6004
+ # A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
6005
+ # @return [String]
6006
+ #
5954
6007
  class RestApi < Struct.new(
5955
6008
  :id,
5956
6009
  :name,
@@ -5961,7 +6014,8 @@ module Aws::APIGateway
5961
6014
  :binary_media_types,
5962
6015
  :minimum_compression_size,
5963
6016
  :api_key_source,
5964
- :endpoint_configuration)
6017
+ :endpoint_configuration,
6018
+ :policy)
5965
6019
  include Aws::Structure
5966
6020
  end
5967
6021
 
@@ -6153,7 +6207,8 @@ module Aws::APIGateway
6153
6207
  # @return [Types::CanarySettings]
6154
6208
  #
6155
6209
  # @!attribute [rw] tags
6156
- # A collection of Tags associated with a given resource.
6210
+ # The collection of tags. Each tag element is associated with a given
6211
+ # resource.
6157
6212
  # @return [Hash<String,String>]
6158
6213
  #
6159
6214
  # @!attribute [rw] created_date
@@ -6228,7 +6283,7 @@ module Aws::APIGateway
6228
6283
  include Aws::Structure
6229
6284
  end
6230
6285
 
6231
- # Adds or updates Tags on a gievn resource.
6286
+ # Adds or updates a tag on a given resource.
6232
6287
  #
6233
6288
  # @note When making an API call, you may pass TagResourceRequest
6234
6289
  # data as a hash:
@@ -6241,14 +6296,16 @@ module Aws::APIGateway
6241
6296
  # }
6242
6297
  #
6243
6298
  # @!attribute [rw] resource_arn
6244
- # \[Required\] The ARN of a resource that can be tagged. At present,
6245
- # Stage is the only taggable resource.
6299
+ # \[Required\] The ARN of a resource that can be tagged. The resource
6300
+ # ARN must be URL-encoded. At present, Stage is the only taggable
6301
+ # resource.
6246
6302
  # @return [String]
6247
6303
  #
6248
6304
  # @!attribute [rw] tags
6249
- # \[Required\] Key/Value map of strings. Valid character set is
6250
- # \[a-zA-Z+-=.\_:/\]. Tag key can be up to 128 characters and must not
6251
- # start with "aws:". Tag value can be up to 256 characters.
6305
+ # \[Required\] The key-value map of strings. The valid character set
6306
+ # is \[a-zA-Z+-=.\_:/\]. The tag key can be up to 128 characters and
6307
+ # must not start with `aws:`. The tag value can be up to 256
6308
+ # characters.
6252
6309
  # @return [Hash<String,String>]
6253
6310
  #
6254
6311
  class TagResourceRequest < Struct.new(
@@ -6257,10 +6314,12 @@ module Aws::APIGateway
6257
6314
  include Aws::Structure
6258
6315
  end
6259
6316
 
6260
- # A collection of Tags associated with a given resource.
6317
+ # The collection of tags. Each tag element is associated with a given
6318
+ # resource.
6261
6319
  #
6262
6320
  # @!attribute [rw] tags
6263
- # A collection of Tags associated with a given resource.
6321
+ # The collection of tags. Each tag element is associated with a given
6322
+ # resource.
6264
6323
  # @return [Hash<String,String>]
6265
6324
  #
6266
6325
  class Tags < Struct.new(
@@ -6314,11 +6373,12 @@ module Aws::APIGateway
6314
6373
  # }
6315
6374
  #
6316
6375
  # @!attribute [rw] rest_api_id
6317
- # The string identifier of the associated RestApi.
6376
+ # \[Required\] The string identifier of the associated RestApi.
6318
6377
  # @return [String]
6319
6378
  #
6320
6379
  # @!attribute [rw] authorizer_id
6321
- # Specifies a test invoke authorizer request's Authorizer ID.
6380
+ # \[Required\] Specifies a test invoke authorizer request's
6381
+ # Authorizer ID.
6322
6382
  # @return [String]
6323
6383
  #
6324
6384
  # @!attribute [rw] headers
@@ -6426,15 +6486,15 @@ module Aws::APIGateway
6426
6486
  # }
6427
6487
  #
6428
6488
  # @!attribute [rw] rest_api_id
6429
- # The string identifier of the associated RestApi.
6489
+ # \[Required\] The string identifier of the associated RestApi.
6430
6490
  # @return [String]
6431
6491
  #
6432
6492
  # @!attribute [rw] resource_id
6433
- # Specifies a test invoke method request's resource ID.
6493
+ # \[Required\] Specifies a test invoke method request's resource ID.
6434
6494
  # @return [String]
6435
6495
  #
6436
6496
  # @!attribute [rw] http_method
6437
- # Specifies a test invoke method request's HTTP method.
6497
+ # \[Required\] Specifies a test invoke method request's HTTP method.
6438
6498
  # @return [String]
6439
6499
  #
6440
6500
  # @!attribute [rw] path_with_query_string
@@ -6540,7 +6600,7 @@ module Aws::APIGateway
6540
6600
  include Aws::Structure
6541
6601
  end
6542
6602
 
6543
- # Removes Tags from a given resource.
6603
+ # Removes a tag from a given resource.
6544
6604
  #
6545
6605
  # @note When making an API call, you may pass UntagResourceRequest
6546
6606
  # data as a hash:
@@ -6551,12 +6611,13 @@ module Aws::APIGateway
6551
6611
  # }
6552
6612
  #
6553
6613
  # @!attribute [rw] resource_arn
6554
- # \[Required\] The ARN of a resource that can be tagged. At present,
6555
- # Stage is the only taggable resource.
6614
+ # \[Required\] The ARN of a resource that can be tagged. The resource
6615
+ # ARN must be URL-encoded. At present, Stage is the only taggable
6616
+ # resource.
6556
6617
  # @return [String]
6557
6618
  #
6558
6619
  # @!attribute [rw] tag_keys
6559
- # The Tag keys to delete.
6620
+ # \[Required\] The Tag keys to delete.
6560
6621
  # @return [Array<String>]
6561
6622
  #
6562
6623
  class UntagResourceRequest < Struct.new(
@@ -6610,7 +6671,7 @@ module Aws::APIGateway
6610
6671
  # }
6611
6672
  #
6612
6673
  # @!attribute [rw] api_key
6613
- # The identifier of the ApiKey resource to be updated.
6674
+ # \[Required\] The identifier of the ApiKey resource to be updated.
6614
6675
  # @return [String]
6615
6676
  #
6616
6677
  # @!attribute [rw] patch_operations
@@ -6643,11 +6704,11 @@ module Aws::APIGateway
6643
6704
  # }
6644
6705
  #
6645
6706
  # @!attribute [rw] rest_api_id
6646
- # The string identifier of the associated RestApi.
6707
+ # \[Required\] The string identifier of the associated RestApi.
6647
6708
  # @return [String]
6648
6709
  #
6649
6710
  # @!attribute [rw] authorizer_id
6650
- # The identifier of the Authorizer resource.
6711
+ # \[Required\] The identifier of the Authorizer resource.
6651
6712
  # @return [String]
6652
6713
  #
6653
6714
  # @!attribute [rw] patch_operations
@@ -6681,11 +6742,13 @@ module Aws::APIGateway
6681
6742
  # }
6682
6743
  #
6683
6744
  # @!attribute [rw] domain_name
6684
- # The domain name of the BasePathMapping resource to change.
6745
+ # \[Required\] The domain name of the BasePathMapping resource to
6746
+ # change.
6685
6747
  # @return [String]
6686
6748
  #
6687
6749
  # @!attribute [rw] base_path
6688
- # The base path of the BasePathMapping resource to change.
6750
+ # \[Required\] The base path of the BasePathMapping resource to
6751
+ # change.
6689
6752
  # @return [String]
6690
6753
  #
6691
6754
  # @!attribute [rw] patch_operations
@@ -6718,7 +6781,8 @@ module Aws::APIGateway
6718
6781
  # }
6719
6782
  #
6720
6783
  # @!attribute [rw] client_certificate_id
6721
- # The identifier of the ClientCertificate resource to be updated.
6784
+ # \[Required\] The identifier of the ClientCertificate resource to be
6785
+ # updated.
6722
6786
  # @return [String]
6723
6787
  #
6724
6788
  # @!attribute [rw] patch_operations
@@ -6752,7 +6816,7 @@ module Aws::APIGateway
6752
6816
  # }
6753
6817
  #
6754
6818
  # @!attribute [rw] rest_api_id
6755
- # The string identifier of the associated RestApi.
6819
+ # \[Required\] The string identifier of the associated RestApi.
6756
6820
  # @return [String]
6757
6821
  #
6758
6822
  # @!attribute [rw] deployment_id
@@ -6867,7 +6931,7 @@ module Aws::APIGateway
6867
6931
  # }
6868
6932
  #
6869
6933
  # @!attribute [rw] domain_name
6870
- # The name of the DomainName resource to be changed.
6934
+ # \[Required\] The name of the DomainName resource to be changed.
6871
6935
  # @return [String]
6872
6936
  #
6873
6937
  # @!attribute [rw] patch_operations
@@ -6901,11 +6965,12 @@ module Aws::APIGateway
6901
6965
  # }
6902
6966
  #
6903
6967
  # @!attribute [rw] rest_api_id
6904
- # The string identifier of the associated RestApi.
6968
+ # \[Required\] The string identifier of the associated RestApi.
6905
6969
  # @return [String]
6906
6970
  #
6907
6971
  # @!attribute [rw] response_type
6908
- # The response type of the associated GatewayResponse. Valid values
6972
+ # \[Required\] The response type of the associated GatewayResponse.
6973
+ # Valid values
6909
6974
  # are * ACCESS\_DENIED
6910
6975
  # * API\_CONFIGURATION\_ERROR
6911
6976
  # * AUTHORIZER\_FAILURE
@@ -6925,7 +6990,7 @@ module Aws::APIGateway
6925
6990
  # * RESOURCE\_NOT\_FOUND
6926
6991
  # * THROTTLED
6927
6992
  # * UNAUTHORIZED
6928
- # * UNSUPPORTED\_MEDIA\_TYPES
6993
+ # * UNSUPPORTED\_MEDIA\_TYPE
6929
6994
  # @return [String]
6930
6995
  #
6931
6996
  # @!attribute [rw] patch_operations
@@ -6960,15 +7025,17 @@ module Aws::APIGateway
6960
7025
  # }
6961
7026
  #
6962
7027
  # @!attribute [rw] rest_api_id
6963
- # The string identifier of the associated RestApi.
7028
+ # \[Required\] The string identifier of the associated RestApi.
6964
7029
  # @return [String]
6965
7030
  #
6966
7031
  # @!attribute [rw] resource_id
6967
- # Represents an update integration request's resource identifier.
7032
+ # \[Required\] Represents an update integration request's resource
7033
+ # identifier.
6968
7034
  # @return [String]
6969
7035
  #
6970
7036
  # @!attribute [rw] http_method
6971
- # Represents an update integration request's HTTP method.
7037
+ # \[Required\] Represents an update integration request's HTTP
7038
+ # method.
6972
7039
  # @return [String]
6973
7040
  #
6974
7041
  # @!attribute [rw] patch_operations
@@ -7005,20 +7072,22 @@ module Aws::APIGateway
7005
7072
  # }
7006
7073
  #
7007
7074
  # @!attribute [rw] rest_api_id
7008
- # The string identifier of the associated RestApi.
7075
+ # \[Required\] The string identifier of the associated RestApi.
7009
7076
  # @return [String]
7010
7077
  #
7011
7078
  # @!attribute [rw] resource_id
7012
- # Specifies an update integration response request's resource
7013
- # identifier.
7079
+ # \[Required\] Specifies an update integration response request's
7080
+ # resource identifier.
7014
7081
  # @return [String]
7015
7082
  #
7016
7083
  # @!attribute [rw] http_method
7017
- # Specifies an update integration response request's HTTP method.
7084
+ # \[Required\] Specifies an update integration response request's
7085
+ # HTTP method.
7018
7086
  # @return [String]
7019
7087
  #
7020
7088
  # @!attribute [rw] status_code
7021
- # Specifies an update integration response request's status code.
7089
+ # \[Required\] Specifies an update integration response request's
7090
+ # status code.
7022
7091
  # @return [String]
7023
7092
  #
7024
7093
  # @!attribute [rw] patch_operations
@@ -7055,15 +7124,15 @@ module Aws::APIGateway
7055
7124
  # }
7056
7125
  #
7057
7126
  # @!attribute [rw] rest_api_id
7058
- # The string identifier of the associated RestApi.
7127
+ # \[Required\] The string identifier of the associated RestApi.
7059
7128
  # @return [String]
7060
7129
  #
7061
7130
  # @!attribute [rw] resource_id
7062
- # The Resource identifier for the Method resource.
7131
+ # \[Required\] The Resource identifier for the Method resource.
7063
7132
  # @return [String]
7064
7133
  #
7065
7134
  # @!attribute [rw] http_method
7066
- # The HTTP verb of the Method resource.
7135
+ # \[Required\] The HTTP verb of the Method resource.
7067
7136
  # @return [String]
7068
7137
  #
7069
7138
  # @!attribute [rw] patch_operations
@@ -7100,19 +7169,20 @@ module Aws::APIGateway
7100
7169
  # }
7101
7170
  #
7102
7171
  # @!attribute [rw] rest_api_id
7103
- # The string identifier of the associated RestApi.
7172
+ # \[Required\] The string identifier of the associated RestApi.
7104
7173
  # @return [String]
7105
7174
  #
7106
7175
  # @!attribute [rw] resource_id
7107
- # The Resource identifier for the MethodResponse resource.
7176
+ # \[Required\] The Resource identifier for the MethodResponse
7177
+ # resource.
7108
7178
  # @return [String]
7109
7179
  #
7110
7180
  # @!attribute [rw] http_method
7111
- # The HTTP verb of the Method resource.
7181
+ # \[Required\] The HTTP verb of the Method resource.
7112
7182
  # @return [String]
7113
7183
  #
7114
7184
  # @!attribute [rw] status_code
7115
- # The status code for the MethodResponse resource.
7185
+ # \[Required\] The status code for the MethodResponse resource.
7116
7186
  # @return [String]
7117
7187
  #
7118
7188
  # @!attribute [rw] patch_operations
@@ -7148,11 +7218,11 @@ module Aws::APIGateway
7148
7218
  # }
7149
7219
  #
7150
7220
  # @!attribute [rw] rest_api_id
7151
- # The string identifier of the associated RestApi.
7221
+ # \[Required\] The string identifier of the associated RestApi.
7152
7222
  # @return [String]
7153
7223
  #
7154
7224
  # @!attribute [rw] model_name
7155
- # The name of the model to update.
7225
+ # \[Required\] The name of the model to update.
7156
7226
  # @return [String]
7157
7227
  #
7158
7228
  # @!attribute [rw] patch_operations
@@ -7186,7 +7256,7 @@ module Aws::APIGateway
7186
7256
  # }
7187
7257
  #
7188
7258
  # @!attribute [rw] rest_api_id
7189
- # The string identifier of the associated RestApi.
7259
+ # \[Required\] The string identifier of the associated RestApi.
7190
7260
  # @return [String]
7191
7261
  #
7192
7262
  # @!attribute [rw] request_validator_id
@@ -7224,11 +7294,11 @@ module Aws::APIGateway
7224
7294
  # }
7225
7295
  #
7226
7296
  # @!attribute [rw] rest_api_id
7227
- # The string identifier of the associated RestApi.
7297
+ # \[Required\] The string identifier of the associated RestApi.
7228
7298
  # @return [String]
7229
7299
  #
7230
7300
  # @!attribute [rw] resource_id
7231
- # The identifier of the Resource resource.
7301
+ # \[Required\] The identifier of the Resource resource.
7232
7302
  # @return [String]
7233
7303
  #
7234
7304
  # @!attribute [rw] patch_operations
@@ -7261,7 +7331,7 @@ module Aws::APIGateway
7261
7331
  # }
7262
7332
  #
7263
7333
  # @!attribute [rw] rest_api_id
7264
- # The string identifier of the associated RestApi.
7334
+ # \[Required\] The string identifier of the associated RestApi.
7265
7335
  # @return [String]
7266
7336
  #
7267
7337
  # @!attribute [rw] patch_operations
@@ -7294,11 +7364,12 @@ module Aws::APIGateway
7294
7364
  # }
7295
7365
  #
7296
7366
  # @!attribute [rw] rest_api_id
7297
- # The string identifier of the associated RestApi.
7367
+ # \[Required\] The string identifier of the associated RestApi.
7298
7368
  # @return [String]
7299
7369
  #
7300
7370
  # @!attribute [rw] stage_name
7301
- # The name of the Stage resource to change information about.
7371
+ # \[Required\] The name of the Stage resource to change information
7372
+ # about.
7302
7373
  # @return [String]
7303
7374
  #
7304
7375
  # @!attribute [rw] patch_operations
@@ -7331,7 +7402,7 @@ module Aws::APIGateway
7331
7402
  # }
7332
7403
  #
7333
7404
  # @!attribute [rw] usage_plan_id
7334
- # The Id of the to-be-updated usage plan.
7405
+ # \[Required\] The Id of the to-be-updated usage plan.
7335
7406
  # @return [String]
7336
7407
  #
7337
7408
  # @!attribute [rw] patch_operations
@@ -7365,12 +7436,14 @@ module Aws::APIGateway
7365
7436
  # }
7366
7437
  #
7367
7438
  # @!attribute [rw] usage_plan_id
7368
- # The Id of the usage plan associated with the usage data.
7439
+ # \[Required\] The Id of the usage plan associated with the usage
7440
+ # data.
7369
7441
  # @return [String]
7370
7442
  #
7371
7443
  # @!attribute [rw] key_id
7372
- # The identifier of the API key associated with the usage plan in
7373
- # which a temporary extension is granted to the remaining quota.
7444
+ # \[Required\] The identifier of the API key associated with the usage
7445
+ # plan in which a temporary extension is granted to the remaining
7446
+ # quota.
7374
7447
  # @return [String]
7375
7448
  #
7376
7449
  # @!attribute [rw] patch_operations