aws-sdk-apigateway 1.74.0 → 1.77.0

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