aws-sdk-apigateway 1.76.0 → 1.77.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -355,14 +355,6 @@ module Aws::APIGateway
355
355
 
356
356
  # Create an ApiKey resource.
357
357
  #
358
- # <div class="seeAlso" markdown="1">
359
- # [AWS CLI][1]
360
- # </div>
361
- #
362
- #
363
- #
364
- # [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html
365
- #
366
358
  # @option params [String] :name
367
359
  # The name of the ApiKey.
368
360
  #
@@ -450,26 +442,17 @@ module Aws::APIGateway
450
442
 
451
443
  # Adds a new Authorizer resource to an existing RestApi resource.
452
444
  #
453
- # <div class="seeAlso" markdown="1">
454
- # [AWS CLI][1]
455
- # </div>
456
- #
457
- #
458
- #
459
- # [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html
460
- #
461
445
  # @option params [required, String] :rest_api_id
462
- # \[Required\] The string identifier of the associated RestApi.
446
+ # The string identifier of the associated RestApi.
463
447
  #
464
448
  # @option params [required, String] :name
465
- # \[Required\] The name of the authorizer.
449
+ # The name of the authorizer.
466
450
  #
467
451
  # @option params [required, String] :type
468
- # \[Required\] The authorizer type. Valid values are `TOKEN` for a
469
- # Lambda function using a single authorization token submitted in a
470
- # custom header, `REQUEST` for a Lambda function using incoming request
471
- # parameters, and `COGNITO_USER_POOLS` for using an Amazon Cognito user
472
- # pool.
452
+ # The authorizer type. Valid values are `TOKEN` for a Lambda function
453
+ # using a single authorization token submitted in a custom header,
454
+ # `REQUEST` for a Lambda function using incoming request parameters, and
455
+ # `COGNITO_USER_POOLS` for using an Amazon Cognito user pool.
473
456
  #
474
457
  # @option params [Array<String>] :provider_arns
475
458
  # A list of the Amazon Cognito user pool ARNs for the
@@ -501,27 +484,26 @@ module Aws::APIGateway
501
484
  # resource-based permissions on the Lambda function, specify null.
502
485
  #
503
486
  # @option params [String] :identity_source
504
- # The identity source for which authorization is requested. * For a
505
- # `TOKEN` or `COGNITO_USER_POOLS` authorizer, this is required
506
- # and specifies the request header mapping expression for the custom
507
- # header holding the authorization token submitted by the client. For
508
- # example, if the token header name is `Auth`, the header mapping
509
- # expression is `method.request.header.Auth`.
510
- # * For the `REQUEST` authorizer, this is required when authorization
511
- # caching is enabled. The value is a comma-separated string of one or
512
- # more mapping expressions of the specified request parameters. For
513
- # example, if an `Auth` header, a `Name` query string parameter are
514
- # defined as identity sources, this value is
515
- # `method.request.header.Auth, method.request.querystring.Name`. These
516
- # parameters will be used to derive the authorization caching key and
517
- # to perform runtime validation of the `REQUEST` authorizer by
518
- # verifying all of the identity-related request parameters are
519
- # present, not null and non-empty. Only when this is true does the
520
- # authorizer invoke the authorizer Lambda function, otherwise, it
521
- # returns a 401 Unauthorized response without calling the Lambda
522
- # function. The valid value is a string of comma-separated mapping
523
- # expressions of the specified request parameters. When the
524
- # authorization caching is not enabled, this property is optional.
487
+ # The identity source for which authorization is requested. For a
488
+ # `TOKEN` or `COGNITO_USER_POOLS` authorizer, this is required and
489
+ # specifies the request header mapping expression for the custom header
490
+ # holding the authorization token submitted by the client. For example,
491
+ # if the token header name is `Auth`, the header mapping expression is
492
+ # `method.request.header.Auth`. For the `REQUEST` authorizer, this is
493
+ # required when authorization caching is enabled. The value is a
494
+ # comma-separated string of one or more mapping expressions of the
495
+ # specified request parameters. For example, if an `Auth` header, a
496
+ # `Name` query string parameter are defined as identity sources, this
497
+ # value is `method.request.header.Auth,
498
+ # method.request.querystring.Name`. These parameters will be used to
499
+ # derive the authorization caching key and to perform runtime validation
500
+ # of the `REQUEST` authorizer by verifying all of the identity-related
501
+ # request parameters are present, not null and non-empty. Only when this
502
+ # is true does the authorizer invoke the authorizer Lambda function,
503
+ # otherwise, it returns a 401 Unauthorized response without calling the
504
+ # Lambda function. The valid value is a string of comma-separated
505
+ # mapping expressions of the specified request parameters. When the
506
+ # authorization caching is not enabled, this property is optional.
525
507
  #
526
508
  # @option params [String] :identity_validation_expression
527
509
  # A validation expression for the incoming identity token. For `TOKEN`
@@ -591,8 +573,7 @@ module Aws::APIGateway
591
573
  # Creates a new BasePathMapping resource.
592
574
  #
593
575
  # @option params [required, String] :domain_name
594
- # \[Required\] The domain name of the BasePathMapping resource to
595
- # create.
576
+ # The domain name of the BasePathMapping resource to create.
596
577
  #
597
578
  # @option params [String] :base_path
598
579
  # The base path name that callers of the API must provide as part of the
@@ -601,7 +582,7 @@ module Aws::APIGateway
601
582
  # callers to specify a base path name after the domain name.
602
583
  #
603
584
  # @option params [required, String] :rest_api_id
604
- # \[Required\] The string identifier of the associated RestApi.
585
+ # The string identifier of the associated RestApi.
605
586
  #
606
587
  # @option params [String] :stage
607
588
  # The name of the API's stage that you want to use for this mapping.
@@ -640,7 +621,7 @@ module Aws::APIGateway
640
621
  # callable over the internet.
641
622
  #
642
623
  # @option params [required, String] :rest_api_id
643
- # \[Required\] The string identifier of the associated RestApi.
624
+ # The string identifier of the associated RestApi.
644
625
  #
645
626
  # @option params [String] :stage_name
646
627
  # The name of the Stage resource for the Deployment resource to create.
@@ -718,18 +699,19 @@ module Aws::APIGateway
718
699
  req.send_request(options)
719
700
  end
720
701
 
702
+ # Creates a documentation part.
703
+ #
721
704
  # @option params [required, String] :rest_api_id
722
- # \[Required\] The string identifier of the associated RestApi.
705
+ # The string identifier of the associated RestApi.
723
706
  #
724
707
  # @option params [required, Types::DocumentationPartLocation] :location
725
- # \[Required\] The location of the targeted API entity of the
726
- # to-be-created documentation part.
708
+ # The location of the targeted API entity of the to-be-created
709
+ # documentation part.
727
710
  #
728
711
  # @option params [required, String] :properties
729
- # \[Required\] The new documentation content map of the targeted API
730
- # entity. Enclosed key-value pairs are API-specific, but only
731
- # OpenAPI-compliant key-value pairs can be exported and, hence,
732
- # published.
712
+ # The new documentation content map of the targeted API entity. Enclosed
713
+ # key-value pairs are API-specific, but only OpenAPI-compliant key-value
714
+ # pairs can be exported and, hence, published.
733
715
  #
734
716
  # @return [Types::DocumentationPart] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
735
717
  #
@@ -768,11 +750,13 @@ module Aws::APIGateway
768
750
  req.send_request(options)
769
751
  end
770
752
 
753
+ # Creates a documentation version
754
+ #
771
755
  # @option params [required, String] :rest_api_id
772
- # \[Required\] The string identifier of the associated RestApi.
756
+ # The string identifier of the associated RestApi.
773
757
  #
774
758
  # @option params [required, String] :documentation_version
775
- # \[Required\] The version identifier of the new snapshot.
759
+ # The version identifier of the new snapshot.
776
760
  #
777
761
  # @option params [String] :stage_name
778
762
  # The stage name to be associated with the new documentation snapshot.
@@ -811,7 +795,7 @@ module Aws::APIGateway
811
795
  # Creates a new domain name.
812
796
  #
813
797
  # @option params [required, String] :domain_name
814
- # \[Required\] The name of the DomainName resource.
798
+ # The name of the DomainName resource.
815
799
  #
816
800
  # @option params [String] :certificate_name
817
801
  # The user-friendly name of the certificate that will be used by
@@ -863,9 +847,10 @@ module Aws::APIGateway
863
847
  # DomainName. The valid values are `TLS_1_0` and `TLS_1_2`.
864
848
  #
865
849
  # @option params [Types::MutualTlsAuthenticationInput] :mutual_tls_authentication
850
+ # The mutual TLS authentication configuration for a custom domain name.
866
851
  # If specified, API Gateway performs two-way authentication between the
867
852
  # client and the server. Clients must present a trusted certificate to
868
- # access your custom domain name.
853
+ # access your API.
869
854
  #
870
855
  # @option params [String] :ownership_verification_certificate_arn
871
856
  # The ARN of the public certificate issued by ACM to validate ownership
@@ -956,25 +941,20 @@ module Aws::APIGateway
956
941
  # Adds a new Model resource to an existing RestApi resource.
957
942
  #
958
943
  # @option params [required, String] :rest_api_id
959
- # \[Required\] The RestApi identifier under which the Model will be
960
- # created.
944
+ # The RestApi identifier under which the Model will be created.
961
945
  #
962
946
  # @option params [required, String] :name
963
- # \[Required\] The name of the model. Must be alphanumeric.
947
+ # The name of the model. Must be alphanumeric.
964
948
  #
965
949
  # @option params [String] :description
966
950
  # The description of the model.
967
951
  #
968
952
  # @option params [String] :schema
969
953
  # The schema for the model. For `application/json` models, this should
970
- # be [JSON schema draft 4][1] model.
971
- #
972
- #
973
- #
974
- # [1]: https://tools.ietf.org/html/draft-zyp-json-schema-04
954
+ # be JSON schema draft 4 model.
975
955
  #
976
956
  # @option params [required, String] :content_type
977
- # \[Required\] The content-type for the model.
957
+ # The content-type for the model.
978
958
  #
979
959
  # @return [Types::Model] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
980
960
  #
@@ -1009,10 +989,10 @@ module Aws::APIGateway
1009
989
  req.send_request(options)
1010
990
  end
1011
991
 
1012
- # Creates a ReqeustValidator of a given RestApi.
992
+ # Creates a RequestValidator of a given RestApi.
1013
993
  #
1014
994
  # @option params [required, String] :rest_api_id
1015
- # \[Required\] The string identifier of the associated RestApi.
995
+ # The string identifier of the associated RestApi.
1016
996
  #
1017
997
  # @option params [String] :name
1018
998
  # The name of the to-be-created RequestValidator.
@@ -1059,10 +1039,10 @@ module Aws::APIGateway
1059
1039
  # Creates a Resource resource.
1060
1040
  #
1061
1041
  # @option params [required, String] :rest_api_id
1062
- # \[Required\] The string identifier of the associated RestApi.
1042
+ # The string identifier of the associated RestApi.
1063
1043
  #
1064
1044
  # @option params [required, String] :parent_id
1065
- # \[Required\] The parent resource's identifier.
1045
+ # The parent resource's identifier.
1066
1046
  #
1067
1047
  # @option params [required, String] :path_part
1068
1048
  # The last path segment for this resource.
@@ -1144,7 +1124,7 @@ module Aws::APIGateway
1144
1124
  # Creates a new RestApi resource.
1145
1125
  #
1146
1126
  # @option params [required, String] :name
1147
- # \[Required\] The name of the RestApi.
1127
+ # The name of the RestApi.
1148
1128
  #
1149
1129
  # @option params [String] :description
1150
1130
  # The description of the RestApi.
@@ -1169,18 +1149,17 @@ module Aws::APIGateway
1169
1149
  #
1170
1150
  # @option params [String] :api_key_source
1171
1151
  # The source of the API key for metering requests according to a usage
1172
- # plan. Valid values are: * `HEADER` to read the API key from the
1173
- # `X-API-Key` header of a
1174
- # request.
1175
- # * `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from
1176
- # a custom authorizer.
1152
+ # plan. Valid values are: &gt;`HEADER` to read the API key from the
1153
+ # `X-API-Key` header of a request. `AUTHORIZER` to read the API key from
1154
+ # the `UsageIdentifierKey` from a custom authorizer.
1177
1155
  #
1178
1156
  # @option params [Types::EndpointConfiguration] :endpoint_configuration
1179
1157
  # The endpoint configuration of this RestApi showing the endpoint types
