aws-sdk-apigateway 1.0.0.rc1 → 1.0.0.rc2
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 +426 -1
- data/lib/aws-sdk-apigateway/client_api.rb +259 -0
- data/lib/aws-sdk-apigateway/types.rb +644 -5
- 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: 04f16be0304c5a2f86c968c84ce85b277b2b4719
|
4
|
+
data.tar.gz: 7b0a9045ab67ea1d8a61a1cd45d42d644f3c4fcb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a5cde3109b05dc066aaa24de0e0f267d26b62cc5ee24f2feba9ef1e7bdbc227dd4b57b8680afb4c91e5e9b0defed52f3173634b3af38bdad7ae0e5c8c9d25af5
|
7
|
+
data.tar.gz: 9408545fca6c8341e4fa1dd17851a1aaeed3361b3b01912d81d5bcb83a348225966c89f0da19121f95540451226f63135639660577b38bf5ed1eeb3869853706
|
data/lib/aws-sdk-apigateway.rb
CHANGED
@@ -155,11 +155,15 @@ module Aws
|
|
155
155
|
# @option params [Array<Types::StageKey>] :stage_keys
|
156
156
|
# DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API
|
157
157
|
# key.
|
158
|
+
# @option params [String] :customer_id
|
159
|
+
# An AWS Marketplace customer identifier , when integrating with the AWS
|
160
|
+
# SaaS Marketplace.
|
158
161
|
# @return [Types::ApiKey] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
159
162
|
#
|
160
163
|
# * {Types::ApiKey#id #id} => String
|
161
164
|
# * {Types::ApiKey#value #value} => String
|
162
165
|
# * {Types::ApiKey#name #name} => String
|
166
|
+
# * {Types::ApiKey#customer_id #customerId} => String
|
163
167
|
# * {Types::ApiKey#description #description} => String
|
164
168
|
# * {Types::ApiKey#enabled #enabled} => Boolean
|
165
169
|
# * {Types::ApiKey#created_date #createdDate} => Time
|
@@ -179,12 +183,14 @@ module Aws
|
|
179
183
|
# stage_name: "String",
|
180
184
|
# },
|
181
185
|
# ],
|
186
|
+
# customer_id: "String",
|
182
187
|
# })
|
183
188
|
#
|
184
189
|
# @example Response structure
|
185
190
|
# resp.id #=> String
|
186
191
|
# resp.value #=> String
|
187
192
|
# resp.name #=> String
|
193
|
+
# resp.customer_id #=> String
|
188
194
|
# resp.description #=> String
|
189
195
|
# resp.enabled #=> Boolean
|
190
196
|
# resp.created_date #=> Time
|
@@ -370,6 +376,85 @@ module Aws
|
|
370
376
|
req.send_request(options)
|
371
377
|
end
|
372
378
|
|
379
|
+
# @option params [required, String] :rest_api_id
|
380
|
+
# \[Required\] The identifier of an API of the to-be-created
|
381
|
+
# documentation part.
|
382
|
+
# @option params [required, Types::DocumentationPartLocation] :location
|
383
|
+
# \[Required\] The location of the targeted API entity of the
|
384
|
+
# to-be-created documentation part.
|
385
|
+
# @option params [required, String] :properties
|
386
|
+
# \[Required\] The new documentation content map of the targeted API
|
387
|
+
# entity. Enclosed key-value pairs are API-specific, but only
|
388
|
+
# Swagger-compliant key-value pairs can be exported and, hence,
|
389
|
+
# published.
|
390
|
+
# @return [Types::DocumentationPart] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
391
|
+
#
|
392
|
+
# * {Types::DocumentationPart#id #id} => String
|
393
|
+
# * {Types::DocumentationPart#location #location} => Types::DocumentationPartLocation
|
394
|
+
# * {Types::DocumentationPart#properties #properties} => String
|
395
|
+
#
|
396
|
+
# @example Request syntax with placeholder values
|
397
|
+
# resp = client.create_documentation_part({
|
398
|
+
# rest_api_id: "String", # required
|
399
|
+
# location: { # required
|
400
|
+
# type: "API", # required, accepts API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY
|
401
|
+
# path: "String",
|
402
|
+
# method: "String",
|
403
|
+
# status_code: "DocumentationPartLocationStatusCode",
|
404
|
+
# name: "String",
|
405
|
+
# },
|
406
|
+
# properties: "String", # required
|
407
|
+
# })
|
408
|
+
#
|
409
|
+
# @example Response structure
|
410
|
+
# resp.id #=> String
|
411
|
+
# resp.location.type #=> String, one of "API", "AUTHORIZER", "MODEL", "RESOURCE", "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", "RESPONSE_BODY"
|
412
|
+
# resp.location.path #=> String
|
413
|
+
# resp.location.method #=> String
|
414
|
+
# resp.location.status_code #=> String
|
415
|
+
# resp.location.name #=> String
|
416
|
+
# resp.properties #=> String
|
417
|
+
# @overload create_documentation_part(params = {})
|
418
|
+
# @param [Hash] params ({})
|
419
|
+
def create_documentation_part(params = {}, options = {})
|
420
|
+
req = build_request(:create_documentation_part, params)
|
421
|
+
req.send_request(options)
|
422
|
+
end
|
423
|
+
|
424
|
+
# @option params [required, String] :rest_api_id
|
425
|
+
# \[Required\] Specifies the API identifier of the to-be-created
|
426
|
+
# documentation version.
|
427
|
+
# @option params [required, String] :documentation_version
|
428
|
+
# \[Required\] The version identifier of the new snapshot.
|
429
|
+
# @option params [String] :stage_name
|
430
|
+
# The stage name to be associated with the new documentation snapshot.
|
431
|
+
# @option params [String] :description
|
432
|
+
# A description about the new documentation snapshot.
|
433
|
+
# @return [Types::DocumentationVersion] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
434
|
+
#
|
435
|
+
# * {Types::DocumentationVersion#version #version} => String
|
436
|
+
# * {Types::DocumentationVersion#created_date #createdDate} => Time
|
437
|
+
# * {Types::DocumentationVersion#description #description} => String
|
438
|
+
#
|
439
|
+
# @example Request syntax with placeholder values
|
440
|
+
# resp = client.create_documentation_version({
|
441
|
+
# rest_api_id: "String", # required
|
442
|
+
# documentation_version: "String", # required
|
443
|
+
# stage_name: "String",
|
444
|
+
# description: "String",
|
445
|
+
# })
|
446
|
+
#
|
447
|
+
# @example Response structure
|
448
|
+
# resp.version #=> String
|
449
|
+
# resp.created_date #=> Time
|
450
|
+
# resp.description #=> String
|
451
|
+
# @overload create_documentation_version(params = {})
|
452
|
+
# @param [Hash] params ({})
|
453
|
+
def create_documentation_version(params = {}, options = {})
|
454
|
+
req = build_request(:create_documentation_version, params)
|
455
|
+
req.send_request(options)
|
456
|
+
end
|
457
|
+
|
373
458
|
# Creates a new domain name.
|
374
459
|
# @option params [required, String] :domain_name
|
375
460
|
# The name of the DomainName resource.
|
@@ -536,6 +621,8 @@ module Aws
|
|
536
621
|
# The name of the RestApi.
|
537
622
|
# @option params [String] :description
|
538
623
|
# The description of the RestApi.
|
624
|
+
# @option params [String] :version
|
625
|
+
# A version identifier for the API.
|
539
626
|
# @option params [String] :clone_from
|
540
627
|
# The ID of the RestApi that you want to clone from.
|
541
628
|
# @option params [Array<String>] :binary_media_types
|
@@ -547,6 +634,7 @@ module Aws
|
|
547
634
|
# * {Types::RestApi#name #name} => String
|
548
635
|
# * {Types::RestApi#description #description} => String
|
549
636
|
# * {Types::RestApi#created_date #createdDate} => Time
|
637
|
+
# * {Types::RestApi#version #version} => String
|
550
638
|
# * {Types::RestApi#warnings #warnings} => Array<String>
|
551
639
|
# * {Types::RestApi#binary_media_types #binaryMediaTypes} => Array<String>
|
552
640
|
#
|
@@ -554,6 +642,7 @@ module Aws
|
|
554
642
|
# resp = client.create_rest_api({
|
555
643
|
# name: "String", # required
|
556
644
|
# description: "String",
|
645
|
+
# version: "String",
|
557
646
|
# clone_from: "String",
|
558
647
|
# binary_media_types: ["String"],
|
559
648
|
# })
|
@@ -563,6 +652,7 @@ module Aws
|
|
563
652
|
# resp.name #=> String
|
564
653
|
# resp.description #=> String
|
565
654
|
# resp.created_date #=> Time
|
655
|
+
# resp.version #=> String
|
566
656
|
# resp.warnings #=> Array
|
567
657
|
# resp.warnings[0] #=> String
|
568
658
|
# resp.binary_media_types #=> Array
|
@@ -593,6 +683,8 @@ module Aws
|
|
593
683
|
# A map that defines the stage variables for the new Stage resource.
|
594
684
|
# Variable names can have alphanumeric and underscore characters, and
|
595
685
|
# the values must match `[A-Za-z0-9-._~:/?#&=,]+`.
|
686
|
+
# @option params [String] :documentation_version
|
687
|
+
# The version of the associated API documentation.
|
596
688
|
# @return [Types::Stage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
597
689
|
#
|
598
690
|
# * {Types::Stage#deployment_id #deploymentId} => String
|
@@ -604,6 +696,7 @@ module Aws
|
|
604
696
|
# * {Types::Stage#cache_cluster_status #cacheClusterStatus} => String
|
605
697
|
# * {Types::Stage#method_settings #methodSettings} => Hash<String,Types::MethodSetting>
|
606
698
|
# * {Types::Stage#variables #variables} => Hash<String,String>
|
699
|
+
# * {Types::Stage#documentation_version #documentationVersion} => String
|
607
700
|
# * {Types::Stage#created_date #createdDate} => Time
|
608
701
|
# * {Types::Stage#last_updated_date #lastUpdatedDate} => Time
|
609
702
|
#
|
@@ -618,6 +711,7 @@ module Aws
|
|
618
711
|
# variables: {
|
619
712
|
# "String" => "String",
|
620
713
|
# },
|
714
|
+
# documentation_version: "String",
|
621
715
|
# })
|
622
716
|
#
|
623
717
|
# @example Response structure
|
@@ -641,6 +735,7 @@ module Aws
|
|
641
735
|
# resp.method_settings["String"].unauthorized_cache_control_header_strategy #=> String, one of "FAIL_WITH_403", "SUCCEED_WITH_RESPONSE_HEADER", "SUCCEED_WITHOUT_RESPONSE_HEADER"
|
642
736
|
# resp.variables #=> Hash
|
643
737
|
# resp.variables["String"] #=> String
|
738
|
+
# resp.documentation_version #=> String
|
644
739
|
# resp.created_date #=> Time
|
645
740
|
# resp.last_updated_date #=> Time
|
646
741
|
# @overload create_stage(params = {})
|
@@ -670,6 +765,7 @@ module Aws
|
|
670
765
|
# * {Types::UsagePlan#api_stages #apiStages} => Array<Types::ApiStage>
|
671
766
|
# * {Types::UsagePlan#throttle #throttle} => Types::ThrottleSettings
|
672
767
|
# * {Types::UsagePlan#quota #quota} => Types::QuotaSettings
|
768
|
+
# * {Types::UsagePlan#product_code #productCode} => String
|
673
769
|
#
|
674
770
|
# @example Request syntax with placeholder values
|
675
771
|
# resp = client.create_usage_plan({
|
@@ -704,6 +800,7 @@ module Aws
|
|
704
800
|
# resp.quota.limit #=> Integer
|
705
801
|
# resp.quota.offset #=> Integer
|
706
802
|
# resp.quota.period #=> String, one of "DAY", "WEEK", "MONTH"
|
803
|
+
# resp.product_code #=> String
|
707
804
|
# @overload create_usage_plan(params = {})
|
708
805
|
# @param [Hash] params ({})
|
709
806
|
def create_usage_plan(params = {}, options = {})
|
@@ -846,6 +943,45 @@ module Aws
|
|
846
943
|
req.send_request(options)
|
847
944
|
end
|
848
945
|
|
946
|
+
# @option params [required, String] :rest_api_id
|
947
|
+
# \[Required\] Specifies the identifier of an API of the to-be-deleted
|
948
|
+
# documentation part.
|
949
|
+
# @option params [required, String] :documentation_part_id
|
950
|
+
# \[Required\] The identifier of the to-be-deleted documentation part.
|
951
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
952
|
+
#
|
953
|
+
# @example Request syntax with placeholder values
|
954
|
+
# resp = client.delete_documentation_part({
|
955
|
+
# rest_api_id: "String", # required
|
956
|
+
# documentation_part_id: "String", # required
|
957
|
+
# })
|
958
|
+
# @overload delete_documentation_part(params = {})
|
959
|
+
# @param [Hash] params ({})
|
960
|
+
def delete_documentation_part(params = {}, options = {})
|
961
|
+
req = build_request(:delete_documentation_part, params)
|
962
|
+
req.send_request(options)
|
963
|
+
end
|
964
|
+
|
965
|
+
# @option params [required, String] :rest_api_id
|
966
|
+
# \[Required\] The identifier of an API of a to-be-deleted documentation
|
967
|
+
# snapshot.
|
968
|
+
# @option params [required, String] :documentation_version
|
969
|
+
# \[Required\] The version identifier of a to-be-deleted documentation
|
970
|
+
# snapshot.
|
971
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
972
|
+
#
|
973
|
+
# @example Request syntax with placeholder values
|
974
|
+
# resp = client.delete_documentation_version({
|
975
|
+
# rest_api_id: "String", # required
|
976
|
+
# documentation_version: "String", # required
|
977
|
+
# })
|
978
|
+
# @overload delete_documentation_version(params = {})
|
979
|
+
# @param [Hash] params ({})
|
980
|
+
def delete_documentation_version(params = {}, options = {})
|
981
|
+
req = build_request(:delete_documentation_version, params)
|
982
|
+
req.send_request(options)
|
983
|
+
end
|
984
|
+
|
849
985
|
# Deletes the DomainName resource.
|
850
986
|
# @option params [required, String] :domain_name
|
851
987
|
# The name of the DomainName resource to be deleted.
|
@@ -1172,6 +1308,7 @@ module Aws
|
|
1172
1308
|
# * {Types::ApiKey#id #id} => String
|
1173
1309
|
# * {Types::ApiKey#value #value} => String
|
1174
1310
|
# * {Types::ApiKey#name #name} => String
|
1311
|
+
# * {Types::ApiKey#customer_id #customerId} => String
|
1175
1312
|
# * {Types::ApiKey#description #description} => String
|
1176
1313
|
# * {Types::ApiKey#enabled #enabled} => Boolean
|
1177
1314
|
# * {Types::ApiKey#created_date #createdDate} => Time
|
@@ -1188,6 +1325,7 @@ module Aws
|
|
1188
1325
|
# resp.id #=> String
|
1189
1326
|
# resp.value #=> String
|
1190
1327
|
# resp.name #=> String
|
1328
|
+
# resp.customer_id #=> String
|
1191
1329
|
# resp.description #=> String
|
1192
1330
|
# resp.enabled #=> Boolean
|
1193
1331
|
# resp.created_date #=> Time
|
@@ -1209,6 +1347,8 @@ module Aws
|
|
1209
1347
|
# @option params [String] :name_query
|
1210
1348
|
# The name of queried API keys.
|
1211
1349
|
# @option params [String] :customer_id
|
1350
|
+
# The identifier of a customer in AWS Marketplace or an external system,
|
1351
|
+
# such as a developer portal.
|
1212
1352
|
# @option params [Boolean] :include_values
|
1213
1353
|
# A boolean flag to specify whether (`true`) or not (`false`) the result
|
1214
1354
|
# contains key values.
|
@@ -1235,6 +1375,7 @@ module Aws
|
|
1235
1375
|
# resp.items[0].id #=> String
|
1236
1376
|
# resp.items[0].value #=> String
|
1237
1377
|
# resp.items[0].name #=> String
|
1378
|
+
# resp.items[0].customer_id #=> String
|
1238
1379
|
# resp.items[0].description #=> String
|
1239
1380
|
# resp.items[0].enabled #=> Boolean
|
1240
1381
|
# resp.items[0].created_date #=> Time
|
@@ -1551,6 +1692,146 @@ module Aws
|
|
1551
1692
|
req.send_request(options)
|
1552
1693
|
end
|
1553
1694
|
|
1695
|
+
# @option params [required, String] :rest_api_id
|
1696
|
+
# \[Required\] The identifier of an API of the to-be-retrieved
|
1697
|
+
# documentation part.
|
1698
|
+
# @option params [required, String] :documentation_part_id
|
1699
|
+
# \[Required\] The identifier of the to-be-retrieved documentation part.
|
1700
|
+
# @return [Types::DocumentationPart] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1701
|
+
#
|
1702
|
+
# * {Types::DocumentationPart#id #id} => String
|
1703
|
+
# * {Types::DocumentationPart#location #location} => Types::DocumentationPartLocation
|
1704
|
+
# * {Types::DocumentationPart#properties #properties} => String
|
1705
|
+
#
|
1706
|
+
# @example Request syntax with placeholder values
|
1707
|
+
# resp = client.get_documentation_part({
|
1708
|
+
# rest_api_id: "String", # required
|
1709
|
+
# documentation_part_id: "String", # required
|
1710
|
+
# })
|
1711
|
+
#
|
1712
|
+
# @example Response structure
|
1713
|
+
# resp.id #=> String
|
1714
|
+
# resp.location.type #=> String, one of "API", "AUTHORIZER", "MODEL", "RESOURCE", "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", "RESPONSE_BODY"
|
1715
|
+
# resp.location.path #=> String
|
1716
|
+
# resp.location.method #=> String
|
1717
|
+
# resp.location.status_code #=> String
|
1718
|
+
# resp.location.name #=> String
|
1719
|
+
# resp.properties #=> String
|
1720
|
+
# @overload get_documentation_part(params = {})
|
1721
|
+
# @param [Hash] params ({})
|
1722
|
+
def get_documentation_part(params = {}, options = {})
|
1723
|
+
req = build_request(:get_documentation_part, params)
|
1724
|
+
req.send_request(options)
|
1725
|
+
end
|
1726
|
+
|
1727
|
+
# @option params [required, String] :rest_api_id
|
1728
|
+
# \[Required\] The identifier of the API of the to-be-retrieved
|
1729
|
+
# documentation parts.
|
1730
|
+
# @option params [String] :type
|
1731
|
+
# The type of API entities of the to-be-retrieved documentation parts.
|
1732
|
+
# @option params [String] :name_query
|
1733
|
+
# The name of API entities of the to-be-retrieved documentation parts.
|
1734
|
+
# @option params [String] :path
|
1735
|
+
# The path of API entities of the to-be-retrieved documentation parts.
|
1736
|
+
# @option params [String] :position
|
1737
|
+
# The position of the to-be-retrieved documentation part in the
|
1738
|
+
# DocumentationParts collection.
|
1739
|
+
# @option params [Integer] :limit
|
1740
|
+
# The size of the paged results.
|
1741
|
+
# @return [Types::DocumentationParts] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1742
|
+
#
|
1743
|
+
# * {Types::DocumentationParts#position #position} => String
|
1744
|
+
# * {Types::DocumentationParts#items #items} => Array<Types::DocumentationPart>
|
1745
|
+
#
|
1746
|
+
# @example Request syntax with placeholder values
|
1747
|
+
# resp = client.get_documentation_parts({
|
1748
|
+
# rest_api_id: "String", # required
|
1749
|
+
# type: "API", # accepts API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY
|
1750
|
+
# name_query: "String",
|
1751
|
+
# path: "String",
|
1752
|
+
# position: "String",
|
1753
|
+
# limit: 1,
|
1754
|
+
# })
|
1755
|
+
#
|
1756
|
+
# @example Response structure
|
1757
|
+
# resp.position #=> String
|
1758
|
+
# resp.items #=> Array
|
1759
|
+
# resp.items[0].id #=> String
|
1760
|
+
# resp.items[0].location.type #=> String, one of "API", "AUTHORIZER", "MODEL", "RESOURCE", "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", "RESPONSE_BODY"
|
1761
|
+
# resp.items[0].location.path #=> String
|
1762
|
+
# resp.items[0].location.method #=> String
|
1763
|
+
# resp.items[0].location.status_code #=> String
|
1764
|
+
# resp.items[0].location.name #=> String
|
1765
|
+
# resp.items[0].properties #=> String
|
1766
|
+
# @overload get_documentation_parts(params = {})
|
1767
|
+
# @param [Hash] params ({})
|
1768
|
+
def get_documentation_parts(params = {}, options = {})
|
1769
|
+
req = build_request(:get_documentation_parts, params)
|
1770
|
+
req.send_request(options)
|
1771
|
+
end
|
1772
|
+
|
1773
|
+
# @option params [required, String] :rest_api_id
|
1774
|
+
# \[Required\] The identifier of the API of the to-be-retrieved
|
1775
|
+
# documentation snapshot.
|
1776
|
+
# @option params [required, String] :documentation_version
|
1777
|
+
# \[Required\] The version identifier of the to-be-retrieved
|
1778
|
+
# documentation snapshot.
|
1779
|
+
# @return [Types::DocumentationVersion] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1780
|
+
#
|
1781
|
+
# * {Types::DocumentationVersion#version #version} => String
|
1782
|
+
# * {Types::DocumentationVersion#created_date #createdDate} => Time
|
1783
|
+
# * {Types::DocumentationVersion#description #description} => String
|
1784
|
+
#
|
1785
|
+
# @example Request syntax with placeholder values
|
1786
|
+
# resp = client.get_documentation_version({
|
1787
|
+
# rest_api_id: "String", # required
|
1788
|
+
# documentation_version: "String", # required
|
1789
|
+
# })
|
1790
|
+
#
|
1791
|
+
# @example Response structure
|
1792
|
+
# resp.version #=> String
|
1793
|
+
# resp.created_date #=> Time
|
1794
|
+
# resp.description #=> String
|
1795
|
+
# @overload get_documentation_version(params = {})
|
1796
|
+
# @param [Hash] params ({})
|
1797
|
+
def get_documentation_version(params = {}, options = {})
|
1798
|
+
req = build_request(:get_documentation_version, params)
|
1799
|
+
req.send_request(options)
|
1800
|
+
end
|
1801
|
+
|
1802
|
+
# @option params [required, String] :rest_api_id
|
1803
|
+
# \[Required\] The identifier of an API of the to-be-retrieved
|
1804
|
+
# documentation versions.
|
1805
|
+
# @option params [String] :position
|
1806
|
+
# The position of the returned `DocumentationVersion` in the
|
1807
|
+
# DocumentationVersions collection.
|
1808
|
+
# @option params [Integer] :limit
|
1809
|
+
# The page size of the returned documentation versions.
|
1810
|
+
# @return [Types::DocumentationVersions] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1811
|
+
#
|
1812
|
+
# * {Types::DocumentationVersions#position #position} => String
|
1813
|
+
# * {Types::DocumentationVersions#items #items} => Array<Types::DocumentationVersion>
|
1814
|
+
#
|
1815
|
+
# @example Request syntax with placeholder values
|
1816
|
+
# resp = client.get_documentation_versions({
|
1817
|
+
# rest_api_id: "String", # required
|
1818
|
+
# position: "String",
|
1819
|
+
# limit: 1,
|
1820
|
+
# })
|
1821
|
+
#
|
1822
|
+
# @example Response structure
|
1823
|
+
# resp.position #=> String
|
1824
|
+
# resp.items #=> Array
|
1825
|
+
# resp.items[0].version #=> String
|
1826
|
+
# resp.items[0].created_date #=> Time
|
1827
|
+
# resp.items[0].description #=> String
|
1828
|
+
# @overload get_documentation_versions(params = {})
|
1829
|
+
# @param [Hash] params ({})
|
1830
|
+
def get_documentation_versions(params = {}, options = {})
|
1831
|
+
req = build_request(:get_documentation_versions, params)
|
1832
|
+
req.send_request(options)
|
1833
|
+
end
|
1834
|
+
|
1554
1835
|
# Represents a domain name that is contained in a simpler, more
|
1555
1836
|
# intuitive URL that can be called.
|
1556
1837
|
# @option params [required, String] :domain_name
|
@@ -2108,6 +2389,7 @@ module Aws
|
|
2108
2389
|
# * {Types::RestApi#name #name} => String
|
2109
2390
|
# * {Types::RestApi#description #description} => String
|
2110
2391
|
# * {Types::RestApi#created_date #createdDate} => Time
|
2392
|
+
# * {Types::RestApi#version #version} => String
|
2111
2393
|
# * {Types::RestApi#warnings #warnings} => Array<String>
|
2112
2394
|
# * {Types::RestApi#binary_media_types #binaryMediaTypes} => Array<String>
|
2113
2395
|
#
|
@@ -2121,6 +2403,7 @@ module Aws
|
|
2121
2403
|
# resp.name #=> String
|
2122
2404
|
# resp.description #=> String
|
2123
2405
|
# resp.created_date #=> Time
|
2406
|
+
# resp.version #=> String
|
2124
2407
|
# resp.warnings #=> Array
|
2125
2408
|
# resp.warnings[0] #=> String
|
2126
2409
|
# resp.binary_media_types #=> Array
|
@@ -2158,6 +2441,7 @@ module Aws
|
|
2158
2441
|
# resp.items[0].name #=> String
|
2159
2442
|
# resp.items[0].description #=> String
|
2160
2443
|
# resp.items[0].created_date #=> Time
|
2444
|
+
# resp.items[0].version #=> String
|
2161
2445
|
# resp.items[0].warnings #=> Array
|
2162
2446
|
# resp.items[0].warnings[0] #=> String
|
2163
2447
|
# resp.items[0].binary_media_types #=> Array
|
@@ -2227,6 +2511,7 @@ module Aws
|
|
2227
2511
|
# * {Types::Stage#cache_cluster_status #cacheClusterStatus} => String
|
2228
2512
|
# * {Types::Stage#method_settings #methodSettings} => Hash<String,Types::MethodSetting>
|
2229
2513
|
# * {Types::Stage#variables #variables} => Hash<String,String>
|
2514
|
+
# * {Types::Stage#documentation_version #documentationVersion} => String
|
2230
2515
|
# * {Types::Stage#created_date #createdDate} => Time
|
2231
2516
|
# * {Types::Stage#last_updated_date #lastUpdatedDate} => Time
|
2232
2517
|
#
|
@@ -2257,6 +2542,7 @@ module Aws
|
|
2257
2542
|
# resp.method_settings["String"].unauthorized_cache_control_header_strategy #=> String, one of "FAIL_WITH_403", "SUCCEED_WITH_RESPONSE_HEADER", "SUCCEED_WITHOUT_RESPONSE_HEADER"
|
2258
2543
|
# resp.variables #=> Hash
|
2259
2544
|
# resp.variables["String"] #=> String
|
2545
|
+
# resp.documentation_version #=> String
|
2260
2546
|
# resp.created_date #=> Time
|
2261
2547
|
# resp.last_updated_date #=> Time
|
2262
2548
|
# @overload get_stage(params = {})
|
@@ -2303,6 +2589,7 @@ module Aws
|
|
2303
2589
|
# resp.item[0].method_settings["String"].unauthorized_cache_control_header_strategy #=> String, one of "FAIL_WITH_403", "SUCCEED_WITH_RESPONSE_HEADER", "SUCCEED_WITHOUT_RESPONSE_HEADER"
|
2304
2590
|
# resp.item[0].variables #=> Hash
|
2305
2591
|
# resp.item[0].variables["String"] #=> String
|
2592
|
+
# resp.item[0].documentation_version #=> String
|
2306
2593
|
# resp.item[0].created_date #=> Time
|
2307
2594
|
# resp.item[0].last_updated_date #=> Time
|
2308
2595
|
# @overload get_stages(params = {})
|
@@ -2370,6 +2657,7 @@ module Aws
|
|
2370
2657
|
# * {Types::UsagePlan#api_stages #apiStages} => Array<Types::ApiStage>
|
2371
2658
|
# * {Types::UsagePlan#throttle #throttle} => Types::ThrottleSettings
|
2372
2659
|
# * {Types::UsagePlan#quota #quota} => Types::QuotaSettings
|
2660
|
+
# * {Types::UsagePlan#product_code #productCode} => String
|
2373
2661
|
#
|
2374
2662
|
# @example Request syntax with placeholder values
|
2375
2663
|
# resp = client.get_usage_plan({
|
@@ -2388,6 +2676,7 @@ module Aws
|
|
2388
2676
|
# resp.quota.limit #=> Integer
|
2389
2677
|
# resp.quota.offset #=> Integer
|
2390
2678
|
# resp.quota.period #=> String, one of "DAY", "WEEK", "MONTH"
|
2679
|
+
# resp.product_code #=> String
|
2391
2680
|
# @overload get_usage_plan(params = {})
|
2392
2681
|
# @param [Hash] params ({})
|
2393
2682
|
def get_usage_plan(params = {}, options = {})
|
@@ -2504,6 +2793,7 @@ module Aws
|
|
2504
2793
|
# resp.items[0].quota.limit #=> Integer
|
2505
2794
|
# resp.items[0].quota.offset #=> Integer
|
2506
2795
|
# resp.items[0].quota.period #=> String, one of "DAY", "WEEK", "MONTH"
|
2796
|
+
# resp.items[0].product_code #=> String
|
2507
2797
|
# @overload get_usage_plans(params = {})
|
2508
2798
|
# @param [Hash] params ({})
|
2509
2799
|
def get_usage_plans(params = {}, options = {})
|
@@ -2549,6 +2839,46 @@ module Aws
|
|
2549
2839
|
req.send_request(options)
|
2550
2840
|
end
|
2551
2841
|
|
2842
|
+
# @option params [required, String] :rest_api_id
|
2843
|
+
# \[Required\] The identifier of an API of the to-be-imported
|
2844
|
+
# documentation parts.
|
2845
|
+
# @option params [String] :mode
|
2846
|
+
# A query parameter to indicate whether to overwrite (`OVERWRITE`) any
|
2847
|
+
# existing DocumentationParts definition or to merge (`MERGE`) the new
|
2848
|
+
# definition into the existing one. The default value is `MERGE`.
|
2849
|
+
# @option params [Boolean] :fail_on_warnings
|
2850
|
+
# A query parameter to specify whether to rollback the documentation
|
2851
|
+
# importation (`true`) or not (`false`) when a warning is encountered.
|
2852
|
+
# The default value is `false`.
|
2853
|
+
# @option params [required, String, IO] :body
|
2854
|
+
# \[Required\] Raw byte array representing the to-be-imported
|
2855
|
+
# documentation parts. To import from a Swagger file, this is a JSON
|
2856
|
+
# object.
|
2857
|
+
# @return [Types::DocumentationPartIds] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2858
|
+
#
|
2859
|
+
# * {Types::DocumentationPartIds#ids #ids} => Array<String>
|
2860
|
+
# * {Types::DocumentationPartIds#warnings #warnings} => Array<String>
|
2861
|
+
#
|
2862
|
+
# @example Request syntax with placeholder values
|
2863
|
+
# resp = client.import_documentation_parts({
|
2864
|
+
# rest_api_id: "String", # required
|
2865
|
+
# mode: "merge", # accepts merge, overwrite
|
2866
|
+
# fail_on_warnings: false,
|
2867
|
+
# body: "data", # required
|
2868
|
+
# })
|
2869
|
+
#
|
2870
|
+
# @example Response structure
|
2871
|
+
# resp.ids #=> Array
|
2872
|
+
# resp.ids[0] #=> String
|
2873
|
+
# resp.warnings #=> Array
|
2874
|
+
# resp.warnings[0] #=> String
|
2875
|
+
# @overload import_documentation_parts(params = {})
|
2876
|
+
# @param [Hash] params ({})
|
2877
|
+
def import_documentation_parts(params = {}, options = {})
|
2878
|
+
req = build_request(:import_documentation_parts, params)
|
2879
|
+
req.send_request(options)
|
2880
|
+
end
|
2881
|
+
|
2552
2882
|
# A feature of the Amazon API Gateway control service for creating a new
|
2553
2883
|
# API from an external API definition file.
|
2554
2884
|
# @option params [Boolean] :fail_on_warnings
|
@@ -2566,6 +2896,7 @@ module Aws
|
|
2566
2896
|
# * {Types::RestApi#name #name} => String
|
2567
2897
|
# * {Types::RestApi#description #description} => String
|
2568
2898
|
# * {Types::RestApi#created_date #createdDate} => Time
|
2899
|
+
# * {Types::RestApi#version #version} => String
|
2569
2900
|
# * {Types::RestApi#warnings #warnings} => Array<String>
|
2570
2901
|
# * {Types::RestApi#binary_media_types #binaryMediaTypes} => Array<String>
|
2571
2902
|
#
|
@@ -2583,6 +2914,7 @@ module Aws
|
|
2583
2914
|
# resp.name #=> String
|
2584
2915
|
# resp.description #=> String
|
2585
2916
|
# resp.created_date #=> Time
|
2917
|
+
# resp.version #=> String
|
2586
2918
|
# resp.warnings #=> Array
|
2587
2919
|
# resp.warnings[0] #=> String
|
2588
2920
|
# resp.binary_media_types #=> Array
|
@@ -2994,6 +3326,7 @@ module Aws
|
|
2994
3326
|
# * {Types::RestApi#name #name} => String
|
2995
3327
|
# * {Types::RestApi#description #description} => String
|
2996
3328
|
# * {Types::RestApi#created_date #createdDate} => Time
|
3329
|
+
# * {Types::RestApi#version #version} => String
|
2997
3330
|
# * {Types::RestApi#warnings #warnings} => Array<String>
|
2998
3331
|
# * {Types::RestApi#binary_media_types #binaryMediaTypes} => Array<String>
|
2999
3332
|
#
|
@@ -3013,6 +3346,7 @@ module Aws
|
|
3013
3346
|
# resp.name #=> String
|
3014
3347
|
# resp.description #=> String
|
3015
3348
|
# resp.created_date #=> Time
|
3349
|
+
# resp.version #=> String
|
3016
3350
|
# resp.warnings #=> Array
|
3017
3351
|
# resp.warnings[0] #=> String
|
3018
3352
|
# resp.binary_media_types #=> Array
|
@@ -3208,6 +3542,7 @@ module Aws
|
|
3208
3542
|
# * {Types::ApiKey#id #id} => String
|
3209
3543
|
# * {Types::ApiKey#value #value} => String
|
3210
3544
|
# * {Types::ApiKey#name #name} => String
|
3545
|
+
# * {Types::ApiKey#customer_id #customerId} => String
|
3211
3546
|
# * {Types::ApiKey#description #description} => String
|
3212
3547
|
# * {Types::ApiKey#enabled #enabled} => Boolean
|
3213
3548
|
# * {Types::ApiKey#created_date #createdDate} => Time
|
@@ -3231,6 +3566,7 @@ module Aws
|
|
3231
3566
|
# resp.id #=> String
|
3232
3567
|
# resp.value #=> String
|
3233
3568
|
# resp.name #=> String
|
3569
|
+
# resp.customer_id #=> String
|
3234
3570
|
# resp.description #=> String
|
3235
3571
|
# resp.enabled #=> Boolean
|
3236
3572
|
# resp.created_date #=> Time
|
@@ -3431,6 +3767,89 @@ module Aws
|
|
3431
3767
|
req.send_request(options)
|
3432
3768
|
end
|
3433
3769
|
|
3770
|
+
# @option params [required, String] :rest_api_id
|
3771
|
+
# \[Required\] The identifier of an API of the to-be-updated
|
3772
|
+
# documentation part.
|
3773
|
+
# @option params [required, String] :documentation_part_id
|
3774
|
+
# \[Required\] The identifier of the to-be-updated documentation part.
|
3775
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
3776
|
+
# A list of update operations to be applied to the specified resource
|
3777
|
+
# and in the order specified in this list.
|
3778
|
+
# @return [Types::DocumentationPart] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3779
|
+
#
|
3780
|
+
# * {Types::DocumentationPart#id #id} => String
|
3781
|
+
# * {Types::DocumentationPart#location #location} => Types::DocumentationPartLocation
|
3782
|
+
# * {Types::DocumentationPart#properties #properties} => String
|
3783
|
+
#
|
3784
|
+
# @example Request syntax with placeholder values
|
3785
|
+
# resp = client.update_documentation_part({
|
3786
|
+
# rest_api_id: "String", # required
|
3787
|
+
# documentation_part_id: "String", # required
|
3788
|
+
# patch_operations: [
|
3789
|
+
# {
|
3790
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
3791
|
+
# path: "String",
|
3792
|
+
# value: "String",
|
3793
|
+
# from: "String",
|
3794
|
+
# },
|
3795
|
+
# ],
|
3796
|
+
# })
|
3797
|
+
#
|
3798
|
+
# @example Response structure
|
3799
|
+
# resp.id #=> String
|
3800
|
+
# resp.location.type #=> String, one of "API", "AUTHORIZER", "MODEL", "RESOURCE", "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", "RESPONSE_BODY"
|
3801
|
+
# resp.location.path #=> String
|
3802
|
+
# resp.location.method #=> String
|
3803
|
+
# resp.location.status_code #=> String
|
3804
|
+
# resp.location.name #=> String
|
3805
|
+
# resp.properties #=> String
|
3806
|
+
# @overload update_documentation_part(params = {})
|
3807
|
+
# @param [Hash] params ({})
|
3808
|
+
def update_documentation_part(params = {}, options = {})
|
3809
|
+
req = build_request(:update_documentation_part, params)
|
3810
|
+
req.send_request(options)
|
3811
|
+
end
|
3812
|
+
|
3813
|
+
# @option params [required, String] :rest_api_id
|
3814
|
+
# \[Required\] The identifier of an API of the to-be-updated
|
3815
|
+
# documentation version.
|
3816
|
+
# @option params [required, String] :documentation_version
|
3817
|
+
# \[Required\] The version identifier of the to-be-updated documentation
|
3818
|
+
# version.
|
3819
|
+
# @option params [Array<Types::PatchOperation>] :patch_operations
|
3820
|
+
# A list of update operations to be applied to the specified resource
|
3821
|
+
# and in the order specified in this list.
|
3822
|
+
# @return [Types::DocumentationVersion] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3823
|
+
#
|
3824
|
+
# * {Types::DocumentationVersion#version #version} => String
|
3825
|
+
# * {Types::DocumentationVersion#created_date #createdDate} => Time
|
3826
|
+
# * {Types::DocumentationVersion#description #description} => String
|
3827
|
+
#
|
3828
|
+
# @example Request syntax with placeholder values
|
3829
|
+
# resp = client.update_documentation_version({
|
3830
|
+
# rest_api_id: "String", # required
|
3831
|
+
# documentation_version: "String", # required
|
3832
|
+
# patch_operations: [
|
3833
|
+
# {
|
3834
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
3835
|
+
# path: "String",
|
3836
|
+
# value: "String",
|
3837
|
+
# from: "String",
|
3838
|
+
# },
|
3839
|
+
# ],
|
3840
|
+
# })
|
3841
|
+
#
|
3842
|
+
# @example Response structure
|
3843
|
+
# resp.version #=> String
|
3844
|
+
# resp.created_date #=> Time
|
3845
|
+
# resp.description #=> String
|
3846
|
+
# @overload update_documentation_version(params = {})
|
3847
|
+
# @param [Hash] params ({})
|
3848
|
+
def update_documentation_version(params = {}, options = {})
|
3849
|
+
req = build_request(:update_documentation_version, params)
|
3850
|
+
req.send_request(options)
|
3851
|
+
end
|
3852
|
+
|
3434
3853
|
# Changes information about the DomainName resource.
|
3435
3854
|
# @option params [required, String] :domain_name
|
3436
3855
|
# The name of the DomainName resource to be changed.
|
@@ -3848,6 +4267,7 @@ module Aws
|
|
3848
4267
|
# * {Types::RestApi#name #name} => String
|
3849
4268
|
# * {Types::RestApi#description #description} => String
|
3850
4269
|
# * {Types::RestApi#created_date #createdDate} => Time
|
4270
|
+
# * {Types::RestApi#version #version} => String
|
3851
4271
|
# * {Types::RestApi#warnings #warnings} => Array<String>
|
3852
4272
|
# * {Types::RestApi#binary_media_types #binaryMediaTypes} => Array<String>
|
3853
4273
|
#
|
@@ -3869,6 +4289,7 @@ module Aws
|
|
3869
4289
|
# resp.name #=> String
|
3870
4290
|
# resp.description #=> String
|
3871
4291
|
# resp.created_date #=> Time
|
4292
|
+
# resp.version #=> String
|
3872
4293
|
# resp.warnings #=> Array
|
3873
4294
|
# resp.warnings[0] #=> String
|
3874
4295
|
# resp.binary_media_types #=> Array
|
@@ -3900,6 +4321,7 @@ module Aws
|
|
3900
4321
|
# * {Types::Stage#cache_cluster_status #cacheClusterStatus} => String
|
3901
4322
|
# * {Types::Stage#method_settings #methodSettings} => Hash<String,Types::MethodSetting>
|
3902
4323
|
# * {Types::Stage#variables #variables} => Hash<String,String>
|
4324
|
+
# * {Types::Stage#documentation_version #documentationVersion} => String
|
3903
4325
|
# * {Types::Stage#created_date #createdDate} => Time
|
3904
4326
|
# * {Types::Stage#last_updated_date #lastUpdatedDate} => Time
|
3905
4327
|
#
|
@@ -3938,6 +4360,7 @@ module Aws
|
|
3938
4360
|
# resp.method_settings["String"].unauthorized_cache_control_header_strategy #=> String, one of "FAIL_WITH_403", "SUCCEED_WITH_RESPONSE_HEADER", "SUCCEED_WITHOUT_RESPONSE_HEADER"
|
3939
4361
|
# resp.variables #=> Hash
|
3940
4362
|
# resp.variables["String"] #=> String
|
4363
|
+
# resp.documentation_version #=> String
|
3941
4364
|
# resp.created_date #=> Time
|
3942
4365
|
# resp.last_updated_date #=> Time
|
3943
4366
|
# @overload update_stage(params = {})
|
@@ -4009,6 +4432,7 @@ module Aws
|
|
4009
4432
|
# * {Types::UsagePlan#api_stages #apiStages} => Array<Types::ApiStage>
|
4010
4433
|
# * {Types::UsagePlan#throttle #throttle} => Types::ThrottleSettings
|
4011
4434
|
# * {Types::UsagePlan#quota #quota} => Types::QuotaSettings
|
4435
|
+
# * {Types::UsagePlan#product_code #productCode} => String
|
4012
4436
|
#
|
4013
4437
|
# @example Request syntax with placeholder values
|
4014
4438
|
# resp = client.update_usage_plan({
|
@@ -4035,6 +4459,7 @@ module Aws
|
|
4035
4459
|
# resp.quota.limit #=> Integer
|
4036
4460
|
# resp.quota.offset #=> Integer
|
4037
4461
|
# resp.quota.period #=> String, one of "DAY", "WEEK", "MONTH"
|
4462
|
+
# resp.product_code #=> String
|
4038
4463
|
# @overload update_usage_plan(params = {})
|
4039
4464
|
# @param [Hash] params ({})
|
4040
4465
|
def update_usage_plan(params = {}, options = {})
|
@@ -4055,7 +4480,7 @@ module Aws
|
|
4055
4480
|
params: params,
|
4056
4481
|
config: config)
|
4057
4482
|
context[:gem_name] = 'aws-sdk-apigateway'
|
4058
|
-
context[:gem_version] = '1.0.0.
|
4483
|
+
context[:gem_version] = '1.0.0.rc2'
|
4059
4484
|
Seahorse::Client::Request.new(handlers, context)
|
4060
4485
|
end
|
4061
4486
|
|