aws-sdk-apigateway 1.0.0.rc3 → 1.0.0.rc4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-apigateway.rb +1 -1
- data/lib/aws-sdk-apigateway/client.rb +324 -76
- data/lib/aws-sdk-apigateway/client_api.rb +116 -4
- data/lib/aws-sdk-apigateway/types.rb +390 -124
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2b65cdf517554a78ee41f76f11c249914fd37d74
|
4
|
+
data.tar.gz: 9cb4fe497975e7427e66fa1d5acff6455ce230ef
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cde8b3e108fa33315f9f8a666a3c3764058f1939254810e619541178591cb79e34227dc2b91fae777a7728cc42709283ae370c4d0decbda3bb79c482372d52cf
|
7
|
+
data.tar.gz: fff7db6606572fa19c1b3bd36b982353b22dce414b06fc0fa77b35569f537e2e50035098947f07d2d56f618f9dfee71dd9b3cdde8af4cfa1a6fab220dfd3fba8
|
data/lib/aws-sdk-apigateway.rb
CHANGED
@@ -18,6 +18,7 @@ require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
|
18
18
|
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
19
|
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
20
|
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
21
22
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
22
23
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
23
24
|
require 'aws-sdk-apigateway/plugins/apply_content_type_header.rb'
|
@@ -46,6 +47,7 @@ module Aws::APIGateway
|
|
46
47
|
add_plugin(Aws::Plugins::ResponsePaging)
|
47
48
|
add_plugin(Aws::Plugins::StubResponses)
|
48
49
|
add_plugin(Aws::Plugins::IdempotencyToken)
|
50
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
49
51
|
add_plugin(Aws::Plugins::SignatureV4)
|
50
52
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
51
53
|
add_plugin(Aws::APIGateway::Plugins::ApplyContentTypeHeader)
|
@@ -528,30 +530,36 @@ module Aws::APIGateway
|
|
528
530
|
# Creates a new domain name.
|
529
531
|
#
|
530
532
|
# @option params [required, String] :domain_name
|
531
|
-
# The name of the DomainName resource.
|
533
|
+
# (Required) The name of the DomainName resource.
|
534
|
+
#
|
535
|
+
# @option params [String] :certificate_name
|
536
|
+
# The user-friendly name of the certificate.
|
532
537
|
#
|
533
|
-
# @option params [
|
534
|
-
# The
|
538
|
+
# @option params [String] :certificate_body
|
539
|
+
# \[Deprecated\] The body of the server certificate provided by your
|
540
|
+
# certificate authority.
|
535
541
|
#
|
536
|
-
# @option params [
|
537
|
-
#
|
538
|
-
# authority.
|
542
|
+
# @option params [String] :certificate_private_key
|
543
|
+
# \[Deprecated\] Your certificate's private key.
|
539
544
|
#
|
540
|
-
# @option params [
|
541
|
-
#
|
545
|
+
# @option params [String] :certificate_chain
|
546
|
+
# \[Deprecated\] The intermediate certificates and optionally the root
|
547
|
+
# certificate, one after the other without any blank lines. If you
|
548
|
+
# include the root certificate, your certificate chain must start with
|
549
|
+
# intermediate certificates and end with the root certificate. Use the
|
550
|
+
# intermediate certificates that were provided by your certificate
|
551
|
+
# authority. Do not include any intermediaries that are not in the chain
|
552
|
+
# of trust path.
|
542
553
|
#
|
543
|
-
# @option params [
|
544
|
-
# The
|
545
|
-
#
|
546
|
-
# certificate, your certificate chain must start with intermediate
|
547
|
-
# certificates and end with the root certificate. Use the intermediate
|
548
|
-
# certificates that were provided by your certificate authority. Do not
|
549
|
-
# include any intermediaries that are not in the chain of trust path.
|
554
|
+
# @option params [String] :certificate_arn
|
555
|
+
# The reference to an AWS-managed certificate. AWS Certificate Manager
|
556
|
+
# is the only supported source.
|
550
557
|
#
|
551
558
|
# @return [Types::DomainName] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
552
559
|
#
|
553
560
|
# * {Types::DomainName#domain_name #domain_name} => String
|
554
561
|
# * {Types::DomainName#certificate_name #certificate_name} => String
|
562
|
+
# * {Types::DomainName#certificate_arn #certificate_arn} => String
|
555
563
|
# * {Types::DomainName#certificate_upload_date #certificate_upload_date} => Time
|
556
564
|
# * {Types::DomainName#distribution_domain_name #distribution_domain_name} => String
|
557
565
|
#
|
@@ -559,16 +567,18 @@ module Aws::APIGateway
|
|
559
567
|
#
|
560
568
|
# resp = client.create_domain_name({
|
561
569
|
# domain_name: "String", # required
|
562
|
-
# certificate_name: "String",
|
563
|
-
# certificate_body: "String",
|
564
|
-
# certificate_private_key: "String",
|
565
|
-
# certificate_chain: "String",
|
570
|
+
# certificate_name: "String",
|
571
|
+
# certificate_body: "String",
|
572
|
+
# certificate_private_key: "String",
|
573
|
+
# certificate_chain: "String",
|
574
|
+
# certificate_arn: "String",
|
566
575
|
# })
|
567
576
|
#
|
568
577
|
# @example Response structure
|
569
578
|
#
|
570
579
|
# resp.domain_name #=> String
|
571
580
|
# resp.certificate_name #=> String
|
581
|
+
# resp.certificate_arn #=> String
|
572
582
|
# resp.certificate_upload_date #=> Time
|
573
583
|
# resp.distribution_domain_name #=> String
|
574
584
|
#
|
@@ -634,6 +644,54 @@ module Aws::APIGateway
|
|
634
644
|
req.send_request(options)
|
635
645
|
end
|
636
646
|
|
647
|
+
# Creates a ReqeustValidator of a given RestApi.
|
648
|
+
#
|
649
|
+
# @option params [required, String] :rest_api_id
|
650
|
+
# \[Required\] The identifier of the RestApi for which the
|
651
|
+
# RequestValidator is created.
|
652
|
+
#
|
653
|
+
# @option params [String] :name
|
654
|
+
# The name of the to-be-created RequestValidator.
|
655
|
+
#
|
656
|
+
# @option params [Boolean] :validate_request_body
|
657
|
+
# A Boolean flag to indicate whether to validate request body according
|
658
|
+
# to the configured model schema for the method (`true`) or not
|
659
|
+
# (`false`).
|
660
|
+
#
|
661
|
+
# @option params [Boolean] :validate_request_parameters
|
662
|
+
# A Boolean flag to indicate whether to validate request parameters,
|
663
|
+
# `true`, or not `false`.
|
664
|
+
#
|
665
|
+
# @return [Types::RequestValidator] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
666
|
+
#
|
667
|
+
# * {Types::RequestValidator#id #id} => String
|
668
|
+
# * {Types::RequestValidator#name #name} => String
|
669
|
+
# * {Types::RequestValidator#validate_request_body #validate_request_body} => Boolean
|
670
|
+
# * {Types::RequestValidator#validate_request_parameters #validate_request_parameters} => Boolean
|
671
|
+
#
|
672
|
+
# @example Request syntax with placeholder values
|
673
|
+
#
|
674
|
+
# resp = client.create_request_validator({
|
675
|
+
# rest_api_id: "String", # required
|
676
|
+
# name: "String",
|
677
|
+
# validate_request_body: false,
|
678
|
+
# validate_request_parameters: false,
|
679
|
+
# })
|
680
|
+
#
|
681
|
+
# @example Response structure
|
682
|
+
#
|
683
|
+
# resp.id #=> String
|
684
|
+
# resp.name #=> String
|
685
|
+
# resp.validate_request_body #=> Boolean
|
686
|
+
# resp.validate_request_parameters #=> Boolean
|
687
|
+
#
|
688
|
+
# @overload create_request_validator(params = {})
|
689
|
+
# @param [Hash] params ({})
|
690
|
+
def create_request_validator(params = {}, options = {})
|
691
|
+
req = build_request(:create_request_validator, params)
|
692
|
+
req.send_request(options)
|
693
|
+
end
|
694
|
+
|
637
695
|
# Creates a Resource resource.
|
638
696
|
#
|
639
697
|
# @option params [required, String] :rest_api_id
|
@@ -672,6 +730,7 @@ module Aws::APIGateway
|
|
672
730
|
# resp.resource_methods["String"].authorization_type #=> String
|
673
731
|
# resp.resource_methods["String"].authorizer_id #=> String
|
674
732
|
# resp.resource_methods["String"].api_key_required #=> Boolean
|
733
|
+
# resp.resource_methods["String"].request_validator_id #=> String
|
675
734
|
# resp.resource_methods["String"].operation_name #=> String
|
676
735
|
# resp.resource_methods["String"].request_parameters #=> Hash
|
677
736
|
# resp.resource_methods["String"].request_parameters["String"] #=> Boolean
|
@@ -1311,6 +1370,31 @@ module Aws::APIGateway
|
|
1311
1370
|
req.send_request(options)
|
1312
1371
|
end
|
1313
1372
|
|
1373
|
+
# Deletes a RequestValidator of a given RestApi.
|
1374
|
+
#
|
1375
|
+
# @option params [required, String] :rest_api_id
|
1376
|
+
# \[Required\] The identifier of the RestApi from which the given
|
1377
|
+
# RequestValidator is deleted.
|
1378
|
+
#
|
1379
|
+
# @option params [required, String] :request_validator_id
|
1380
|
+
# \[Required\] The identifier of the RequestValidator to be deleted.
|
1381
|
+
#
|
1382
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1383
|
+
#
|
1384
|
+
# @example Request syntax with placeholder values
|
1385
|
+
#
|
1386
|
+
# resp = client.delete_request_validator({
|
1387
|
+
# rest_api_id: "String", # required
|
1388
|
+
# request_validator_id: "String", # required
|
1389
|
+
# })
|
1390
|
+
#
|
1391
|
+
# @overload delete_request_validator(params = {})
|
1392
|
+
# @param [Hash] params ({})
|
1393
|
+
def delete_request_validator(params = {}, options = {})
|
1394
|
+
req = build_request(:delete_request_validator, params)
|
1395
|
+
req.send_request(options)
|
1396
|
+
end
|
1397
|
+
|
1314
1398
|
# Deletes a Resource resource.
|
1315
1399
|
#
|
1316
1400
|
# @option params [required, String] :rest_api_id
|
@@ -1585,7 +1669,7 @@ module Aws::APIGateway
|
|
1585
1669
|
# Gets information about the current ApiKeys resource.
|
1586
1670
|
#
|
1587
1671
|
# @option params [String] :position
|
1588
|
-
# The position
|
1672
|
+
# The current pagination position in the paged result set.
|
1589
1673
|
#
|
1590
1674
|
# @option params [Integer] :limit
|
1591
1675
|
# The maximum number of ApiKeys to get information about.
|
@@ -1712,11 +1796,10 @@ module Aws::APIGateway
|
|
1712
1796
|
# The RestApi identifier for the Authorizers resource.
|
1713
1797
|
#
|
1714
1798
|
# @option params [String] :position
|
1715
|
-
#
|
1716
|
-
# position will specify where to start the next page of results.
|
1799
|
+
# The current pagination position in the paged result set.
|
1717
1800
|
#
|
1718
1801
|
# @option params [Integer] :limit
|
1719
|
-
#
|
1802
|
+
# The maximum number of returned results per page.
|
1720
1803
|
#
|
1721
1804
|
# @return [Types::Authorizers] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1722
1805
|
#
|
@@ -1797,13 +1880,11 @@ module Aws::APIGateway
|
|
1797
1880
|
# The domain name of a BasePathMapping resource.
|
1798
1881
|
#
|
1799
1882
|
# @option params [String] :position
|
1800
|
-
# The
|
1801
|
-
# to get information about.
|
1883
|
+
# The current pagination position in the paged result set.
|
1802
1884
|
#
|
1803
1885
|
# @option params [Integer] :limit
|
1804
|
-
# The maximum number of
|
1805
|
-
#
|
1806
|
-
# integer between 1 - 500.
|
1886
|
+
# The maximum number of returned results per page. The value is 25 by
|
1887
|
+
# default and could be between 1 - 500.
|
1807
1888
|
#
|
1808
1889
|
# @return [Types::BasePathMappings] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1809
1890
|
#
|
@@ -1870,13 +1951,11 @@ module Aws::APIGateway
|
|
1870
1951
|
# Gets a collection of ClientCertificate resources.
|
1871
1952
|
#
|
1872
1953
|
# @option params [String] :position
|
1873
|
-
# The position
|
1874
|
-
# collection to get information about.
|
1954
|
+
# The current pagination position in the paged result set.
|
1875
1955
|
#
|
1876
1956
|
# @option params [Integer] :limit
|
1877
|
-
# The maximum number of
|
1878
|
-
#
|
1879
|
-
# integer between 1 - 500.
|
1957
|
+
# The maximum number of returned results per page. The value is 25 by
|
1958
|
+
# default and could be between 1 - 500.
|
1880
1959
|
#
|
1881
1960
|
# @return [Types::ClientCertificates] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1882
1961
|
#
|
@@ -1916,6 +1995,19 @@ module Aws::APIGateway
|
|
1916
1995
|
# @option params [required, String] :deployment_id
|
1917
1996
|
# The identifier of the Deployment resource to get information about.
|
1918
1997
|
#
|
1998
|
+
# @option params [Array<String>] :embed
|
1999
|
+
# A query parameter to retrieve the specified embedded resources of the
|
2000
|
+
# returned Deployment resource in the response. In a REST API call, this
|
2001
|
+
# `embed` parameter value is a list of comma-separated strings, as in
|
2002
|
+
# `GET
|
2003
|
+
# /restapis/\{restapi_id\}/deployments/\{deployment_id\}?embed=var1,var2`.
|
2004
|
+
# The SDK and other platform-dependent libraries might use a different
|
2005
|
+
# format for the list. Currently, this request supports only retrieval
|
2006
|
+
# of the embedded API summary this way. Hence, the parameter value must
|
2007
|
+
# be a single-valued list containing only the `"apisummary"` string. For
|
2008
|
+
# example, `GET
|
2009
|
+
# /restapis/\{restapi_id\}/deployments/\{deployment_id\}?embed=apisummary`.
|
2010
|
+
#
|
1919
2011
|
# @return [Types::Deployment] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1920
2012
|
#
|
1921
2013
|
# * {Types::Deployment#id #id} => String
|
@@ -1928,6 +2020,7 @@ module Aws::APIGateway
|
|
1928
2020
|
# resp = client.get_deployment({
|
1929
2021
|
# rest_api_id: "String", # required
|
1930
2022
|
# deployment_id: "String", # required
|
2023
|
+
# embed: ["String"],
|
1931
2024
|
# })
|
1932
2025
|
#
|
1933
2026
|
# @example Response structure
|
@@ -1954,13 +2047,11 @@ module Aws::APIGateway
|
|
1954
2047
|
# Deployment resources to get information about.
|
1955
2048
|
#
|
1956
2049
|
# @option params [String] :position
|
1957
|
-
# The
|
1958
|
-
# get information about.
|
2050
|
+
# The current pagination position in the paged result set.
|
1959
2051
|
#
|
1960
2052
|
# @option params [Integer] :limit
|
1961
|
-
# The maximum number of
|
1962
|
-
#
|
1963
|
-
# between 1 - 500.
|
2053
|
+
# The maximum number of returned results per page. The value is 25 by
|
2054
|
+
# default and could be between 1 - 500.
|
1964
2055
|
#
|
1965
2056
|
# @return [Types::Deployments] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1966
2057
|
#
|
@@ -2045,11 +2136,10 @@ module Aws::APIGateway
|
|
2045
2136
|
# The path of API entities of the to-be-retrieved documentation parts.
|
2046
2137
|
#
|
2047
2138
|
# @option params [String] :position
|
2048
|
-
# The position
|
2049
|
-
# DocumentationParts collection.
|
2139
|
+
# The current pagination position in the paged result set.
|
2050
2140
|
#
|
2051
2141
|
# @option params [Integer] :limit
|
2052
|
-
# The
|
2142
|
+
# The maximum number of returned results per page.
|
2053
2143
|
#
|
2054
2144
|
# @return [Types::DocumentationParts] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2055
2145
|
#
|
@@ -2125,11 +2215,10 @@ module Aws::APIGateway
|
|
2125
2215
|
# documentation versions.
|
2126
2216
|
#
|
2127
2217
|
# @option params [String] :position
|
2128
|
-
# The position
|
2129
|
-
# DocumentationVersions collection.
|
2218
|
+
# The current pagination position in the paged result set.
|
2130
2219
|
#
|
2131
2220
|
# @option params [Integer] :limit
|
2132
|
-
# The
|
2221
|
+
# The maximum number of returned results per page.
|
2133
2222
|
#
|
2134
2223
|
# @return [Types::DocumentationVersions] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2135
2224
|
#
|
@@ -2169,6 +2258,7 @@ module Aws::APIGateway
|
|
2169
2258
|
#
|
2170
2259
|
# * {Types::DomainName#domain_name #domain_name} => String
|
2171
2260
|
# * {Types::DomainName#certificate_name #certificate_name} => String
|
2261
|
+
# * {Types::DomainName#certificate_arn #certificate_arn} => String
|
2172
2262
|
# * {Types::DomainName#certificate_upload_date #certificate_upload_date} => Time
|
2173
2263
|
# * {Types::DomainName#distribution_domain_name #distribution_domain_name} => String
|
2174
2264
|
#
|
@@ -2182,6 +2272,7 @@ module Aws::APIGateway
|
|
2182
2272
|
#
|
2183
2273
|
# resp.domain_name #=> String
|
2184
2274
|
# resp.certificate_name #=> String
|
2275
|
+
# resp.certificate_arn #=> String
|
2185
2276
|
# resp.certificate_upload_date #=> Time
|
2186
2277
|
# resp.distribution_domain_name #=> String
|
2187
2278
|
#
|
@@ -2195,12 +2286,11 @@ module Aws::APIGateway
|
|
2195
2286
|
# Represents a collection of DomainName resources.
|
2196
2287
|
#
|
2197
2288
|
# @option params [String] :position
|
2198
|
-
# The position
|
2289
|
+
# The current pagination position in the paged result set.
|
2199
2290
|
#
|
2200
2291
|
# @option params [Integer] :limit
|
2201
|
-
# The maximum number of
|
2202
|
-
#
|
2203
|
-
# between 1 - 500.
|
2292
|
+
# The maximum number of returned results per page. The value is 25 by
|
2293
|
+
# default and could be between 1 - 500.
|
2204
2294
|
#
|
2205
2295
|
# @return [Types::DomainNames] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2206
2296
|
#
|
@@ -2220,6 +2310,7 @@ module Aws::APIGateway
|
|
2220
2310
|
# resp.items #=> Array
|
2221
2311
|
# resp.items[0].domain_name #=> String
|
2222
2312
|
# resp.items[0].certificate_name #=> String
|
2313
|
+
# resp.items[0].certificate_arn #=> String
|
2223
2314
|
# resp.items[0].certificate_upload_date #=> Time
|
2224
2315
|
# resp.items[0].distribution_domain_name #=> String
|
2225
2316
|
#
|
@@ -2417,6 +2508,7 @@ module Aws::APIGateway
|
|
2417
2508
|
# * {Types::Method#authorization_type #authorization_type} => String
|
2418
2509
|
# * {Types::Method#authorizer_id #authorizer_id} => String
|
2419
2510
|
# * {Types::Method#api_key_required #api_key_required} => Boolean
|
2511
|
+
# * {Types::Method#request_validator_id #request_validator_id} => String
|
2420
2512
|
# * {Types::Method#operation_name #operation_name} => String
|
2421
2513
|
# * {Types::Method#request_parameters #request_parameters} => Hash<String,Boolean>
|
2422
2514
|
# * {Types::Method#request_models #request_models} => Hash<String,String>
|
@@ -2437,6 +2529,7 @@ module Aws::APIGateway
|
|
2437
2529
|
# resp.authorization_type #=> String
|
2438
2530
|
# resp.authorizer_id #=> String
|
2439
2531
|
# resp.api_key_required #=> Boolean
|
2532
|
+
# resp.request_validator_id #=> String
|
2440
2533
|
# resp.operation_name #=> String
|
2441
2534
|
# resp.request_parameters #=> Hash
|
2442
2535
|
# resp.request_parameters["String"] #=> Boolean
|
@@ -2602,13 +2695,11 @@ module Aws::APIGateway
|
|
2602
2695
|
# The RestApi identifier.
|
2603
2696
|
#
|
2604
2697
|
# @option params [String] :position
|
2605
|
-
# The
|
2606
|
-
# information about.
|
2698
|
+
# The current pagination position in the paged result set.
|
2607
2699
|
#
|
2608
2700
|
# @option params [Integer] :limit
|
2609
|
-
# The maximum number of
|
2610
|
-
#
|
2611
|
-
# 500.
|
2701
|
+
# The maximum number of returned results per page. The value is 25 by
|
2702
|
+
# default and could be between 1 - 500.
|
2612
2703
|
#
|
2613
2704
|
# @return [Types::Models] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2614
2705
|
#
|
@@ -2640,6 +2731,84 @@ module Aws::APIGateway
|
|
2640
2731
|
req.send_request(options)
|
2641
2732
|
end
|
2642
2733
|
|
2734
|
+
# Gets a RequestValidator of a given RestApi.
|
2735
|
+
#
|
2736
|
+
# @option params [required, String] :rest_api_id
|
2737
|
+
# \[Required\] The identifier of the RestApi to which the specified
|
2738
|
+
# RequestValidator belongs.
|
2739
|
+
#
|
2740
|
+
# @option params [required, String] :request_validator_id
|
2741
|
+
# \[Required\] The identifier of the RequestValidator to be retrieved.
|
2742
|
+
#
|
2743
|
+
# @return [Types::RequestValidator] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2744
|
+
#
|
2745
|
+
# * {Types::RequestValidator#id #id} => String
|
2746
|
+
# * {Types::RequestValidator#name #name} => String
|
2747
|
+
# * {Types::RequestValidator#validate_request_body #validate_request_body} => Boolean
|
2748
|
+
# * {Types::RequestValidator#validate_request_parameters #validate_request_parameters} => Boolean
|
2749
|
+
#
|
2750
|
+
# @example Request syntax with placeholder values
|
2751
|
+
#
|
2752
|
+
# resp = client.get_request_validator({
|
2753
|
+
# rest_api_id: "String", # required
|
2754
|
+
# request_validator_id: "String", # required
|
2755
|
+
# })
|
2756
|
+
#
|
2757
|
+
# @example Response structure
|
2758
|
+
#
|
2759
|
+
# resp.id #=> String
|
2760
|
+
# resp.name #=> String
|
2761
|
+
# resp.validate_request_body #=> Boolean
|
2762
|
+
# resp.validate_request_parameters #=> Boolean
|
2763
|
+
#
|
2764
|
+
# @overload get_request_validator(params = {})
|
2765
|
+
# @param [Hash] params ({})
|
2766
|
+
def get_request_validator(params = {}, options = {})
|
2767
|
+
req = build_request(:get_request_validator, params)
|
2768
|
+
req.send_request(options)
|
2769
|
+
end
|
2770
|
+
|
2771
|
+
# Gets the RequestValidators collection of a given RestApi.
|
2772
|
+
#
|
2773
|
+
# @option params [required, String] :rest_api_id
|
2774
|
+
# \[Required\] The identifier of a RestApi to which the
|
2775
|
+
# RequestValidators collection belongs.
|
2776
|
+
#
|
2777
|
+
# @option params [String] :position
|
2778
|
+
# The current pagination position in the paged result set.
|
2779
|
+
#
|
2780
|
+
# @option params [Integer] :limit
|
2781
|
+
# The maximum number of returned results per page.
|
2782
|
+
#
|
2783
|
+
# @return [Types::RequestValidators] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2784
|
+
#
|
2785
|
+
# * {Types::RequestValidators#position #position} => String
|
2786
|
+
# * {Types::RequestValidators#items #items} => Array<Types::RequestValidator>
|
2787
|
+
#
|
2788
|
+
# @example Request syntax with placeholder values
|
2789
|
+
#
|
2790
|
+
# resp = client.get_request_validators({
|
2791
|
+
# rest_api_id: "String", # required
|
2792
|
+
# position: "String",
|
2793
|
+
# limit: 1,
|
2794
|
+
# })
|
2795
|
+
#
|
2796
|
+
# @example Response structure
|
2797
|
+
#
|
2798
|
+
# resp.position #=> String
|
2799
|
+
# resp.items #=> Array
|
2800
|
+
# resp.items[0].id #=> String
|
2801
|
+
# resp.items[0].name #=> String
|
2802
|
+
# resp.items[0].validate_request_body #=> Boolean
|
2803
|
+
# resp.items[0].validate_request_parameters #=> Boolean
|
2804
|
+
#
|
2805
|
+
# @overload get_request_validators(params = {})
|
2806
|
+
# @param [Hash] params ({})
|
2807
|
+
def get_request_validators(params = {}, options = {})
|
2808
|
+
req = build_request(:get_request_validators, params)
|
2809
|
+
req.send_request(options)
|
2810
|
+
end
|
2811
|
+
|
2643
2812
|
# Lists information about a resource.
|
2644
2813
|
#
|
2645
2814
|
# @option params [required, String] :rest_api_id
|
@@ -2648,6 +2817,15 @@ module Aws::APIGateway
|
|
2648
2817
|
# @option params [required, String] :resource_id
|
2649
2818
|
# The identifier for the Resource resource.
|
2650
2819
|
#
|
2820
|
+
# @option params [Array<String>] :embed
|
2821
|
+
# A query parameter to retrieve the specified resources embedded in the
|
2822
|
+
# returned Resource representation in the response. This `embed`
|
2823
|
+
# parameter value is a list of comma-separated strings. Currently, the
|
2824
|
+
# request supports only retrieval of the embedded Method resources this
|
2825
|
+
# way. The query parameter value must be a single-valued list and
|
2826
|
+
# contain the `"methods"` string. For example, `GET
|
2827
|
+
# /restapis/\{restapi_id\}/resources/\{resource_id\}?embed=methods`.
|
2828
|
+
#
|
2651
2829
|
# @return [Types::Resource] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2652
2830
|
#
|
2653
2831
|
# * {Types::Resource#id #id} => String
|
@@ -2661,6 +2839,7 @@ module Aws::APIGateway
|
|
2661
2839
|
# resp = client.get_resource({
|
2662
2840
|
# rest_api_id: "String", # required
|
2663
2841
|
# resource_id: "String", # required
|
2842
|
+
# embed: ["String"],
|
2664
2843
|
# })
|
2665
2844
|
#
|
2666
2845
|
# @example Response structure
|
@@ -2674,6 +2853,7 @@ module Aws::APIGateway
|
|
2674
2853
|
# resp.resource_methods["String"].authorization_type #=> String
|
2675
2854
|
# resp.resource_methods["String"].authorizer_id #=> String
|
2676
2855
|
# resp.resource_methods["String"].api_key_required #=> Boolean
|
2856
|
+
# resp.resource_methods["String"].request_validator_id #=> String
|
2677
2857
|
# resp.resource_methods["String"].operation_name #=> String
|
2678
2858
|
# resp.resource_methods["String"].request_parameters #=> Hash
|
2679
2859
|
# resp.resource_methods["String"].request_parameters["String"] #=> Boolean
|
@@ -2720,13 +2900,20 @@ module Aws::APIGateway
|
|
2720
2900
|
# The RestApi identifier for the Resource.
|
2721
2901
|
#
|
2722
2902
|
# @option params [String] :position
|
2723
|
-
# The
|
2724
|
-
# resource to get information about.
|
2903
|
+
# The current pagination position in the paged result set.
|
2725
2904
|
#
|
2726
2905
|
# @option params [Integer] :limit
|
2727
|
-
# The maximum number of
|
2728
|
-
#
|
2729
|
-
#
|
2906
|
+
# The maximum number of returned results per page. The value is 25 by
|
2907
|
+
# default and could be between 1 - 500.
|
2908
|
+
#
|
2909
|
+
# @option params [Array<String>] :embed
|
2910
|
+
# A query parameter used to retrieve the specified resources embedded in
|
2911
|
+
# the returned Resources resource in the response. This `embed`
|
2912
|
+
# parameter value is a list of comma-separated strings. Currently, the
|
2913
|
+
# request supports only retrieval of the embedded Method resources this
|
2914
|
+
# way. The query parameter value must be a single-valued list and
|
2915
|
+
# contain the `"methods"` string. For example, `GET
|
2916
|
+
# /restapis/\{restapi_id\}/resources?embed=methods`.
|
2730
2917
|
#
|
2731
2918
|
# @return [Types::Resources] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2732
2919
|
#
|
@@ -2739,6 +2926,7 @@ module Aws::APIGateway
|
|
2739
2926
|
# rest_api_id: "String", # required
|
2740
2927
|
# position: "String",
|
2741
2928
|
# limit: 1,
|
2929
|
+
# embed: ["String"],
|
2742
2930
|
# })
|
2743
2931
|
#
|
2744
2932
|
# @example Response structure
|
@@ -2754,6 +2942,7 @@ module Aws::APIGateway
|
|
2754
2942
|
# resp.items[0].resource_methods["String"].authorization_type #=> String
|
2755
2943
|
# resp.items[0].resource_methods["String"].authorizer_id #=> String
|
2756
2944
|
# resp.items[0].resource_methods["String"].api_key_required #=> Boolean
|
2945
|
+
# resp.items[0].resource_methods["String"].request_validator_id #=> String
|
2757
2946
|
# resp.items[0].resource_methods["String"].operation_name #=> String
|
2758
2947
|
# resp.items[0].resource_methods["String"].request_parameters #=> Hash
|
2759
2948
|
# resp.items[0].resource_methods["String"].request_parameters["String"] #=> Boolean
|
@@ -2837,13 +3026,11 @@ module Aws::APIGateway
|
|
2837
3026
|
# Lists the RestApis resources for your collection.
|
2838
3027
|
#
|
2839
3028
|
# @option params [String] :position
|
2840
|
-
# The
|
2841
|
-
# information about.
|
3029
|
+
# The current pagination position in the paged result set.
|
2842
3030
|
#
|
2843
3031
|
# @option params [Integer] :limit
|
2844
|
-
# The maximum number of
|
2845
|
-
#
|
2846
|
-
# between 1 - 500.
|
3032
|
+
# The maximum number of returned results per page. The value is 25 by
|
3033
|
+
# default and could be between 1 - 500.
|
2847
3034
|
#
|
2848
3035
|
# @return [Types::RestApis] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2849
3036
|
#
|
@@ -2963,10 +3150,10 @@ module Aws::APIGateway
|
|
2963
3150
|
end
|
2964
3151
|
|
2965
3152
|
# @option params [String] :position
|
2966
|
-
# The
|
3153
|
+
# The current pagination position in the paged result set.
|
2967
3154
|
#
|
2968
3155
|
# @option params [Integer] :limit
|
2969
|
-
# The maximum number of
|
3156
|
+
# The maximum number of returned results per page.
|
2970
3157
|
#
|
2971
3158
|
# @return [Types::SdkTypes] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2972
3159
|
#
|
@@ -3133,10 +3320,10 @@ module Aws::APIGateway
|
|
3133
3320
|
# The ending date (e.g., 2016-12-31) of the usage data.
|
3134
3321
|
#
|
3135
3322
|
# @option params [String] :position
|
3136
|
-
#
|
3323
|
+
# The current pagination position in the paged result set.
|
3137
3324
|
#
|
3138
3325
|
# @option params [Integer] :limit
|
3139
|
-
# The maximum number of results
|
3326
|
+
# The maximum number of returned results per page.
|
3140
3327
|
#
|
3141
3328
|
# @return [Types::Usage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3142
3329
|
#
|
@@ -3266,12 +3453,10 @@ module Aws::APIGateway
|
|
3266
3453
|
# plan customer.
|
3267
3454
|
#
|
3268
3455
|
# @option params [String] :position
|
3269
|
-
#
|
3270
|
-
# position of a usage plan key.
|
3456
|
+
# The current pagination position in the paged result set.
|
3271
3457
|
#
|
3272
3458
|
# @option params [Integer] :limit
|
3273
|
-
#
|
3274
|
-
# returned by the GET request.
|
3459
|
+
# The maximum number of returned results per page.
|
3275
3460
|
#
|
3276
3461
|
# @option params [String] :name_query
|
3277
3462
|
# A query parameter specifying the name of the to-be-returned usage plan
|
@@ -3310,14 +3495,13 @@ module Aws::APIGateway
|
|
3310
3495
|
# Gets all the usage plans of the caller's account.
|
3311
3496
|
#
|
3312
3497
|
# @option params [String] :position
|
3313
|
-
# The
|
3314
|
-
# to-be-retrieved UsagePlan resource.
|
3498
|
+
# The current pagination position in the paged result set.
|
3315
3499
|
#
|
3316
3500
|
# @option params [String] :key_id
|
3317
3501
|
# The identifier of the API key associated with the usage plans.
|
3318
3502
|
#
|
3319
3503
|
# @option params [Integer] :limit
|
3320
|
-
# The number of
|
3504
|
+
# The maximum number of returned results per page.
|
3321
3505
|
#
|
3322
3506
|
# @return [Types::UsagePlans] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3323
3507
|
#
|
@@ -3758,7 +3942,10 @@ module Aws::APIGateway
|
|
3758
3942
|
# Specifies the method request's HTTP method type.
|
3759
3943
|
#
|
3760
3944
|
# @option params [required, String] :authorization_type
|
3761
|
-
#
|
3945
|
+
# The method's authorization type. Valid values are `NONE` for open
|
3946
|
+
# access, `AWS_IAM` for using AWS IAM permissions, `CUSTOM` for using a
|
3947
|
+
# custom authorizer, or `COGNITO_USER_POOLS` for using a Cognito user
|
3948
|
+
# pool.
|
3762
3949
|
#
|
3763
3950
|
# @option params [String] :authorizer_id
|
3764
3951
|
# Specifies the identifier of an Authorizer to use on this Method, if
|
@@ -3793,12 +3980,17 @@ module Aws::APIGateway
|
|
3793
3980
|
# Request models are represented as a key/value map, with a content type
|
3794
3981
|
# as the key and a Model name as the value.
|
3795
3982
|
#
|
3983
|
+
# @option params [String] :request_validator_id
|
3984
|
+
# The identifier of a RequestValidator for validating the method
|
3985
|
+
# request.
|
3986
|
+
#
|
3796
3987
|
# @return [Types::Method] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3797
3988
|
#
|
3798
3989
|
# * {Types::Method#http_method #http_method} => String
|
3799
3990
|
# * {Types::Method#authorization_type #authorization_type} => String
|
3800
3991
|
# * {Types::Method#authorizer_id #authorizer_id} => String
|
3801
3992
|
# * {Types::Method#api_key_required #api_key_required} => Boolean
|
3993
|
+
# * {Types::Method#request_validator_id #request_validator_id} => String
|
3802
3994
|
# * {Types::Method#operation_name #operation_name} => String
|
3803
3995
|
# * {Types::Method#request_parameters #request_parameters} => Hash<String,Boolean>
|
3804
3996
|
# * {Types::Method#request_models #request_models} => Hash<String,String>
|
@@ -3821,6 +4013,7 @@ module Aws::APIGateway
|
|
3821
4013
|
# request_models: {
|
3822
4014
|
# "String" => "String",
|
3823
4015
|
# },
|
4016
|
+
# request_validator_id: "String",
|
3824
4017
|
# })
|
3825
4018
|
#
|
3826
4019
|
# @example Response structure
|
@@ -3829,6 +4022,7 @@ module Aws::APIGateway
|
|
3829
4022
|
# resp.authorization_type #=> String
|
3830
4023
|
# resp.authorizer_id #=> String
|
3831
4024
|
# resp.api_key_required #=> Boolean
|
4025
|
+
# resp.request_validator_id #=> String
|
3832
4026
|
# resp.operation_name #=> String
|
3833
4027
|
# resp.request_parameters #=> Hash
|
3834
4028
|
# resp.request_parameters["String"] #=> Boolean
|
@@ -4584,6 +4778,7 @@ module Aws::APIGateway
|
|
4584
4778
|
#
|
4585
4779
|
# * {Types::DomainName#domain_name #domain_name} => String
|
4586
4780
|
# * {Types::DomainName#certificate_name #certificate_name} => String
|
4781
|
+
# * {Types::DomainName#certificate_arn #certificate_arn} => String
|
4587
4782
|
# * {Types::DomainName#certificate_upload_date #certificate_upload_date} => Time
|
4588
4783
|
# * {Types::DomainName#distribution_domain_name #distribution_domain_name} => String
|
4589
4784
|
#
|
@@ -4605,6 +4800,7 @@ module Aws::APIGateway
|
|
4605
4800
|
#
|
4606
4801
|
# resp.domain_name #=> String
|
4607
4802
|
# resp.certificate_name #=> String
|
4803
|
+
# resp.certificate_arn #=> String
|
4608
4804
|
# resp.certificate_upload_date #=> Time
|
4609
4805
|
# resp.distribution_domain_name #=> String
|
4610
4806
|
#
|
@@ -4773,6 +4969,7 @@ module Aws::APIGateway
|
|
4773
4969
|
# * {Types::Method#authorization_type #authorization_type} => String
|
4774
4970
|
# * {Types::Method#authorizer_id #authorizer_id} => String
|
4775
4971
|
# * {Types::Method#api_key_required #api_key_required} => Boolean
|
4972
|
+
# * {Types::Method#request_validator_id #request_validator_id} => String
|
4776
4973
|
# * {Types::Method#operation_name #operation_name} => String
|
4777
4974
|
# * {Types::Method#request_parameters #request_parameters} => Hash<String,Boolean>
|
4778
4975
|
# * {Types::Method#request_models #request_models} => Hash<String,String>
|
@@ -4801,6 +4998,7 @@ module Aws::APIGateway
|
|
4801
4998
|
# resp.authorization_type #=> String
|
4802
4999
|
# resp.authorizer_id #=> String
|
4803
5000
|
# resp.api_key_required #=> Boolean
|
5001
|
+
# resp.request_validator_id #=> String
|
4804
5002
|
# resp.operation_name #=> String
|
4805
5003
|
# resp.request_parameters #=> Hash
|
4806
5004
|
# resp.request_parameters["String"] #=> Boolean
|
@@ -4947,6 +5145,55 @@ module Aws::APIGateway
|
|
4947
5145
|
req.send_request(options)
|
4948
5146
|
end
|
4949
5147
|
|
5148
|
+
# Updates a RequestValidator of a given RestApi.
|
5149
|
+
#
|
5150
|
+
# @option params [required, String] :rest_api_id
|
5151
|
+
# \[Required\] The identifier of the RestApi for which the given
|
5152
|
+
# RequestValidator is updated.
|
5153
|
+
#
|
5154
|
+
# @option params [required, String] :request_validator_id
|
5155
|
+
# \[Required\] The identifier of RequestValidator to be updated.
|
5156
|
+
#
|
5157
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
5158
|
+
# A list of update operations to be applied to the specified resource
|
5159
|
+
# and in the order specified in this list.
|
5160
|
+
#
|
5161
|
+
# @return [Types::RequestValidator] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5162
|
+
#
|
5163
|
+
# * {Types::RequestValidator#id #id} => String
|
5164
|
+
# * {Types::RequestValidator#name #name} => String
|
5165
|
+
# * {Types::RequestValidator#validate_request_body #validate_request_body} => Boolean
|
5166
|
+
# * {Types::RequestValidator#validate_request_parameters #validate_request_parameters} => Boolean
|
5167
|
+
#
|
5168
|
+
# @example Request syntax with placeholder values
|
5169
|
+
#
|
5170
|
+
# resp = client.update_request_validator({
|
5171
|
+
# rest_api_id: "String", # required
|
5172
|
+
# request_validator_id: "String", # required
|
5173
|
+
# patch_operations: [
|
5174
|
+
# {
|
5175
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
5176
|
+
# path: "String",
|
5177
|
+
# value: "String",
|
5178
|
+
# from: "String",
|
5179
|
+
# },
|
5180
|
+
# ],
|
5181
|
+
# })
|
5182
|
+
#
|
5183
|
+
# @example Response structure
|
5184
|
+
#
|
5185
|
+
# resp.id #=> String
|
5186
|
+
# resp.name #=> String
|
5187
|
+
# resp.validate_request_body #=> Boolean
|
5188
|
+
# resp.validate_request_parameters #=> Boolean
|
5189
|
+
#
|
5190
|
+
# @overload update_request_validator(params = {})
|
5191
|
+
# @param [Hash] params ({})
|
5192
|
+
def update_request_validator(params = {}, options = {})
|
5193
|
+
req = build_request(:update_request_validator, params)
|
5194
|
+
req.send_request(options)
|
5195
|
+
end
|
5196
|
+
|
4950
5197
|
# Changes information about a Resource resource.
|
4951
5198
|
#
|
4952
5199
|
# @option params [required, String] :rest_api_id
|
@@ -4993,6 +5240,7 @@ module Aws::APIGateway
|
|
4993
5240
|
# resp.resource_methods["String"].authorization_type #=> String
|
4994
5241
|
# resp.resource_methods["String"].authorizer_id #=> String
|
4995
5242
|
# resp.resource_methods["String"].api_key_required #=> Boolean
|
5243
|
+
# resp.resource_methods["String"].request_validator_id #=> String
|
4996
5244
|
# resp.resource_methods["String"].operation_name #=> String
|
4997
5245
|
# resp.resource_methods["String"].request_parameters #=> Hash
|
4998
5246
|
# resp.resource_methods["String"].request_parameters["String"] #=> Boolean
|
@@ -5284,7 +5532,7 @@ module Aws::APIGateway
|
|
5284
5532
|
params: params,
|
5285
5533
|
config: config)
|
5286
5534
|
context[:gem_name] = 'aws-sdk-apigateway'
|
5287
|
-
context[:gem_version] = '1.0.0.
|
5535
|
+
context[:gem_version] = '1.0.0.rc4'
|
5288
5536
|
Seahorse::Client::Request.new(handlers, context)
|
5289
5537
|
end
|
5290
5538
|
|