1180
1158
  # of the API.
1181
1159
  #
1182
1160
  # @option params [String] :policy
1183
- # A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
1161
+ # A stringified JSON policy document that applies to this RestApi
1162
+ # regardless of the caller and Method configuration.
1184
1163
  #
1185
1164
  # @option params [Hash<String,String>] :tags
1186
1165
  # The key-value map of strings. The valid character set is
@@ -1190,10 +1169,9 @@ module Aws::APIGateway
1190
1169
  # @option params [Boolean] :disable_execute_api_endpoint
1191
1170
  # Specifies whether clients can invoke your API by using the default
1192
1171
  # `execute-api` endpoint. By default, clients can invoke your API with
1193
- # the default
1194
- # https://\\\{api\_id\\}.execute-api.\\\{region\\}.amazonaws.com
1172
+ # the default `https://\{api_id\}.execute-api.\{region\}.amazonaws.com`
1195
1173
  # endpoint. To require that clients use a custom domain name to invoke
1196
- # your API, disable the default endpoint.
1174
+ # your API, disable the default endpoint
1197
1175
  #
1198
1176
  # @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1199
1177
  #
@@ -1265,16 +1243,15 @@ module Aws::APIGateway
1265
1243
  # for the API.
1266
1244
  #
1267
1245
  # @option params [required, String] :rest_api_id
1268
- # \[Required\] The string identifier of the associated RestApi.
1246
+ # The string identifier of the associated RestApi.
1269
1247
  #
1270
1248
  # @option params [required, String] :stage_name
1271
- # \[Required\] The name for the Stage resource. Stage names can only
1272
- # contain alphanumeric characters, hyphens, and underscores. Maximum
1273
- # length is 128 characters.
1249
+ # The name for the Stage resource. Stage names can only contain
1250
+ # alphanumeric characters, hyphens, and underscores. Maximum length is
1251
+ # 128 characters.
1274
1252
  #
1275
1253
  # @option params [required, String] :deployment_id
1276
- # \[Required\] The identifier of the Deployment resource for the Stage
1277
- # resource.
1254
+ # The identifier of the Deployment resource for the Stage resource.
1278
1255
  #
1279
1256
  # @option params [String] :description
1280
1257
  # The description of the Stage resource.
@@ -1399,7 +1376,7 @@ module Aws::APIGateway
1399
1376
  # the associated API stages, specified in the payload.
1400
1377
  #
1401
1378
  # @option params [required, String] :name
1402
- # \[Required\] The name of the usage plan.
1379
+ # The name of the usage plan.
1403
1380
  #
1404
1381
  # @option params [String] :description
1405
1382
  # The description of the usage plan.
@@ -1491,16 +1468,15 @@ module Aws::APIGateway
1491
1468
  # plan.
1492
1469
  #
1493
1470
  # @option params [required, String] :usage_plan_id
1494
- # \[Required\] The Id of the UsagePlan resource representing the usage
1495
- # plan containing the to-be-created UsagePlanKey resource representing a
1496
- # plan customer.
1471
+ # The Id of the UsagePlan resource representing the usage plan
1472
+ # containing the to-be-created UsagePlanKey resource representing a plan
1473
+ # customer.
1497
1474
  #
1498
1475
  # @option params [required, String] :key_id
1499
- # \[Required\] The identifier of a UsagePlanKey resource for a plan
1500
- # customer.
1476
+ # The identifier of a UsagePlanKey resource for a plan customer.
1501
1477
  #
1502
1478
  # @option params [required, String] :key_type
1503
- # \[Required\] The type of a UsagePlanKey resource for a plan customer.
1479
+ # The type of a UsagePlanKey resource for a plan customer.
1504
1480
  #
1505
1481
  # @return [Types::UsagePlanKey] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1506
1482
  #
@@ -1537,15 +1513,15 @@ module Aws::APIGateway
1537
1513
  # create and update VPC Endpoint services.
1538
1514
  #
1539
1515
  # @option params [required, String] :name
1540
- # \[Required\] The name used to label and identify the VPC link.
1516
+ # The name used to label and identify the VPC link.
1541
1517
  #
1542
1518
  # @option params [String] :description
1543
1519
  # The description of the VPC link.
1544
1520
  #
1545
1521
  # @option params [required, Array<String>] :target_arns
1546
- # \[Required\] The ARN of the network load balancer of the VPC targeted
1547
- # by the VPC link. The network load balancer must be owned by the same
1548
- # AWS account of the API owner.
1522
+ # The ARN of the network load balancer of the VPC targeted by the VPC
1523
+ # link. The network load balancer must be owned by the same AWS account
1524
+ # of the API owner.
1549
1525
  #
1550
1526
  # @option params [Hash<String,String>] :tags
1551
1527
  # The key-value map of strings. The valid character set is
@@ -1595,7 +1571,7 @@ module Aws::APIGateway
1595
1571
  # Deletes the ApiKey resource.
1596
1572
  #
1597
1573
  # @option params [required, String] :api_key
1598
- # \[Required\] The identifier of the ApiKey resource to be deleted.
1574
+ # The identifier of the ApiKey resource to be deleted.
1599
1575
  #
1600
1576
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1601
1577
  #
@@ -1614,19 +1590,11 @@ module Aws::APIGateway
1614
1590
 
1615
1591
  # Deletes an existing Authorizer resource.
1616
1592
  #
1617
- # <div class="seeAlso" markdown="1">
1618
- # [AWS CLI][1]
1619
- # </div>
1620
- #
1621
- #
1622
- #
1623
- # [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html
1624
- #
1625
1593
  # @option params [required, String] :rest_api_id
1626
- # \[Required\] The string identifier of the associated RestApi.
1594
+ # The string identifier of the associated RestApi.
1627
1595
  #
1628
1596
  # @option params [required, String] :authorizer_id
1629
- # \[Required\] The identifier of the Authorizer resource.
1597
+ # The identifier of the Authorizer resource.
1630
1598
  #
1631
1599
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1632
1600
  #
@@ -1647,12 +1615,10 @@ module Aws::APIGateway
1647
1615
  # Deletes the BasePathMapping resource.
1648
1616
  #
1649
1617
  # @option params [required, String] :domain_name
1650
- # \[Required\] The domain name of the BasePathMapping resource to
1651
- # delete.
1618
+ # The domain name of the BasePathMapping resource to delete.
1652
1619
  #
1653
1620
  # @option params [required, String] :base_path
1654
- # \[Required\] The base path name of the BasePathMapping resource to
1655
- # delete.
1621
+ # The base path name of the BasePathMapping resource to delete.
1656
1622
  #
1657
1623
  # To specify an empty base path, set this parameter to `'(none)'`.
1658
1624
  #
@@ -1675,8 +1641,7 @@ module Aws::APIGateway
1675
1641
  # Deletes the ClientCertificate resource.
1676
1642
  #
1677
1643
  # @option params [required, String] :client_certificate_id
1678
- # \[Required\] The identifier of the ClientCertificate resource to be
1679
- # deleted.
1644
+ # The identifier of the ClientCertificate resource to be deleted.
1680
1645
  #
1681
1646
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1682
1647
  #
@@ -1697,10 +1662,10 @@ module Aws::APIGateway
1697
1662
  # if there are no Stage resources associated with it.
1698
1663
  #
1699
1664
  # @option params [required, String] :rest_api_id
1700
- # \[Required\] The string identifier of the associated RestApi.
1665
+ # The string identifier of the associated RestApi.
1701
1666
  #
1702
1667
  # @option params [required, String] :deployment_id
1703
- # \[Required\] The identifier of the Deployment resource to delete.
1668
+ # The identifier of the Deployment resource to delete.
1704
1669
  #
1705
1670
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1706
1671
  #
@@ -1718,11 +1683,13 @@ module Aws::APIGateway
1718
1683
  req.send_request(options)
1719
1684
  end
1720
1685
 
1686
+ # Deletes a documentation part
1687
+ #
1721
1688
  # @option params [required, String] :rest_api_id
1722
- # \[Required\] The string identifier of the associated RestApi.
1689
+ # The string identifier of the associated RestApi.
1723
1690
  #
1724
1691
  # @option params [required, String] :documentation_part_id
1725
- # \[Required\] The identifier of the to-be-deleted documentation part.
1692
+ # The identifier of the to-be-deleted documentation part.
1726
1693
  #
1727
1694
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1728
1695
  #
@@ -1740,12 +1707,13 @@ module Aws::APIGateway
1740
1707
  req.send_request(options)
1741
1708
  end
1742
1709
 
1710
+ # Deletes a documentation version.
1711
+ #
1743
1712
  # @option params [required, String] :rest_api_id
1744
- # \[Required\] The string identifier of the associated RestApi.
1713
+ # The string identifier of the associated RestApi.
1745
1714
  #
1746
1715
  # @option params [required, String] :documentation_version
1747
- # \[Required\] The version identifier of a to-be-deleted documentation
1748
- # snapshot.
1716
+ # The version identifier of a to-be-deleted documentation snapshot.
1749
1717
  #
1750
1718
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1751
1719
  #
@@ -1766,7 +1734,7 @@ module Aws::APIGateway
1766
1734
  # Deletes the DomainName resource.
1767
1735
  #
1768
1736
  # @option params [required, String] :domain_name
1769
- # \[Required\] The name of the DomainName resource to be deleted.
1737
+ # The name of the DomainName resource to be deleted.
1770
1738
  #
1771
1739
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1772
1740
  #
@@ -1787,10 +1755,10 @@ module Aws::APIGateway
1787
1755
  # type on the given RestApi and resets it with the default settings.
1788
1756
  #
1789
1757
  # @option params [required, String] :rest_api_id
1790
- # \[Required\] The string identifier of the associated RestApi.
1758
+ # The string identifier of the associated RestApi.
1791
1759
  #
1792
1760
  # @option params [required, String] :response_type
1793
- # \[Required\] The response type of the associated GatewayResponse.
1761
+ # The response type of the associated GatewayResponse.
1794
1762
  #
1795
1763
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1796
1764
  #
@@ -1811,14 +1779,13 @@ module Aws::APIGateway
1811
1779
  # Represents a delete integration.
1812
1780
  #
1813
1781
  # @option params [required, String] :rest_api_id
1814
- # \[Required\] The string identifier of the associated RestApi.
1782
+ # The string identifier of the associated RestApi.
1815
1783
  #
1816
1784
  # @option params [required, String] :resource_id
1817
- # \[Required\] Specifies a delete integration request's resource
1818
- # identifier.
1785
+ # Specifies a delete integration request's resource identifier.
1819
1786
  #
1820
1787
  # @option params [required, String] :http_method
1821
- # \[Required\] Specifies a delete integration request's HTTP method.
1788
+ # Specifies a delete integration request's HTTP method.
1822
1789
  #
1823
1790
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1824
1791
  #
@@ -1840,19 +1807,17 @@ module Aws::APIGateway
1840
1807
  # Represents a delete integration response.
1841
1808
  #
1842
1809
  # @option params [required, String] :rest_api_id
1843
- # \[Required\] The string identifier of the associated RestApi.
1810
+ # The string identifier of the associated RestApi.
1844
1811
  #
1845
1812
  # @option params [required, String] :resource_id
1846
- # \[Required\] Specifies a delete integration response request's
1847
- # resource identifier.
1813
+ # Specifies a delete integration response request's resource
1814
+ # identifier.
1848
1815
  #
1849
1816
  # @option params [required, String] :http_method
1850
- # \[Required\] Specifies a delete integration response request's HTTP
1851
- # method.
1817
+ # Specifies a delete integration response request's HTTP method.
1852
1818
  #
1853
1819
  # @option params [required, String] :status_code
1854
- # \[Required\] Specifies a delete integration response request's status
1855
- # code.
1820
+ # Specifies a delete integration response request's status code.
1856
1821
  #
1857
1822
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1858
1823
  #
@@ -1875,13 +1840,13 @@ module Aws::APIGateway
1875
1840
  # Deletes an existing Method resource.
1876
1841
  #
1877
1842
  # @option params [required, String] :rest_api_id
1878
- # \[Required\] The string identifier of the associated RestApi.
1843
+ # The string identifier of the associated RestApi.
1879
1844
  #
1880
1845
  # @option params [required, String] :resource_id
1881
- # \[Required\] The Resource identifier for the Method resource.
1846
+ # The Resource identifier for the Method resource.
1882
1847
  #
1883
1848
  # @option params [required, String] :http_method
1884
- # \[Required\] The HTTP verb of the Method resource.
1849
+ # The HTTP verb of the Method resource.
1885
1850
  #
1886
1851
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1887
1852
  #
@@ -1903,17 +1868,16 @@ module Aws::APIGateway
1903
1868
  # Deletes an existing MethodResponse resource.
1904
1869
  #
1905
1870
  # @option params [required, String] :rest_api_id
1906
- # \[Required\] The string identifier of the associated RestApi.
1871
+ # The string identifier of the associated RestApi.
1907
1872
  #
1908
1873
  # @option params [required, String] :resource_id
1909
- # \[Required\] The Resource identifier for the MethodResponse resource.
1874
+ # The Resource identifier for the MethodResponse resource.
1910
1875
  #
1911
1876
  # @option params [required, String] :http_method
1912
- # \[Required\] The HTTP verb of the Method resource.
1877
+ # The HTTP verb of the Method resource.
1913
1878
  #
1914
1879
  # @option params [required, String] :status_code
1915
- # \[Required\] The status code identifier for the MethodResponse
1916
- # resource.
1880
+ # The status code identifier for the MethodResponse resource.
1917
1881
  #
1918
1882
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1919
1883
  #
@@ -1936,10 +1900,10 @@ module Aws::APIGateway
1936
1900
  # Deletes a model.
1937
1901
  #
1938
1902
  # @option params [required, String] :rest_api_id
1939
- # \[Required\] The string identifier of the associated RestApi.
1903
+ # The string identifier of the associated RestApi.
1940
1904
  #
1941
1905
  # @option params [required, String] :model_name
1942
- # \[Required\] The name of the model to delete.
1906
+ # The name of the model to delete.
1943
1907
  #
1944
1908
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1945
1909
  #
@@ -1960,10 +1924,10 @@ module Aws::APIGateway
1960
1924
  # Deletes a RequestValidator of a given RestApi.
1961
1925
  #
1962
1926
  # @option params [required, String] :rest_api_id
1963
- # \[Required\] The string identifier of the associated RestApi.
1927
+ # The string identifier of the associated RestApi.
1964
1928
  #
1965
1929
  # @option params [required, String] :request_validator_id
1966
- # \[Required\] The identifier of the RequestValidator to be deleted.
1930
+ # The identifier of the RequestValidator to be deleted.
1967
1931
  #
1968
1932
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1969
1933
  #
@@ -1984,10 +1948,10 @@ module Aws::APIGateway
1984
1948
  # Deletes a Resource resource.
1985
1949
  #
1986
1950
  # @option params [required, String] :rest_api_id
1987
- # \[Required\] The string identifier of the associated RestApi.
1951
+ # The string identifier of the associated RestApi.
1988
1952
  #
1989
1953
  # @option params [required, String] :resource_id
1990
- # \[Required\] The identifier of the Resource resource.
1954
+ # The identifier of the Resource resource.
1991
1955
  #
1992
1956
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1993
1957
  #
@@ -2008,7 +1972,7 @@ module Aws::APIGateway
2008
1972
  # Deletes the specified API.
2009
1973
  #
2010
1974
  # @option params [required, String] :rest_api_id
2011
- # \[Required\] The string identifier of the associated RestApi.
1975
+ # The string identifier of the associated RestApi.
2012
1976
  #
2013
1977
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2014
1978
  #
@@ -2028,10 +1992,10 @@ module Aws::APIGateway
2028
1992
  # Deletes a Stage resource.
2029
1993
  #
2030
1994
  # @option params [required, String] :rest_api_id
2031
- # \[Required\] The string identifier of the associated RestApi.
1995
+ # The string identifier of the associated RestApi.
2032
1996
  #
2033
1997
  # @option params [required, String] :stage_name
2034
- # \[Required\] The name of the Stage resource to delete.
1998
+ # The name of the Stage resource to delete.
2035
1999
  #
2036
2000
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2037
2001
  #
@@ -2052,7 +2016,7 @@ module Aws::APIGateway
2052
2016
  # Deletes a usage plan of a given plan Id.
2053
2017
  #
2054
2018
  # @option params [required, String] :usage_plan_id
2055
- # \[Required\] The Id of the to-be-deleted usage plan.
2019
+ # The Id of the to-be-deleted usage plan.
2056
2020
  #
2057
2021
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2058
2022
  #
@@ -2073,12 +2037,12 @@ module Aws::APIGateway
2073
2037
  # associated usage plan.
2074
2038
  #
2075
2039
  # @option params [required, String] :usage_plan_id
2076
- # \[Required\] The Id of the UsagePlan resource representing the usage
2077
- # plan containing the to-be-deleted UsagePlanKey resource representing a
2078
- # plan customer.
2040
+ # The Id of the UsagePlan resource representing the usage plan
2041
+ # containing the to-be-deleted UsagePlanKey resource representing a plan
2042
+ # customer.
2079
2043
  #
2080
2044
  # @option params [required, String] :key_id
2081
- # \[Required\] The Id of the UsagePlanKey resource to be deleted.
2045
+ # The Id of the UsagePlanKey resource to be deleted.
2082
2046
  #
2083
2047
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2084
2048
  #
@@ -2099,8 +2063,8 @@ module Aws::APIGateway
2099
2063
  # Deletes an existing VpcLink of a specified identifier.
2100
2064
  #
2101
2065
  # @option params [required, String] :vpc_link_id
2102
- # \[Required\] The identifier of the VpcLink. It is used in an
2103
- # Integration to reference this VpcLink.
2066
+ # The identifier of the VpcLink. It is used in an Integration to
2067
+ # reference this VpcLink.
2104
2068
  #
2105
2069
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2106
2070
  #
@@ -2144,10 +2108,10 @@ module Aws::APIGateway
2144
2108
  # Flushes a stage's cache.
2145
2109
  #
2146
2110
  # @option params [required, String] :rest_api_id
2147
- # \[Required\] The string identifier of the associated RestApi.
2111
+ # The string identifier of the associated RestApi.
2148
2112
  #
2149
2113
  # @option params [required, String] :stage_name
2150
- # \[Required\] The name of the stage to flush its cache.
2114
+ # The name of the stage to flush its cache.
2151
2115
  #
2152
2116
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2153
2117
  #
@@ -2238,7 +2202,7 @@ module Aws::APIGateway
2238
2202
  # Gets information about the current ApiKey resource.
2239
2203
  #
2240
2204
  # @option params [required, String] :api_key
2241
- # \[Required\] The identifier of the ApiKey resource.
2205
+ # The identifier of the ApiKey resource.
2242
2206
  #
2243
2207
  # @option params [Boolean] :include_value
2244
2208
  # A boolean flag to specify whether (`true`) or not (`false`) the result
@@ -2352,19 +2316,11 @@ module Aws::APIGateway
2352
2316
 
2353
2317
  # Describe an existing Authorizer resource.
2354
2318
  #
2355
- # <div class="seeAlso" markdown="1">
2356
- # [AWS CLI][1]
2357
- # </div>
2358
- #
2359
- #
2360
- #
2361
- # [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html
2362
- #
2363
2319
  # @option params [required, String] :rest_api_id
2364
- # \[Required\] The string identifier of the associated RestApi.
2320
+ # The string identifier of the associated RestApi.
2365
2321
  #
2366
2322
  # @option params [required, String] :authorizer_id
2367
- # \[Required\] The identifier of the Authorizer resource.
2323
+ # The identifier of the Authorizer resource.
2368
2324
  #
2369
2325
  # @return [Types::Authorizer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2370
2326
  #
@@ -2409,16 +2365,8 @@ module Aws::APIGateway
2409
2365
 
2410
2366
  # Describe an existing Authorizers resource.
2411
2367
  #
2412
- # <div class="seeAlso" markdown="1">
2413
- # [AWS CLI][1]
2414
- # </div>
2415
- #
2416
- #
2417
- #
2418
- # [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html
2419
- #
2420
2368
  # @option params [required, String] :rest_api_id
2421
- # \[Required\] The string identifier of the associated RestApi.
2369
+ # The string identifier of the associated RestApi.
2422
2370
  #
2423
2371
  # @option params [String] :position
2424
2372
  # The current pagination position in the paged result set.
@@ -2466,15 +2414,13 @@ module Aws::APIGateway
2466
2414
  # Describe a BasePathMapping resource.
2467
2415
  #
2468
2416
  # @option params [required, String] :domain_name
2469
- # \[Required\] The domain name of the BasePathMapping resource to be
2470
- # described.
2417
+ # The domain name of the BasePathMapping resource to be described.
2471
2418
  #
2472
2419
  # @option params [required, String] :base_path
2473
- # \[Required\] The base path name that callers of the API must provide
2474
- # as part of the URL after the domain name. This value must be unique
2475
- # for all of the mappings across a single API. Specify '(none)' if you
2476
- # do not want callers to specify any base path name after the domain
2477
- # name.
2420
+ # The base path name that callers of the API must provide as part of the
2421
+ # URL after the domain name. This value must be unique for all of the
2422
+ # mappings across a single API. Specify '(none)' if you do not want
2423
+ # callers to specify any base path name after the domain name.
2478
2424
  #
2479
2425
  # @return [Types::BasePathMapping] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2480
2426
  #
@@ -2505,7 +2451,7 @@ module Aws::APIGateway
2505
2451
  # Represents a collection of BasePathMapping resources.
2506
2452
  #
2507
2453
  # @option params [required, String] :domain_name
2508
- # \[Required\] The domain name of a BasePathMapping resource.
2454
+ # The domain name of a BasePathMapping resource.
2509
2455
  #
2510
2456
  # @option params [String] :position
2511
2457
  # The current pagination position in the paged result set.
@@ -2547,8 +2493,7 @@ module Aws::APIGateway
2547
2493
  # Gets information about the current ClientCertificate resource.
2548
2494
  #
2549
2495
  # @option params [required, String] :client_certificate_id
2550
- # \[Required\] The identifier of the ClientCertificate resource to be
2551
- # described.
2496
+ # The identifier of the ClientCertificate resource to be described.
2552
2497
  #
2553
2498
  # @return [Types::ClientCertificate] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2554
2499
  #
@@ -2627,11 +2572,10 @@ module Aws::APIGateway
2627
2572
  # Gets information about a Deployment resource.
2628
2573
  #
2629
2574
  # @option params [required, String] :rest_api_id
2630
- # \[Required\] The string identifier of the associated RestApi.
2575
+ # The string identifier of the associated RestApi.
2631
2576
  #
2632
2577
  # @option params [required, String] :deployment_id
2633
- # \[Required\] The identifier of the Deployment resource to get
2634
- # information about.
2578
+ # The identifier of the Deployment resource to get information about.
2635
2579
  #
2636
2580
  # @option params [Array<String>] :embed
2637
2581
  # A query parameter to retrieve the specified embedded resources of the
@@ -2681,7 +2625,7 @@ module Aws::APIGateway
2681
2625
  # Gets information about a Deployments collection.
2682
2626
  #
2683
2627
  # @option params [required, String] :rest_api_id
2684
- # \[Required\] The string identifier of the associated RestApi.
2628
+ # The string identifier of the associated RestApi.
2685
2629
  #
2686
2630
  # @option params [String] :position
2687
2631
  # The current pagination position in the paged result set.
@@ -2724,11 +2668,13 @@ module Aws::APIGateway
2724
2668
  req.send_request(options)
2725
2669
  end
2726
2670
 
2671
+ # Gets a documentation part.
2672
+ #
2727
2673
  # @option params [required, String] :rest_api_id
2728
- # \[Required\] The string identifier of the associated RestApi.
2674
+ # The string identifier of the associated RestApi.
2729
2675
  #
2730
2676
  # @option params [required, String] :documentation_part_id
2731
- # \[Required\] The string identifier of the associated RestApi.
2677
+ # The string identifier of the associated RestApi.
2732
2678
  #
2733
2679
  # @return [Types::DocumentationPart] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2734
2680
  #
@@ -2760,8 +2706,10 @@ module Aws::APIGateway
2760
2706
  req.send_request(options)
2761
2707
  end
2762
2708
 
2709
+ # Gets documentation parts.
2710
+ #
2763
2711
  # @option params [required, String] :rest_api_id
2764
- # \[Required\] The string identifier of the associated RestApi.
2712
+ # The string identifier of the associated RestApi.
2765
2713
  #
2766
2714
  # @option params [String] :type
2767
2715
  # The type of API entities of the to-be-retrieved documentation parts.
@@ -2821,12 +2769,13 @@ module Aws::APIGateway
2821
2769
  req.send_request(options)
2822
2770
  end
2823
2771
 
2772
+ # Gets a documentation version.
2773
+ #
2824
2774
  # @option params [required, String] :rest_api_id
2825
- # \[Required\] The string identifier of the associated RestApi.
2775
+ # The string identifier of the associated RestApi.
2826
2776
  #
2827
2777
  # @option params [required, String] :documentation_version
2828
- # \[Required\] The version identifier of the to-be-retrieved
2829
- # documentation snapshot.
2778
+ # The version identifier of the to-be-retrieved documentation snapshot.
2830
2779
  #
2831
2780
  # @return [Types::DocumentationVersion] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2832
2781
  #
@@ -2854,8 +2803,10 @@ module Aws::APIGateway
2854
2803
  req.send_request(options)
2855
2804
  end
2856
2805
 
2806
+ # Gets documentation versions.
2807
+ #
2857
2808
  # @option params [required, String] :rest_api_id
2858
- # \[Required\] The string identifier of the associated RestApi.
2809
+ # The string identifier of the associated RestApi.
2859
2810
  #
2860
2811
  # @option params [String] :position
2861
2812
  # The current pagination position in the paged result set.
@@ -2896,7 +2847,7 @@ module Aws::APIGateway
2896
2847
  # intuitive URL that can be called.
2897
2848
  #
2898
2849
  # @option params [required, String] :domain_name
2899
- # \[Required\] The name of the DomainName resource.
2850
+ # The name of the DomainName resource.
2900
2851
  #
2901
2852
  # @return [Types::DomainName] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2902
2853
  #
@@ -3020,14 +2971,14 @@ module Aws::APIGateway
3020
2971
  # Exports a deployed version of a RestApi in a specified format.
3021
2972
  #
3022
2973
  # @option params [required, String] :rest_api_id
3023
- # \[Required\] The string identifier of the associated RestApi.
2974
+ # The string identifier of the associated RestApi.
3024
2975
  #
3025
2976
  # @option params [required, String] :stage_name
3026
- # \[Required\] The name of the Stage that will be exported.
2977
+ # The name of the Stage that will be exported.
3027
2978
  #
3028
2979
  # @option params [required, String] :export_type
3029
- # \[Required\] The type of export. Acceptable values are 'oas30' for
3030
- # OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
2980
+ # The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x
2981
+ # and 'swagger' for Swagger/OpenAPI 2.0.
3031
2982
  #
3032
2983
  # @option params [Hash<String,String>] :parameters
3033
2984
  # A key-value map of query string parameters that specify properties of
@@ -3080,10 +3031,10 @@ module Aws::APIGateway
3080
3031
  # RestApi.
3081
3032
  #
3082
3033
  # @option params [required, String] :rest_api_id
3083
- # \[Required\] The string identifier of the associated RestApi.
3034
+ # The string identifier of the associated RestApi.
3084
3035
  #
3085
3036
  # @option params [required, String] :response_type
3086
- # \[Required\] The response type of the associated GatewayResponse.
3037
+ # The response type of the associated GatewayResponse.
3087
3038
  #
3088
3039
  # @return [Types::GatewayResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3089
3040
  #
@@ -3123,7 +3074,7 @@ module Aws::APIGateway
3123
3074
  # collection for the supported response types.
3124
3075
  #
3125
3076
  # @option params [required, String] :rest_api_id
3126
- # \[Required\] The string identifier of the associated RestApi.
3077
+ # The string identifier of the associated RestApi.
3127
3078
  #
3128
3079
  # @option params [String] :position
3129
3080
  # The current pagination position in the paged result set. The
@@ -3170,14 +3121,13 @@ module Aws::APIGateway
3170
3121
  # Get the integration settings.
3171
3122
  #
3172
3123
  # @option params [required, String] :rest_api_id
3173
- # \[Required\] The string identifier of the associated RestApi.
3124
+ # The string identifier of the associated RestApi.
3174
3125
  #
3175
3126
  # @option params [required, String] :resource_id
3176
- # \[Required\] Specifies a get integration request's resource
3177
- # identifier
3127
+ # Specifies a get integration request's resource identifier
3178
3128
  #
3179
3129
  # @option params [required, String] :http_method
3180
- # \[Required\] Specifies a get integration request's HTTP method.
3130
+ # Specifies a get integration request's HTTP method.
3181
3131
  #
3182
3132
  # @return [Types::Integration] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3183
3133
  #
@@ -3243,19 +3193,16 @@ module Aws::APIGateway
3243
3193
  # Represents a get integration response.
3244
3194
  #
3245
3195
  # @option params [required, String] :rest_api_id
3246
- # \[Required\] The string identifier of the associated RestApi.
3196
+ # The string identifier of the associated RestApi.
3247
3197
  #
3248
3198
  # @option params [required, String] :resource_id
3249
- # \[Required\] Specifies a get integration response request's resource
3250
- # identifier.
3199
+ # Specifies a get integration response request's resource identifier.
3251
3200
  #
3252
3201
  # @option params [required, String] :http_method
3253
- # \[Required\] Specifies a get integration response request's HTTP
3254
- # method.
3202
+ # Specifies a get integration response request's HTTP method.
3255
3203
  #
3256
3204
  # @option params [required, String] :status_code
3257
- # \[Required\] Specifies a get integration response request's status
3258
- # code.
3205
+ # Specifies a get integration response request's status code.
3259
3206
  #
3260
3207
  # @return [Types::IntegrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3261
3208
  #
@@ -3294,13 +3241,13 @@ module Aws::APIGateway
3294
3241
  # Describe an existing Method resource.
3295
3242
  #
3296
3243
  # @option params [required, String] :rest_api_id
3297
- # \[Required\] The string identifier of the associated RestApi.
3244
+ # The string identifier of the associated RestApi.
3298
3245
  #
3299
3246
  # @option params [required, String] :resource_id
3300
- # \[Required\] The Resource identifier for the Method resource.
3247
+ # The Resource identifier for the Method resource.
3301
3248
  #
3302
3249
  # @option params [required, String] :http_method
3303
- # \[Required\] Specifies the method request's HTTP method type.
3250
+ # Specifies the method request's HTTP method type.
3304
3251
  #
3305
3252
  # @return [Types::Method] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3306
3253
  #
@@ -3380,16 +3327,16 @@ module Aws::APIGateway
3380
3327
  # Describes a MethodResponse resource.
3381
3328
  #
3382
3329
  # @option params [required, String] :rest_api_id
3383
- # \[Required\] The string identifier of the associated RestApi.
3330
+ # The string identifier of the associated RestApi.
3384
3331
  #
3385
3332
  # @option params [required, String] :resource_id
3386
- # \[Required\] The Resource identifier for the MethodResponse resource.
3333
+ # The Resource identifier for the MethodResponse resource.
3387
3334
  #
3388
3335
  # @option params [required, String] :http_method
3389
- # \[Required\] The HTTP verb of the Method resource.
3336
+ # The HTTP verb of the Method resource.
3390
3337
  #
3391
3338
  # @option params [required, String] :status_code
3392
- # \[Required\] The status code for the MethodResponse resource.
3339
+ # The status code for the MethodResponse resource.
3393
3340
  #
3394
3341
  # @return [Types::MethodResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3395
3342
  #
@@ -3424,10 +3371,10 @@ module Aws::APIGateway
3424
3371
  # Describes an existing model defined for a RestApi resource.
3425
3372
  #
3426
3373
  # @option params [required, String] :rest_api_id
3427
- # \[Required\] The RestApi identifier under which the Model exists.
3374
+ # The RestApi identifier under which the Model exists.
3428
3375
  #
3429
3376
  # @option params [required, String] :model_name
3430
- # \[Required\] The name of the model as an identifier.
3377
+ # The name of the model as an identifier.
3431
3378
  #
3432
3379
  # @option params [Boolean] :flatten
3433
3380
  # A query parameter of a Boolean value to resolve (`true`) all external
@@ -3469,10 +3416,10 @@ module Aws::APIGateway
3469
3416
  # payload into the structure of a model.
3470
3417
  #
3471
3418
  # @option params [required, String] :rest_api_id
3472
- # \[Required\] The string identifier of the associated RestApi.
3419
+ # The string identifier of the associated RestApi.
3473
3420
  #
3474
3421
  # @option params [required, String] :model_name
3475
- # \[Required\] The name of the model for which to generate a template.
3422
+ # The name of the model for which to generate a template.
3476
3423
  #
3477
3424
  # @return [Types::Template] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3478
3425
  #
@@ -3499,7 +3446,7 @@ module Aws::APIGateway
3499
3446
  # Describes existing Models defined for a RestApi resource.
3500
3447
  #
3501
3448
  # @option params [required, String] :rest_api_id
3502
- # \[Required\] The string identifier of the associated RestApi.
3449
+ # The string identifier of the associated RestApi.
3503
3450
  #
3504
3451
  # @option params [String] :position
3505
3452
  # The current pagination position in the paged result set.
@@ -3543,10 +3490,10 @@ module Aws::APIGateway
3543
3490
  # Gets a RequestValidator of a given RestApi.
3544
3491
  #
3545
3492
  # @option params [required, String] :rest_api_id
3546
- # \[Required\] The string identifier of the associated RestApi.
3493
+ # The string identifier of the associated RestApi.
3547
3494
  #
3548
3495
  # @option params [required, String] :request_validator_id
3549
- # \[Required\] The identifier of the RequestValidator to be retrieved.
3496
+ # The identifier of the RequestValidator to be retrieved.
3550
3497
  #
3551
3498
  # @return [Types::RequestValidator] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3552
3499
  #
@@ -3579,7 +3526,7 @@ module Aws::APIGateway
3579
3526
  # Gets the RequestValidators collection of a given RestApi.
3580
3527
  #
3581
3528
  # @option params [required, String] :rest_api_id
3582
- # \[Required\] The string identifier of the associated RestApi.
3529
+ # The string identifier of the associated RestApi.
3583
3530
  #
3584
3531
  # @option params [String] :position
3585
3532
  # The current pagination position in the paged result set.
@@ -3620,10 +3567,10 @@ module Aws::APIGateway
3620
3567
  # Lists information about a resource.
3621
3568
  #
3622
3569
  # @option params [required, String] :rest_api_id
3623
- # \[Required\] The string identifier of the associated RestApi.
3570
+ # The string identifier of the associated RestApi.
3624
3571
  #
3625
3572
  # @option params [required, String] :resource_id
3626
- # \[Required\] The identifier for the Resource resource.
3573
+ # The identifier for the Resource resource.
3627
3574
  #
3628
3575
  # @option params [Array<String>] :embed
3629
3576
  # A query parameter to retrieve the specified resources embedded in the
@@ -3711,7 +3658,7 @@ module Aws::APIGateway
3711
3658
  # Lists information about a collection of Resource resources.
3712
3659
  #
3713
3660
  # @option params [required, String] :rest_api_id
3714
- # \[Required\] The string identifier of the associated RestApi.
3661
+ # The string identifier of the associated RestApi.
3715
3662
  #
3716
3663
  # @option params [String] :position
3717
3664
  # The current pagination position in the paged result set.
@@ -3808,7 +3755,7 @@ module Aws::APIGateway
3808
3755
  # Lists the RestApi resource in the collection.
3809
3756
  #
3810
3757
  # @option params [required, String] :rest_api_id
3811
- # \[Required\] The string identifier of the associated RestApi.
3758
+ # The string identifier of the associated RestApi.
3812
3759
  #
3813
3760
  # @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3814
3761
  #
@@ -3918,15 +3865,15 @@ module Aws::APIGateway
3918
3865
  # Generates a client SDK for a RestApi and Stage.
3919
3866
  #
3920
3867
  # @option params [required, String] :rest_api_id
3921
- # \[Required\] The string identifier of the associated RestApi.
3868
+ # The string identifier of the associated RestApi.
3922
3869
  #
3923
3870
  # @option params [required, String] :stage_name
3924
- # \[Required\] The name of the Stage that the SDK will use.
3871
+ # The name of the Stage that the SDK will use.
3925
3872
  #
3926
3873
  # @option params [required, String] :sdk_type
3927
- # \[Required\] The language for the generated SDK. Currently `java`,
3928
- # `javascript`, `android`, `objectivec` (for iOS), `swift` (for iOS),
3929
- # and `ruby` are supported.
3874
+ # The language for the generated SDK. Currently `java`, `javascript`,
3875
+ # `android`, `objectivec` (for iOS), `swift` (for iOS), and `ruby` are
3876
+ # supported.
3930
3877
  #
3931
3878
  # @option params [Hash<String,String>] :parameters
3932
3879
  # A string-to-string key-value map of query parameters
@@ -3967,8 +3914,10 @@ module Aws::APIGateway
3967
3914
  req.send_request(options)
3968
3915
  end
3969
3916
 
3917
+ # Gets an SDK type.
3918
+ #
3970
3919
  # @option params [required, String] :id
3971
- # \[Required\] The identifier of the queried SdkType instance.
3920
+ # The identifier of the queried SdkType instance.
3972
3921
  #
3973
3922
  # @return [Types::SdkType] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3974
3923
  #
@@ -4002,6 +3951,8 @@ module Aws::APIGateway
4002
3951
  req.send_request(options)
4003
3952
  end
4004
3953
 
3954
+ # Gets SDK types
3955
+ #
4005
3956
  # @option params [String] :position
4006
3957
  # The current pagination position in the paged result set.
4007
3958
  #
@@ -4045,10 +3996,10 @@ module Aws::APIGateway
4045
3996
  # Gets information about a Stage resource.
4046
3997
  #
4047
3998
  # @option params [required, String] :rest_api_id
4048
- # \[Required\] The string identifier of the associated RestApi.
3999
+ # The string identifier of the associated RestApi.
4049
4000
  #
4050
4001
  # @option params [required, String] :stage_name
4051
- # \[Required\] The name of the Stage resource to get information about.
4002
+ # The name of the Stage resource to get information about.
4052
4003
  #
4053
4004
  # @return [Types::Stage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4054
4005
  #
@@ -4124,7 +4075,7 @@ module Aws::APIGateway
4124
4075
  # Gets information about one or more Stage resources.
4125
4076
  #
4126
4077
  # @option params [required, String] :rest_api_id
4127
- # \[Required\] The string identifier of the associated RestApi.
4078
+ # The string identifier of the associated RestApi.
4128
4079
  #
4129
4080
  # @option params [String] :deployment_id
4130
4081
  # The stages' deployment identifiers.
@@ -4188,7 +4139,7 @@ module Aws::APIGateway
4188
4139
  # Gets the Tags collection for a given resource.
4189
4140
  #
4190
4141
  # @option params [required, String] :resource_arn
4191
- # \[Required\] The ARN of a resource that can be tagged.
4142
+ # The ARN of a resource that can be tagged.
4192
4143
  #
4193
4144
  # @option params [String] :position
4194
4145
  # (Not currently supported) The current pagination position in the paged
@@ -4225,16 +4176,16 @@ module Aws::APIGateway
4225
4176
  # Gets the usage data of a usage plan in a specified time interval.
4226
4177
  #
4227
4178
  # @option params [required, String] :usage_plan_id
4228
- # \[Required\] The Id of the usage plan associated with the usage data.
4179
+ # The Id of the usage plan associated with the usage data.
4229
4180
  #
4230
4181
  # @option params [String] :key_id
4231
4182
  # The Id of the API key associated with the resultant usage data.
4232
4183
  #
4233
4184
  # @option params [required, String] :start_date
4234
- # \[Required\] The starting date (e.g., 2016-01-01) of the usage data.
4185
+ # The starting date (e.g., 2016-01-01) of the usage data.
4235
4186
  #
4236
4187
  # @option params [required, String] :end_date
4237
- # \[Required\] The ending date (e.g., 2016-12-31) of the usage data.
4188
+ # The ending date (e.g., 2016-12-31) of the usage data.
4238
4189
  #
4239
4190
  # @option params [String] :position
4240
4191
  # The current pagination position in the paged result set.
@@ -4285,7 +4236,7 @@ module Aws::APIGateway
4285
4236
  # Gets a usage plan of a given plan identifier.
4286
4237
  #
4287
4238
  # @option params [required, String] :usage_plan_id
4288
- # \[Required\] The identifier of the UsagePlan resource to be retrieved.
4239
+ # The identifier of the UsagePlan resource to be retrieved.
4289
4240
  #
4290
4241
  # @return [Types::UsagePlan] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4291
4242
  #
@@ -4334,13 +4285,13 @@ module Aws::APIGateway
4334
4285
  # Gets a usage plan key of a given key identifier.
4335
4286
  #
4336
4287
  # @option params [required, String] :usage_plan_id
4337
- # \[Required\] The Id of the UsagePlan resource representing the usage
4338
- # plan containing the to-be-retrieved UsagePlanKey resource representing
4339
- # a plan customer.
4288
+ # The Id of the UsagePlan resource representing the usage plan
4289
+ # containing the to-be-retrieved UsagePlanKey resource representing a
4290
+ # plan customer.
4340
4291
  #
4341
4292
  # @option params [required, String] :key_id
4342
- # \[Required\] The key Id of the to-be-retrieved UsagePlanKey resource
4343
- # representing a plan customer.
4293
+ # The key Id of the to-be-retrieved UsagePlanKey resource representing a
4294
+ # plan customer.
4344
4295
  #
4345
4296
  # @return [Types::UsagePlanKey] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4346
4297
  #
@@ -4374,9 +4325,9 @@ module Aws::APIGateway
4374
4325
  # specified usage plan.
4375
4326
  #
4376
4327
  # @option params [required, String] :usage_plan_id
4377
- # \[Required\] The Id of the UsagePlan resource representing the usage
4378
- # plan containing the to-be-retrieved UsagePlanKey resource representing
4379
- # a plan customer.
4328
+ # The Id of the UsagePlan resource representing the usage plan
4329
+ # containing the to-be-retrieved UsagePlanKey resource representing a
4330
+ # plan customer.
4380
4331
  #
4381
4332
  # @option params [String] :position
4382
4333
  # The current pagination position in the paged result set.
@@ -4480,8 +4431,8 @@ module Aws::APIGateway
4480
4431
  # Gets a specified VPC link under the caller's account in a region.
4481
4432
  #
4482
4433
  # @option params [required, String] :vpc_link_id
4483
- # \[Required\] The identifier of the VpcLink. It is used in an
4484
- # Integration to reference this VpcLink.
4434
+ # The identifier of the VpcLink. It is used in an Integration to
4435
+ # reference this VpcLink.
4485
4436
  #
4486
4437
  # @return [Types::VpcLink] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4487
4438
  #
@@ -4567,11 +4518,7 @@ module Aws::APIGateway
4567
4518
  #
4568
4519
  # @option params [required, String, StringIO, File] :body
4569
4520
  # The payload of the POST request to import API keys. For the payload
4570
- # format, see [API Key File Format][1].
4571
- #
4572
- #
4573
- #
4574
- # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-file-format.html
4521
+ # format, see API Key File Format.
4575
4522
  #
4576
4523
  # @option params [required, String] :format
4577
4524
  # A query parameter to specify the input format to imported API keys.
@@ -4608,8 +4555,10 @@ module Aws::APIGateway
4608
4555
  req.send_request(options)
4609
4556
  end
4610
4557
 
4558
+ # Imports documentation parts
4559
+ #
4611
4560
  # @option params [required, String] :rest_api_id
4612
- # \[Required\] The string identifier of the associated RestApi.
4561
+ # The string identifier of the associated RestApi.
4613
4562
  #
4614
4563
  # @option params [String] :mode
4615
4564
  # A query parameter to indicate whether to overwrite (`OVERWRITE`) any
@@ -4622,9 +4571,8 @@ module Aws::APIGateway
4622
4571
  # The default value is `false`.
4623
4572
  #
4624
4573
  # @option params [required, String, StringIO, File] :body
4625
- # \[Required\] Raw byte array representing the to-be-imported
4626
- # documentation parts. To import from an OpenAPI file, this is a JSON
4627
- # object.
4574
+ # Raw byte array representing the to-be-imported documentation parts. To
4575
+ # import from an OpenAPI file, this is a JSON object.
4628
4576
  #
4629
4577
  # @return [Types::DocumentationPartIds] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4630
4578
  #
@@ -4682,17 +4630,13 @@ module Aws::APIGateway
4682
4630
  # For example, the AWS CLI command to exclude documentation from the
4683
4631
  # imported API is:
4684
4632
  #
4685
- # aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
4686
- #
4687
4633
  # The AWS CLI command to set the regional endpoint on the imported API
4688
4634
  # is:
4689
4635
  #
4690
- # aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'
4691
- #
4692
4636
  # @option params [required, String, StringIO, File] :body
4693
- # \[Required\] The POST request body containing external API
4694
- # definitions. Currently, only OpenAPI definition JSON/YAML files are
4695
- # supported. The maximum size of the API definition file is 6MB.
4637
+ # The POST request body containing external API definitions. Currently,
4638
+ # only OpenAPI definition JSON/YAML files are supported. The maximum
4639
+ # size of the API definition file is 6MB.
4696
4640
  #
4697
4641
  # @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4698
4642
  #
@@ -4753,10 +4697,10 @@ module Aws::APIGateway
4753
4697
  # type and status code on the given RestApi.
4754
4698
  #
4755
4699
  # @option params [required, String] :rest_api_id
4756
- # \[Required\] The string identifier of the associated RestApi.
4700
+ # The string identifier of the associated RestApi.
4757
4701
  #
4758
4702
  # @option params [required, String] :response_type
4759
- # \[Required\] The response type of the associated GatewayResponse.
4703
+ # The response type of the associated GatewayResponse
4760
4704
  #
4761
4705
  # @option params [String] :status_code
4762
4706
  # The HTTP status code of the GatewayResponse.
@@ -4811,52 +4755,45 @@ module Aws::APIGateway
4811
4755
  # Sets up a method's integration.
4812
4756
  #
4813
4757
  # @option params [required, String] :rest_api_id
4814
- # \[Required\] The string identifier of the associated RestApi.
4758
+ # The string identifier of the associated RestApi.
4815
4759
  #
4816
4760
  # @option params [required, String] :resource_id
4817
- # \[Required\] Specifies a put integration request's resource ID.
4761
+ # Specifies a put integration request's resource ID.
4818
4762
  #
4819
4763
  # @option params [required, String] :http_method
4820
- # \[Required\] Specifies a put integration request's HTTP method.
4764
+ # Specifies the HTTP method for the integration.
4821
4765
  #
4822
4766
  # @option params [required, String] :type
4823
- # \[Required\] Specifies a put integration input's type.
4767
+ # Specifies a put integration input's type.
4824
4768
  #
4825
4769
  # @option params [String] :integration_http_method
4826
- # Specifies a put integration HTTP method. When the integration type is
4827
- # HTTP or AWS, this field is required.
4770
+ # The HTTP method for the integration.
4828
4771
  #
4829
4772
  # @option params [String] :uri
4830
4773
  # Specifies Uniform Resource Identifier (URI) of the integration
4831
- # endpoint.
4832
- #
4833
- # * For `HTTP` or `HTTP_PROXY` integrations, the URI must be a fully
4834
- # formed, encoded HTTP(S) URL according to the [RFC-3986
4835
- # specification][1], for either standard integration, where
4836
- # `connectionType` is not `VPC_LINK`, or private integration, where
4837
- # `connectionType` is `VPC_LINK`. For a private HTTP integration, the
4838
- # URI is not used for routing.
4839
- #
4840
- # * For `AWS` or `AWS_PROXY` integrations, the URI is of the form
4841
- # `arn:aws:apigateway:\{region\}:\{subdomain.service|service\}:path|action/\{service_api\}`.
4842
- # Here, `\{Region\}` is the API Gateway region (e.g., `us-east-1`);
4843
- # `\{service\}` is the name of the integrated AWS service (e.g.,
4844
- # `s3`); and `\{subdomain\}` is a designated subdomain supported by
4845
- # certain AWS service for fast host-name lookup. `action` can be used
4846
- # for an AWS service action-based API, using an
4847
- # `Action=\{name\}&\{p1\}=\{v1\}&p2=\{v2\}...` query string. The
4848
- # ensuing `\{service_api\}` refers to a supported action `\{name\}`
4849
- # plus any required input parameters. Alternatively, `path` can be
4850
- # used for an AWS service path-based API. The ensuing `service_api`
4851
- # refers to the path to an AWS service resource, including the region
4852
- # of the integrated AWS service, if applicable. For example, for
4853
- # integration with the S3 API of `GetObject`, the `uri` can be either
4854
- # `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket=\{bucket\}&Key=\{key\}`
4855
- # or `arn:aws:apigateway:us-west-2:s3:path/\{bucket\}/\{key\}`
4856
- #
4857
- #
4858
- #
4859
- # [1]: https://en.wikipedia.org/wiki/Uniform_Resource_Identifier
4774
+ # endpoint. For HTTP or `HTTP_PROXY` integrations, the URI must be a
4775
+ # fully formed, encoded HTTP(S) URL according to the RFC-3986
4776
+ # specification, for either standard integration, where `connectionType`
4777
+ # is not `VPC_LINK`, or private integration, where `connectionType` is
4778
+ # `VPC_LINK`. For a private HTTP integration, the URI is not used for
4779
+ # routing. For `AWS` or `AWS_PROXY` integrations, the URI is of the form
4780
+ # `arn:aws:apigateway:\{region\}:\{subdomain.service|service\}:path|action/\{service_api`\\}.
4781
+ # Here, \\\{Region\\} is the API Gateway region (e.g., us-east-1);
4782
+ # \\\{service\\} is the name of the integrated Amazon Web Services
4783
+ # service (e.g., s3); and \\\{subdomain\\} is a designated subdomain
4784
+ # supported by certain Amazon Web Services service for fast host-name
4785
+ # lookup. action can be used for an Amazon Web Services service
4786
+ # action-based API, using an
4787
+ # Action=\\\{name\\}&amp;\\\{p1\\}=\\\{v1\\}&amp;p2=\\\{v2\\}... query
4788
+ # string. The ensuing \\\{service\_api\\} refers to a supported action
4789
+ # \\\{name\\} plus any required input parameters. Alternatively, path
4790
+ # can be used for an Amazon Web Services service path-based API. The
4791
+ # ensuing service\_api refers to the path to an Amazon Web Services
4792
+ # service resource, including the region of the integrated Amazon Web
4793
+ # Services service, if applicable. For example, for integration with the
4794
+ # S3 API of `GetObject`, the `uri` can be either
4795
+ # `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket=\{bucket\}&Key=\{key\}`
4796
+ # or `arn:aws:apigateway:us-west-2:s3:path/\{bucket\}/\{key\}`.
4860
4797
  #
4861
4798
  # @option params [String] :connection_type
4862
4799
  # The type of the network connection to the integration endpoint. The
@@ -4865,12 +4802,8 @@ module Aws::APIGateway
4865
4802
  # a network load balancer in a VPC. The default value is `INTERNET`.
4866
4803
  #
4867
4804
  # @option params [String] :connection_id
4868
- # The ([`id`][1]) of the VpcLink used for the integration when
4869
- # `connectionType=VPC_LINK` and undefined, otherwise.
4870
- #
4871
- #
4872
- #
4873
- # [1]: https://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id
4805
+ # The ID of the VpcLink used for the integration. Specify this value
4806
+ # only if you specify `VPC_LINK` as the connection type.
4874
4807
  #
4875
4808
  # @option params [String] :credentials
4876
4809
  # Specifies whether credentials are required for a put integration.
@@ -4899,17 +4832,6 @@ module Aws::APIGateway
4899
4832
  # Integration resource. There are three valid values: `WHEN_NO_MATCH`,
4900
4833
  # `WHEN_NO_TEMPLATES`, and `NEVER`.
4901
4834
  #
4902
- # * `WHEN_NO_MATCH` passes the request body for unmapped content types
4903
- # through to the integration back end without transformation.
4904
- #
4905
- # * `NEVER` rejects unmapped content types with an HTTP 415
4906
- # 'Unsupported Media Type' response.
4907
- #
4908
- # * `WHEN_NO_TEMPLATES` allows pass-through when the integration has NO
4909
- # content types mapped to templates. However if there is at least one
4910
- # content type defined, unmapped content types will be rejected with
4911
- # the same 415 response.
4912
- #
4913
4835
  # @option params [String] :cache_namespace
4914
4836
  # Specifies a group of related cached parameters. By default, API
4915
4837
  # Gateway uses the resource ID as the `cacheNamespace`. You can specify
@@ -4926,12 +4848,6 @@ module Aws::APIGateway
4926
4848
  # Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with
4927
4849
  # the following behaviors:
4928
4850
  #
4929
- # * `CONVERT_TO_BINARY`\: Converts a request payload from a
4930
- # Base64-encoded string to the corresponding binary blob.
4931
- #
4932
- # * `CONVERT_TO_TEXT`\: Converts a request payload from a binary blob to
4933
- # a Base64-encoded string.
4934
- #
4935
4851
  # If this property is not defined, the request payload will be passed
4936
4852
  # through from the method request to integration request without
4937
4853
  # modification, provided that the `passthroughBehavior` is configured to
@@ -4942,6 +4858,7 @@ module Aws::APIGateway
4942
4858
  # is 29,000 milliseconds or 29 seconds.
4943
4859
  #
4944
4860
  # @option params [Types::TlsConfig] :tls_config
4861
+ # Specifies the TLS configuration for an integration.
4945
4862
  #
4946
4863
  # @return [Types::Integration] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4947
4864
  #
@@ -5027,19 +4944,17 @@ module Aws::APIGateway
5027
4944
  # Represents a put integration.
5028
4945
  #
5029
4946
  # @option params [required, String] :rest_api_id
5030
- # \[Required\] The string identifier of the associated RestApi.
4947
+ # The string identifier of the associated RestApi.
5031
4948
  #
5032
4949
  # @option params [required, String] :resource_id
5033
- # \[Required\] Specifies a put integration response request's resource
5034
- # identifier.
4950
+ # Specifies a put integration response request's resource identifier.
5035
4951
  #
5036
4952
  # @option params [required, String] :http_method
5037
- # \[Required\] Specifies a put integration response request's HTTP
5038
- # method.
4953
+ # Specifies a put integration response request's HTTP method.
5039
4954
  #
5040
4955
  # @option params [required, String] :status_code
5041
- # \[Required\] Specifies the status code that is used to map the
5042
- # integration response to an existing MethodResponse.
4956
+ # Specifies the status code that is used to map the integration response
4957
+ # to an existing MethodResponse.
5043
4958
  #
5044
4959
  # @option params [String] :selection_pattern
5045
4960
  # Specifies the selection pattern of a put integration response.
@@ -5065,12 +4980,6 @@ module Aws::APIGateway
5065
4980
  # Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with
5066
4981
  # the following behaviors:
5067
4982
  #
5068
- # * `CONVERT_TO_BINARY`\: Converts a response payload from a
5069
- # Base64-encoded string to the corresponding binary blob.
5070
- #
5071
- # * `CONVERT_TO_TEXT`\: Converts a response payload from a binary blob
5072
- # to a Base64-encoded string.
5073
- #
5074
4983
  # If this property is not defined, the response payload will be passed
5075
4984
  # through from the integration response to the method response without
5076
4985
  # modification.
@@ -5120,19 +5029,19 @@ module Aws::APIGateway
5120
5029
  # Add a method to an existing Resource resource.
5121
5030
  #
5122
5031
  # @option params [required, String] :rest_api_id
5123
- # \[Required\] The string identifier of the associated RestApi.
5032
+ # The string identifier of the associated RestApi.
5124
5033
  #
5125
5034
  # @option params [required, String] :resource_id
5126
- # \[Required\] The Resource identifier for the new Method resource.
5035
+ # The Resource identifier for the new Method resource.
5127
5036
  #
5128
5037
  # @option params [required, String] :http_method
5129
- # \[Required\] Specifies the method request's HTTP method type.
5038
+ # Specifies the method request's HTTP method type.
5130
5039
  #
5131
5040
  # @option params [required, String] :authorization_type
5132
- # \[Required\] The method's authorization type. Valid values are `NONE`
5133
- # for open access, `AWS_IAM` for using AWS IAM permissions, `CUSTOM` for
5134
- # using a custom authorizer, or `COGNITO_USER_POOLS` for using a Cognito
5135
- # user pool.
5041
+ # The method's authorization type. Valid values are `NONE` for open
5042
+ # access, `AWS_IAM` for using AWS IAM permissions, `CUSTOM` for using a
5043
+ # custom authorizer, or `COGNITO_USER_POOLS` for using a Cognito user
5044
+ # pool.
5136
5045
  #
5137
5046
  # @option params [String] :authorizer_id
5138
5047
  # Specifies the identifier of an Authorizer to use on this Method, if
@@ -5269,16 +5178,16 @@ module Aws::APIGateway
5269
5178
  # Adds a MethodResponse to an existing Method resource.
5270
5179
  #
5271
5180
  # @option params [required, String] :rest_api_id
5272
- # \[Required\] The string identifier of the associated RestApi.
5181
+ # The string identifier of the associated RestApi.
5273
5182
  #
5274
5183
  # @option params [required, String] :resource_id
5275
- # \[Required\] The Resource identifier for the Method resource.
5184
+ # The Resource identifier for the Method resource.
5276
5185
  #
5277
5186
  # @option params [required, String] :http_method
5278
- # \[Required\] The HTTP verb of the Method resource.
5187
+ # The HTTP verb of the Method resource.
5279
5188
  #
5280
5189
  # @option params [required, String] :status_code
5281
- # \[Required\] The method response's status code.
5190
+ # The method response's status code.
5282
5191
  #
5283
5192
  # @option params [Hash<String,Boolean>] :response_parameters
5284
5193
  # A key-value map specifying required or optional response parameters
@@ -5343,7 +5252,7 @@ module Aws::APIGateway
5343
5252
  # overwriting the existing API.
5344
5253
  #
5345
5254
  # @option params [required, String] :rest_api_id
5346
- # \[Required\] The string identifier of the associated RestApi.
5255
+ # The string identifier of the associated RestApi.
5347
5256
  #
5348
5257
  # @option params [String] :mode
5349
5258
  # The `mode` query parameter to specify the update mode. Valid values
@@ -5363,9 +5272,9 @@ module Aws::APIGateway
5363
5272
  # ignore=documentation --body 'file:///path/to/imported-api-body.json'`.
5364
5273
  #
5365
5274
  # @option params [required, String, StringIO, File] :body
5366
- # \[Required\] The PUT request body containing external API definitions.
5367
- # Currently, only OpenAPI definition JSON/YAML files are supported. The
5368
- # maximum size of the API definition file is 6MB.
5275
+ # The PUT request body containing external API definitions. Currently,
5276
+ # only OpenAPI definition JSON/YAML files are supported. The maximum
5277
+ # size of the API definition file is 6MB.
5369
5278
  #
5370
5279
  # @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5371
5280
  #
@@ -5427,10 +5336,10 @@ module Aws::APIGateway
5427
5336
  # Adds or updates a tag on a given resource.
5428
5337
  #
5429
5338
  # @option params [required, String] :resource_arn
5430
- # \[Required\] The ARN of a resource that can be tagged.
5339
+ # The ARN of a resource that can be tagged.
5431
5340
  #
5432
5341
  # @option params [required, Hash<String,String>] :tags
5433
- # \[Required\] The key-value map of strings. The valid character set is
5342
+ # The key-value map of strings. The valid character set is
5434
5343
  # \[a-zA-Z+-=.\_:/\]. The tag key can be up to 128 characters and must
5435
5344
  # not start with `aws:`. The tag value can be up to 256 characters.
5436
5345
  #
@@ -5455,48 +5364,36 @@ module Aws::APIGateway
5455
5364
  # Simulate the execution of an Authorizer in your RestApi with headers,
5456
5365
  # parameters, and an incoming request body.
5457
5366
  #
5458
- # <div class="seeAlso" markdown="1">
5459
- # [Use Lambda Function as Authorizer][1] [Use Cognito User Pool as
5460
- # Authorizer][2]
5461
- # </div>
5462
- #
5463
- #
5464
- #
5465
- # [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html
5466
- # [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html
5467
- #
5468
5367
  # @option params [required, String] :rest_api_id
5469
- # \[Required\] The string identifier of the associated RestApi.
5368
+ # The string identifier of the associated RestApi.
5470
5369
  #
5471
5370
  # @option params [required, String] :authorizer_id
5472
- # \[Required\] Specifies a test invoke authorizer request's Authorizer
5473
- # ID.
5371
+ # Specifies a test invoke authorizer request's Authorizer ID.
5474
5372
  #
5475
5373
  # @option params [Hash<String,String>] :headers
5476
- # \[Required\] A key-value map of headers to simulate an incoming
5477
- # invocation request. This is where the incoming authorization token, or
5478
- # identity source, should be specified.
5374
+ # A key-value map of headers to simulate an incoming invocation request.
5375
+ # This is where the incoming authorization token, or identity source,
5376
+ # should be specified.
5479
5377
  #
5480
5378
  # @option params [Hash<String,Array>] :multi_value_headers
5481
- # \[Optional\] The headers as a map from string to list of values to
5482
- # simulate an incoming invocation request. This is where the incoming
5483
- # authorization token, or identity source, may be specified.
5379
+ # The headers as a map from string to list of values to simulate an
5380
+ # incoming invocation request. This is where the incoming authorization
5381
+ # token, or identity source, may be specified.
5484
5382
  #
5485
5383
  # @option params [String] :path_with_query_string
5486
- # \[Optional\] The URI path, including query string, of the simulated
5487
- # invocation request. Use this to specify path parameters and query
5488
- # string parameters.
5384
+ # The URI path, including query string, of the simulated invocation
5385
+ # request. Use this to specify path parameters and query string
5386
+ # parameters.
5489
5387
  #
5490
5388
  # @option params [String] :body
5491
- # \[Optional\] The simulated request body of an incoming invocation
5492
- # request.
5389
+ # The simulated request body of an incoming invocation request.
5493
5390
  #
5494
5391
  # @option params [Hash<String,String>] :stage_variables
5495
5392
  # A key-value map of stage variables to simulate an invocation on a
5496
5393
  # deployed Stage.
5497
5394
  #
5498
5395
  # @option params [Hash<String,String>] :additional_context
5499
- # \[Optional\] A key-value map of additional context variables.
5396
+ # A key-value map of additional context variables.
5500
5397
  #
5501
5398
  # @return [Types::TestInvokeAuthorizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5502
5399
  #
@@ -5549,17 +5446,17 @@ module Aws::APIGateway
5549
5446
  req.send_request(options)
5550
5447
  end
5551
5448
 
5552
- # Simulate the execution of a Method in your RestApi with headers,
5449
+ # Simulate the invocation of a Method in your RestApi with headers,
5553
5450
  # parameters, and an incoming request body.
5554
5451
  #
5555
5452
  # @option params [required, String] :rest_api_id
5556
- # \[Required\] The string identifier of the associated RestApi.
5453
+ # The string identifier of the associated RestApi.
5557
5454
  #
5558
5455
  # @option params [required, String] :resource_id
5559
- # \[Required\] Specifies a test invoke method request's resource ID.
5456
+ # Specifies a test invoke method request's resource ID.
5560
5457
  #
5561
5458
  # @option params [required, String] :http_method
5562
- # \[Required\] Specifies a test invoke method request's HTTP method.
5459
+ # Specifies a test invoke method request's HTTP method.
5563
5460
  #
5564
5461
  # @option params [String] :path_with_query_string
5565
5462
  # The URI path, including query string, of the simulated invocation
@@ -5636,10 +5533,10 @@ module Aws::APIGateway
5636
5533
  # Removes a tag from a given resource.
5637
5534
  #
5638
5535
  # @option params [required, String] :resource_arn
5639
- # \[Required\] The ARN of a resource that can be tagged.
5536
+ # The ARN of a resource that can be tagged.
5640
5537
  #
5641
5538
  # @option params [required, Array<String>] :tag_keys
5642
- # \[Required\] The Tag keys to delete.
5539
+ # The Tag keys to delete.
5643
5540
  #
5644
5541
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5645
5542
  #
@@ -5660,8 +5557,12 @@ module Aws::APIGateway
5660
5557
  # Changes information about the current Account resource.
5661
5558
  #
5662
5559
  # @option params [Array<Types::PatchOperation>] :patch_operations
5663
- # A list of update operations to be applied to the specified resource
5664
- # and in the order specified in this list.
5560
+ # For more information about supported patch operations, see [Patch
5561
+ # Operations][1].
5562
+ #
5563
+ #
5564
+ #
5565
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
5665
5566
  #
5666
5567
  # @return [Types::Account] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5667
5568
  #
@@ -5702,11 +5603,15 @@ module Aws::APIGateway
5702
5603
  # Changes information about an ApiKey resource.
5703
5604
  #
5704
5605
  # @option params [required, String] :api_key
5705
- # \[Required\] The identifier of the ApiKey resource to be updated.
5606
+ # The identifier of the ApiKey resource to be updated.
5706
5607
  #
5707
5608
  # @option params [Array<Types::PatchOperation>] :patch_operations
5708
- # A list of update operations to be applied to the specified resource
5709
- # and in the order specified in this list.
5609
+ # For more information about supported patch operations, see [Patch
5610
+ # Operations][1].
5611
+ #
5612
+ #
5613
+ #
5614
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
5710
5615
  #
5711
5616
  # @return [Types::ApiKey] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5712
5617
  #
@@ -5759,23 +5664,19 @@ module Aws::APIGateway
5759
5664
 
5760
5665
  # Updates an existing Authorizer resource.
5761
5666
  #
5762
- # <div class="seeAlso" markdown="1">
5763
- # [AWS CLI][1]
5764
- # </div>
5765
- #
5766
- #
5767
- #
5768
- # [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html
5769
- #
5770
5667
  # @option params [required, String] :rest_api_id
5771
- # \[Required\] The string identifier of the associated RestApi.
5668
+ # The string identifier of the associated RestApi.
5772
5669
  #
5773
5670
  # @option params [required, String] :authorizer_id
5774
- # \[Required\] The identifier of the Authorizer resource.
5671
+ # The identifier of the Authorizer resource.
5775
5672
  #
5776
5673
  # @option params [Array<Types::PatchOperation>] :patch_operations
5777
- # A list of update operations to be applied to the specified resource
5778
- # and in the order specified in this list.
5674
+ # For more information about supported patch operations, see [Patch
5675
+ # Operations][1].
5676
+ #
5677
+ #
5678
+ #
5679
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
5779
5680
  #
5780
5681
  # @return [Types::Authorizer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5781
5682
  #
@@ -5829,17 +5730,20 @@ module Aws::APIGateway
5829
5730
  # Changes information about the BasePathMapping resource.
5830
5731
  #
5831
5732
  # @option params [required, String] :domain_name
5832
- # \[Required\] The domain name of the BasePathMapping resource to
5833
- # change.
5733
+ # The domain name of the BasePathMapping resource to change.
5834
5734
  #
5835
5735
  # @option params [required, String] :base_path
5836
- # \[Required\] The base path of the BasePathMapping resource to change.
5736
+ # The base path of the BasePathMapping resource to change.
5837
5737
  #
5838
5738
  # To specify an empty base path, set this parameter to `'(none)'`.
5839
5739
  #
5840
5740
  # @option params [Array<Types::PatchOperation>] :patch_operations
5841
- # A list of update operations to be applied to the specified resource
5842
- # and in the order specified in this list.
5741
+ # For more information about supported patch operations, see [Patch
5742
+ # Operations][1].
5743
+ #
5744
+ #
5745
+ #
5746
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
5843
5747
  #
5844
5748
  # @return [Types::BasePathMapping] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5845
5749
  #
@@ -5878,12 +5782,15 @@ module Aws::APIGateway
5878
5782
  # Changes information about an ClientCertificate resource.
5879
5783
  #
5880
5784
  # @option params [required, String] :client_certificate_id
5881
- # \[Required\] The identifier of the ClientCertificate resource to be
5882
- # updated.
5785
+ # The identifier of the ClientCertificate resource to be updated.
5883
5786
  #
5884
5787
  # @option params [Array<Types::PatchOperation>] :patch_operations
5885
- # A list of update operations to be applied to the specified resource
5886
- # and in the order specified in this list.
5788
+ # For more information about supported patch operations, see [Patch
5789
+ # Operations][1].
5790
+ #
5791
+ #
5792
+ #
5793
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
5887
5794
  #
5888
5795
  # @return [Types::ClientCertificate] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5889
5796
  #
@@ -5928,15 +5835,19 @@ module Aws::APIGateway
5928
5835
  # Changes information about a Deployment resource.
5929
5836
  #
5930
5837
  # @option params [required, String] :rest_api_id
5931
- # \[Required\] The string identifier of the associated RestApi.
5838
+ # The string identifier of the associated RestApi.
5932
5839
  #
5933
5840
  # @option params [required, String] :deployment_id
5934
5841
  # The replacement identifier for the Deployment resource to change
5935
5842
  # information about.
5936
5843
  #
5937
5844
  # @option params [Array<Types::PatchOperation>] :patch_operations
5938
- # A list of update operations to be applied to the specified resource
5939
- # and in the order specified in this list.
5845
+ # For more information about supported patch operations, see [Patch
5846
+ # Operations][1].
5847
+ #
5848
+ #
5849
+ #
5850
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
5940
5851
  #
5941
5852
  # @return [Types::Deployment] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5942
5853
  #
@@ -5977,15 +5888,21 @@ module Aws::APIGateway
5977
5888
  req.send_request(options)
5978
5889
  end
5979
5890
 
5891
+ # Updates a documentation part.
5892
+ #
5980
5893
  # @option params [required, String] :rest_api_id
5981
- # \[Required\] The string identifier of the associated RestApi.
5894
+ # The string identifier of the associated RestApi.
5982
5895
  #
5983
5896
  # @option params [required, String] :documentation_part_id
5984
- # \[Required\] The identifier of the to-be-updated documentation part.
5897
+ # The identifier of the to-be-updated documentation part.
5985
5898
  #
5986
5899
  # @option params [Array<Types::PatchOperation>] :patch_operations
5987
- # A list of update operations to be applied to the specified resource
5988
- # and in the order specified in this list.
5900
+ # For more information about supported patch operations, see [Patch
5901
+ # Operations][1].
5902
+ #
5903
+ #
5904
+ #
5905
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
5989
5906
  #
5990
5907
  # @return [Types::DocumentationPart] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5991
5908
  #
@@ -6025,16 +5942,21 @@ module Aws::APIGateway
6025
5942
  req.send_request(options)
6026
5943
  end
6027
5944
 
5945
+ # Updates a documentation version.
5946
+ #
6028
5947
  # @option params [required, String] :rest_api_id
6029
- # \[Required\] The string identifier of the associated RestApi..
5948
+ # The string identifier of the associated RestApi..
6030
5949
  #
6031
5950
  # @option params [required, String] :documentation_version
6032
- # \[Required\] The version identifier of the to-be-updated documentation
6033
- # version.
5951
+ # The version identifier of the to-be-updated documentation version.
6034
5952
  #
6035
5953
  # @option params [Array<Types::PatchOperation>] :patch_operations
6036
- # A list of update operations to be applied to the specified resource
6037
- # and in the order specified in this list.
5954
+ # For more information about supported patch operations, see [Patch
5955
+ # Operations][1].
5956
+ #
5957
+ #
5958
+ #
5959
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
6038
5960
  #
6039
5961
  # @return [Types::DocumentationVersion] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6040
5962
  #
@@ -6073,11 +5995,15 @@ module Aws::APIGateway
6073
5995
  # Changes information about the DomainName resource.
6074
5996
  #
6075
5997
  # @option params [required, String] :domain_name
6076
- # \[Required\] The name of the DomainName resource to be changed.
5998
+ # The name of the DomainName resource to be changed.
6077
5999
  #
6078
6000
  # @option params [Array<Types::PatchOperation>] :patch_operations
6079
- # A list of update operations to be applied to the specified resource
6080
- # and in the order specified in this list.
6001
+ # For more information about supported patch operations, see [Patch
6002
+ # Operations][1].
6003
+ #
6004
+ #
6005
+ #
6006
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
6081
6007
  #
6082
6008
  # @return [Types::DomainName] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6083
6009
  #
@@ -6151,14 +6077,18 @@ module Aws::APIGateway
6151
6077
  # RestApi.
6152
6078
  #
6153
6079
  # @option params [required, String] :rest_api_id
6154
- # \[Required\] The string identifier of the associated RestApi.
6080
+ # The string identifier of the associated RestApi.
6155
6081
  #
6156
6082
  # @option params [required, String] :response_type
6157
- # \[Required\] The response type of the associated GatewayResponse.
6083
+ # The response type of the associated GatewayResponse.
6158
6084
  #
6159
6085
  # @option params [Array<Types::PatchOperation>] :patch_operations
6160
- # A list of update operations to be applied to the specified resource
6161
- # and in the order specified in this list.
6086
+ # For more information about supported patch operations, see [Patch
6087
+ # Operations][1].
6088
+ #
6089
+ #
6090
+ #
6091
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
6162
6092
  #
6163
6093
  # @return [Types::GatewayResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6164
6094
  #
@@ -6203,18 +6133,21 @@ module Aws::APIGateway
6203
6133
  # Represents an update integration.
6204
6134
  #
6205
6135
  # @option params [required, String] :rest_api_id
6206
- # \[Required\] The string identifier of the associated RestApi.
6136
+ # The string identifier of the associated RestApi.
6207
6137
  #
6208
6138
  # @option params [required, String] :resource_id
6209
- # \[Required\] Represents an update integration request's resource
6210
- # identifier.
6139
+ # Represents an update integration request's resource identifier.
6211
6140
  #
6212
6141
  # @option params [required, String] :http_method
6213
- # \[Required\] Represents an update integration request's HTTP method.
6142
+ # Represents an update integration request's HTTP method.
6214
6143
  #
6215
6144
  # @option params [Array<Types::PatchOperation>] :patch_operations
6216
- # A list of update operations to be applied to the specified resource
6217
- # and in the order specified in this list.
6145
+ # For more information about supported patch operations, see [Patch
6146
+ # Operations][1].
6147
+ #
6148
+ #
6149
+ #
6150
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
6218
6151
  #
6219
6152
  # @return [Types::Integration] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6220
6153
  #
@@ -6288,23 +6221,25 @@ module Aws::APIGateway
6288
6221
  # Represents an update integration response.
6289
6222
  #
6290
6223
  # @option params [required, String] :rest_api_id
6291
- # \[Required\] The string identifier of the associated RestApi.
6224
+ # The string identifier of the associated RestApi.
6292
6225
  #
6293
6226
  # @option params [required, String] :resource_id
6294
- # \[Required\] Specifies an update integration response request's
6295
- # resource identifier.
6227
+ # Specifies an update integration response request's resource
6228
+ # identifier.
6296
6229
  #
6297
6230
  # @option params [required, String] :http_method
6298
- # \[Required\] Specifies an update integration response request's HTTP
6299
- # method.
6231
+ # Specifies an update integration response request's HTTP method.
6300
6232
  #
6301
6233
  # @option params [required, String] :status_code
6302
- # \[Required\] Specifies an update integration response request's
6303
- # status code.
6234
+ # Specifies an update integration response request's status code.
6304
6235
  #
6305
6236
  # @option params [Array<Types::PatchOperation>] :patch_operations
6306
- # A list of update operations to be applied to the specified resource
6307
- # and in the order specified in this list.
6237
+ # For more information about supported patch operations, see [Patch
6238
+ # Operations][1].
6239
+ #
6240
+ #
6241
+ #
6242
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
6308
6243
  #
6309
6244
  # @return [Types::IntegrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6310
6245
  #
@@ -6351,17 +6286,21 @@ module Aws::APIGateway
6351
6286
  # Updates an existing Method resource.
6352
6287
  #
6353
6288
  # @option params [required, String] :rest_api_id
6354
- # \[Required\] The string identifier of the associated RestApi.
6289
+ # The string identifier of the associated RestApi.
6355
6290
  #
6356
6291
  # @option params [required, String] :resource_id
6357
- # \[Required\] The Resource identifier for the Method resource.
6292
+ # The Resource identifier for the Method resource.
6358
6293
  #
6359
6294
  # @option params [required, String] :http_method
6360
- # \[Required\] The HTTP verb of the Method resource.
6295
+ # The HTTP verb of the Method resource.
6361
6296
  #
6362
6297
  # @option params [Array<Types::PatchOperation>] :patch_operations
6363
- # A list of update operations to be applied to the specified resource
6364
- # and in the order specified in this list.
6298
+ # For more information about supported patch operations, see [Patch
6299
+ # Operations][1].
6300
+ #
6301
+ #
6302
+ #
6303
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
6365
6304
  #
6366
6305
  # @return [Types::Method] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6367
6306
  #
@@ -6449,20 +6388,24 @@ module Aws::APIGateway
6449
6388
  # Updates an existing MethodResponse resource.
6450
6389
  #
6451
6390
  # @option params [required, String] :rest_api_id
6452
- # \[Required\] The string identifier of the associated RestApi.
6391
+ # The string identifier of the associated RestApi.
6453
6392
  #
6454
6393
  # @option params [required, String] :resource_id
6455
- # \[Required\] The Resource identifier for the MethodResponse resource.
6394
+ # The Resource identifier for the MethodResponse resource.
6456
6395
  #
6457
6396
  # @option params [required, String] :http_method
6458
- # \[Required\] The HTTP verb of the Method resource.
6397
+ # The HTTP verb of the Method resource.
6459
6398
  #
6460
6399
  # @option params [required, String] :status_code
6461
- # \[Required\] The status code for the MethodResponse resource.
6400
+ # The status code for the MethodResponse resource.
6462
6401
  #
6463
6402
  # @option params [Array<Types::PatchOperation>] :patch_operations
6464
- # A list of update operations to be applied to the specified resource
6465
- # and in the order specified in this list.
6403
+ # For more information about supported patch operations, see [Patch
6404
+ # Operations][1].
6405
+ #
6406
+ #
6407
+ #
6408
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
6466
6409
  #
6467
6410
  # @return [Types::MethodResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6468
6411
  #
@@ -6505,14 +6448,18 @@ module Aws::APIGateway
6505
6448
  # Changes information about a model.
6506
6449
  #
6507
6450
  # @option params [required, String] :rest_api_id
6508
- # \[Required\] The string identifier of the associated RestApi.
6451
+ # The string identifier of the associated RestApi.
6509
6452
  #
6510
6453
  # @option params [required, String] :model_name
6511
- # \[Required\] The name of the model to update.
6454
+ # The name of the model to update.
6512
6455
  #
6513
6456
  # @option params [Array<Types::PatchOperation>] :patch_operations
6514
- # A list of update operations to be applied to the specified resource
6515
- # and in the order specified in this list.
6457
+ # For more information about supported patch operations, see [Patch
6458
+ # Operations][1].
6459
+ #
6460
+ #
6461
+ #
6462
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
6516
6463
  #
6517
6464
  # @return [Types::Model] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6518
6465
  #
@@ -6555,14 +6502,18 @@ module Aws::APIGateway
6555
6502
  # Updates a RequestValidator of a given RestApi.
6556
6503
  #
6557
6504
  # @option params [required, String] :rest_api_id
6558
- # \[Required\] The string identifier of the associated RestApi.
6505
+ # The string identifier of the associated RestApi.
6559
6506
  #
6560
6507
  # @option params [required, String] :request_validator_id
6561
- # \[Required\] The identifier of RequestValidator to be updated.
6508
+ # The identifier of RequestValidator to be updated.
6562
6509
  #
6563
6510
  # @option params [Array<Types::PatchOperation>] :patch_operations
6564
- # A list of update operations to be applied to the specified resource
6565
- # and in the order specified in this list.
6511
+ # For more information about supported patch operations, see [Patch
6512
+ # Operations][1].
6513
+ #
6514
+ #
6515
+ #
6516
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
6566
6517
  #
6567
6518
  # @return [Types::RequestValidator] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6568
6519
  #
@@ -6603,14 +6554,18 @@ module Aws::APIGateway
6603
6554
  # Changes information about a Resource resource.
6604
6555
  #
6605
6556
  # @option params [required, String] :rest_api_id
6606
- # \[Required\] The string identifier of the associated RestApi.
6557
+ # The string identifier of the associated RestApi.
6607
6558
  #
6608
6559
  # @option params [required, String] :resource_id
6609
- # \[Required\] The identifier of the Resource resource.
6560
+ # The identifier of the Resource resource.
6610
6561
  #
6611
6562
  # @option params [Array<Types::PatchOperation>] :patch_operations
6612
- # A list of update operations to be applied to the specified resource
6613
- # and in the order specified in this list.
6563
+ # For more information about supported patch operations, see [Patch
6564
+ # Operations][1].
6565
+ #
6566
+ #
6567
+ #
6568
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
6614
6569
  #
6615
6570
  # @return [Types::Resource] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6616
6571
  #
@@ -6696,11 +6651,15 @@ module Aws::APIGateway
6696
6651
  # Changes information about the specified API.
6697
6652
  #
6698
6653
  # @option params [required, String] :rest_api_id
6699
- # \[Required\] The string identifier of the associated RestApi.
6654
+ # The string identifier of the associated RestApi.
6700
6655
  #
6701
6656
  # @option params [Array<Types::PatchOperation>] :patch_operations
6702
- # A list of update operations to be applied to the specified resource
6703
- # and in the order specified in this list.
6657
+ # For more information about supported patch operations, see [Patch
6658
+ # Operations][1].
6659
+ #
6660
+ #
6661
+ #
6662
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
6704
6663
  #
6705
6664
  # @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6706
6665
  #
@@ -6764,15 +6723,18 @@ module Aws::APIGateway
6764
6723
  # Changes information about a Stage resource.
6765
6724
  #
6766
6725
  # @option params [required, String] :rest_api_id
6767
- # \[Required\] The string identifier of the associated RestApi.
6726
+ # The string identifier of the associated RestApi.
6768
6727
  #
6769
6728
  # @option params [required, String] :stage_name
6770
- # \[Required\] The name of the Stage resource to change information
6771
- # about.
6729
+ # The name of the Stage resource to change information about.
6772
6730
  #
6773
6731
  # @option params [Array<Types::PatchOperation>] :patch_operations
6774
- # A list of update operations to be applied to the specified resource
6775
- # and in the order specified in this list.
6732
+ # For more information about supported patch operations, see [Patch
6733
+ # Operations][1].
6734
+ #
6735
+ #
6736
+ #
6737
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
6776
6738
  #
6777
6739
  # @return [Types::Stage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6778
6740
  #
@@ -6857,15 +6819,19 @@ module Aws::APIGateway
6857
6819
  # associated with a specified API key.
6858
6820
  #
6859
6821
  # @option params [required, String] :usage_plan_id
6860
- # \[Required\] The Id of the usage plan associated with the usage data.
6822
+ # The Id of the usage plan associated with the usage data.
6861
6823
  #
6862
6824
  # @option params [required, String] :key_id
6863
- # \[Required\] The identifier of the API key associated with the usage
6864
- # plan in which a temporary extension is granted to the remaining quota.
6825
+ # The identifier of the API key associated with the usage plan in which
6826
+ # a temporary extension is granted to the remaining quota.
6865
6827
  #
6866
6828
  # @option params [Array<Types::PatchOperation>] :patch_operations
6867
- # A list of update operations to be applied to the specified resource
6868
- # and in the order specified in this list.
6829
+ # For more information about supported patch operations, see [Patch
6830
+ # Operations][1].
6831
+ #
6832
+ #
6833
+ #
6834
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
6869
6835
  #
6870
6836
  # @return [Types::Usage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6871
6837
  #
@@ -6911,11 +6877,15 @@ module Aws::APIGateway
6911
6877
  # Updates a usage plan of a given plan Id.
6912
6878
  #
6913
6879
  # @option params [required, String] :usage_plan_id
6914
- # \[Required\] The Id of the to-be-updated usage plan.
6880
+ # The Id of the to-be-updated usage plan.
6915
6881
  #
6916
6882
  # @option params [Array<Types::PatchOperation>] :patch_operations
6917
- # A list of update operations to be applied to the specified resource
6918
- # and in the order specified in this list.
6883
+ # For more information about supported patch operations, see [Patch
6884
+ # Operations][1].
6885
+ #
6886
+ #
6887
+ #
6888
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
6919
6889
  #
6920
6890
  # @return [Types::UsagePlan] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6921
6891
  #
@@ -6972,12 +6942,16 @@ module Aws::APIGateway
6972
6942
  # Updates an existing VpcLink of a specified identifier.
6973
6943
  #
6974
6944
  # @option params [required, String] :vpc_link_id
6975
- # \[Required\] The identifier of the VpcLink. It is used in an
6976
- # Integration to reference this VpcLink.
6945
+ # The identifier of the VpcLink. It is used in an Integration to
6946
+ # reference this VpcLink.
6977
6947
  #
6978
6948
  # @option params [Array<Types::PatchOperation>] :patch_operations
6979
- # A list of update operations to be applied to the specified resource
6980
- # and in the order specified in this list.
6949
+ # For more information about supported patch operations, see [Patch
6950
+ # Operations][1].
6951
+ #
6952
+ #
6953
+ #
6954
+ # [1]: https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html
6981
6955
  #
6982
6956
  # @return [Types::VpcLink] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6983
6957
  #
@@ -7035,7 +7009,7 @@ module Aws::APIGateway
7035
7009
  params: params,
7036
7010
  config: config)
7037
7011
  context[:gem_name] = 'aws-sdk-apigateway'
7038
- context[:gem_version] = '1.76.0'
7012
+ context[:gem_version] = '1.77.0'
7039
7013
  Seahorse::Client::Request.new(handlers, context)
7040
7014
  end
7041
7015