aws-sdk-apigateway 1.0.0.rc1 → 1.0.0.rc2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
@@ -36,6 +36,8 @@ module Aws
|
|
36
36
|
CreateAuthorizerRequest = Shapes::StructureShape.new(name: 'CreateAuthorizerRequest')
|
37
37
|
CreateBasePathMappingRequest = Shapes::StructureShape.new(name: 'CreateBasePathMappingRequest')
|
38
38
|
CreateDeploymentRequest = Shapes::StructureShape.new(name: 'CreateDeploymentRequest')
|
39
|
+
CreateDocumentationPartRequest = Shapes::StructureShape.new(name: 'CreateDocumentationPartRequest')
|
40
|
+
CreateDocumentationVersionRequest = Shapes::StructureShape.new(name: 'CreateDocumentationVersionRequest')
|
39
41
|
CreateDomainNameRequest = Shapes::StructureShape.new(name: 'CreateDomainNameRequest')
|
40
42
|
CreateModelRequest = Shapes::StructureShape.new(name: 'CreateModelRequest')
|
41
43
|
CreateResourceRequest = Shapes::StructureShape.new(name: 'CreateResourceRequest')
|
@@ -48,6 +50,8 @@ module Aws
|
|
48
50
|
DeleteBasePathMappingRequest = Shapes::StructureShape.new(name: 'DeleteBasePathMappingRequest')
|
49
51
|
DeleteClientCertificateRequest = Shapes::StructureShape.new(name: 'DeleteClientCertificateRequest')
|
50
52
|
DeleteDeploymentRequest = Shapes::StructureShape.new(name: 'DeleteDeploymentRequest')
|
53
|
+
DeleteDocumentationPartRequest = Shapes::StructureShape.new(name: 'DeleteDocumentationPartRequest')
|
54
|
+
DeleteDocumentationVersionRequest = Shapes::StructureShape.new(name: 'DeleteDocumentationVersionRequest')
|
51
55
|
DeleteDomainNameRequest = Shapes::StructureShape.new(name: 'DeleteDomainNameRequest')
|
52
56
|
DeleteIntegrationRequest = Shapes::StructureShape.new(name: 'DeleteIntegrationRequest')
|
53
57
|
DeleteIntegrationResponseRequest = Shapes::StructureShape.new(name: 'DeleteIntegrationResponseRequest')
|
@@ -61,6 +65,14 @@ module Aws
|
|
61
65
|
DeleteUsagePlanRequest = Shapes::StructureShape.new(name: 'DeleteUsagePlanRequest')
|
62
66
|
Deployment = Shapes::StructureShape.new(name: 'Deployment')
|
63
67
|
Deployments = Shapes::StructureShape.new(name: 'Deployments')
|
68
|
+
DocumentationPart = Shapes::StructureShape.new(name: 'DocumentationPart')
|
69
|
+
DocumentationPartIds = Shapes::StructureShape.new(name: 'DocumentationPartIds')
|
70
|
+
DocumentationPartLocation = Shapes::StructureShape.new(name: 'DocumentationPartLocation')
|
71
|
+
DocumentationPartLocationStatusCode = Shapes::StringShape.new(name: 'DocumentationPartLocationStatusCode')
|
72
|
+
DocumentationPartType = Shapes::StringShape.new(name: 'DocumentationPartType')
|
73
|
+
DocumentationParts = Shapes::StructureShape.new(name: 'DocumentationParts')
|
74
|
+
DocumentationVersion = Shapes::StructureShape.new(name: 'DocumentationVersion')
|
75
|
+
DocumentationVersions = Shapes::StructureShape.new(name: 'DocumentationVersions')
|
64
76
|
DomainName = Shapes::StructureShape.new(name: 'DomainName')
|
65
77
|
DomainNames = Shapes::StructureShape.new(name: 'DomainNames')
|
66
78
|
Double = Shapes::FloatShape.new(name: 'Double')
|
@@ -79,6 +91,10 @@ module Aws
|
|
79
91
|
GetClientCertificatesRequest = Shapes::StructureShape.new(name: 'GetClientCertificatesRequest')
|
80
92
|
GetDeploymentRequest = Shapes::StructureShape.new(name: 'GetDeploymentRequest')
|
81
93
|
GetDeploymentsRequest = Shapes::StructureShape.new(name: 'GetDeploymentsRequest')
|
94
|
+
GetDocumentationPartRequest = Shapes::StructureShape.new(name: 'GetDocumentationPartRequest')
|
95
|
+
GetDocumentationPartsRequest = Shapes::StructureShape.new(name: 'GetDocumentationPartsRequest')
|
96
|
+
GetDocumentationVersionRequest = Shapes::StructureShape.new(name: 'GetDocumentationVersionRequest')
|
97
|
+
GetDocumentationVersionsRequest = Shapes::StructureShape.new(name: 'GetDocumentationVersionsRequest')
|
82
98
|
GetDomainNameRequest = Shapes::StructureShape.new(name: 'GetDomainNameRequest')
|
83
99
|
GetDomainNamesRequest = Shapes::StructureShape.new(name: 'GetDomainNamesRequest')
|
84
100
|
GetExportRequest = Shapes::StructureShape.new(name: 'GetExportRequest')
|
@@ -102,6 +118,7 @@ module Aws
|
|
102
118
|
GetUsagePlansRequest = Shapes::StructureShape.new(name: 'GetUsagePlansRequest')
|
103
119
|
GetUsageRequest = Shapes::StructureShape.new(name: 'GetUsageRequest')
|
104
120
|
ImportApiKeysRequest = Shapes::StructureShape.new(name: 'ImportApiKeysRequest')
|
121
|
+
ImportDocumentationPartsRequest = Shapes::StructureShape.new(name: 'ImportDocumentationPartsRequest')
|
105
122
|
ImportRestApiRequest = Shapes::StructureShape.new(name: 'ImportRestApiRequest')
|
106
123
|
Integer = Shapes::IntegerShape.new(name: 'Integer')
|
107
124
|
Integration = Shapes::StructureShape.new(name: 'Integration')
|
@@ -115,6 +132,8 @@ module Aws
|
|
115
132
|
ListOfBasePathMapping = Shapes::ListShape.new(name: 'ListOfBasePathMapping')
|
116
133
|
ListOfClientCertificate = Shapes::ListShape.new(name: 'ListOfClientCertificate')
|
117
134
|
ListOfDeployment = Shapes::ListShape.new(name: 'ListOfDeployment')
|
135
|
+
ListOfDocumentationPart = Shapes::ListShape.new(name: 'ListOfDocumentationPart')
|
136
|
+
ListOfDocumentationVersion = Shapes::ListShape.new(name: 'ListOfDocumentationVersion')
|
118
137
|
ListOfDomainName = Shapes::ListShape.new(name: 'ListOfDomainName')
|
119
138
|
ListOfLong = Shapes::ListShape.new(name: 'ListOfLong')
|
120
139
|
ListOfModel = Shapes::ListShape.new(name: 'ListOfModel')
|
@@ -186,6 +205,8 @@ module Aws
|
|
186
205
|
UpdateBasePathMappingRequest = Shapes::StructureShape.new(name: 'UpdateBasePathMappingRequest')
|
187
206
|
UpdateClientCertificateRequest = Shapes::StructureShape.new(name: 'UpdateClientCertificateRequest')
|
188
207
|
UpdateDeploymentRequest = Shapes::StructureShape.new(name: 'UpdateDeploymentRequest')
|
208
|
+
UpdateDocumentationPartRequest = Shapes::StructureShape.new(name: 'UpdateDocumentationPartRequest')
|
209
|
+
UpdateDocumentationVersionRequest = Shapes::StructureShape.new(name: 'UpdateDocumentationVersionRequest')
|
189
210
|
UpdateDomainNameRequest = Shapes::StructureShape.new(name: 'UpdateDomainNameRequest')
|
190
211
|
UpdateIntegrationRequest = Shapes::StructureShape.new(name: 'UpdateIntegrationRequest')
|
191
212
|
UpdateIntegrationResponseRequest = Shapes::StructureShape.new(name: 'UpdateIntegrationResponseRequest')
|
@@ -212,6 +233,7 @@ module Aws
|
|
212
233
|
ApiKey.add_member(:id, Shapes::ShapeRef.new(shape: String, location_name: "id"))
|
213
234
|
ApiKey.add_member(:value, Shapes::ShapeRef.new(shape: String, location_name: "value"))
|
214
235
|
ApiKey.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "name"))
|
236
|
+
ApiKey.add_member(:customer_id, Shapes::ShapeRef.new(shape: String, location_name: "customerId"))
|
215
237
|
ApiKey.add_member(:description, Shapes::ShapeRef.new(shape: String, location_name: "description"))
|
216
238
|
ApiKey.add_member(:enabled, Shapes::ShapeRef.new(shape: Boolean, location_name: "enabled"))
|
217
239
|
ApiKey.add_member(:created_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "createdDate"))
|
@@ -274,6 +296,7 @@ module Aws
|
|
274
296
|
CreateApiKeyRequest.add_member(:generate_distinct_id, Shapes::ShapeRef.new(shape: Boolean, location_name: "generateDistinctId"))
|
275
297
|
CreateApiKeyRequest.add_member(:value, Shapes::ShapeRef.new(shape: String, location_name: "value"))
|
276
298
|
CreateApiKeyRequest.add_member(:stage_keys, Shapes::ShapeRef.new(shape: ListOfStageKeys, location_name: "stageKeys"))
|
299
|
+
CreateApiKeyRequest.add_member(:customer_id, Shapes::ShapeRef.new(shape: String, location_name: "customerId"))
|
277
300
|
CreateApiKeyRequest.struct_class = Types::CreateApiKeyRequest
|
278
301
|
|
279
302
|
CreateAuthorizerRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
@@ -303,6 +326,17 @@ module Aws
|
|
303
326
|
CreateDeploymentRequest.add_member(:variables, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "variables"))
|
304
327
|
CreateDeploymentRequest.struct_class = Types::CreateDeploymentRequest
|
305
328
|
|
329
|
+
CreateDocumentationPartRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
330
|
+
CreateDocumentationPartRequest.add_member(:location, Shapes::ShapeRef.new(shape: DocumentationPartLocation, required: true, location_name: "location"))
|
331
|
+
CreateDocumentationPartRequest.add_member(:properties, Shapes::ShapeRef.new(shape: String, required: true, location_name: "properties"))
|
332
|
+
CreateDocumentationPartRequest.struct_class = Types::CreateDocumentationPartRequest
|
333
|
+
|
334
|
+
CreateDocumentationVersionRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
335
|
+
CreateDocumentationVersionRequest.add_member(:documentation_version, Shapes::ShapeRef.new(shape: String, required: true, location_name: "documentationVersion"))
|
336
|
+
CreateDocumentationVersionRequest.add_member(:stage_name, Shapes::ShapeRef.new(shape: String, location_name: "stageName"))
|
337
|
+
CreateDocumentationVersionRequest.add_member(:description, Shapes::ShapeRef.new(shape: String, location_name: "description"))
|
338
|
+
CreateDocumentationVersionRequest.struct_class = Types::CreateDocumentationVersionRequest
|
339
|
+
|
306
340
|
CreateDomainNameRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "domainName"))
|
307
341
|
CreateDomainNameRequest.add_member(:certificate_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "certificateName"))
|
308
342
|
CreateDomainNameRequest.add_member(:certificate_body, Shapes::ShapeRef.new(shape: String, required: true, location_name: "certificateBody"))
|
@@ -324,6 +358,7 @@ module Aws
|
|
324
358
|
|
325
359
|
CreateRestApiRequest.add_member(:name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "name"))
|
326
360
|
CreateRestApiRequest.add_member(:description, Shapes::ShapeRef.new(shape: String, location_name: "description"))
|
361
|
+
CreateRestApiRequest.add_member(:version, Shapes::ShapeRef.new(shape: String, location_name: "version"))
|
327
362
|
CreateRestApiRequest.add_member(:clone_from, Shapes::ShapeRef.new(shape: String, location_name: "cloneFrom"))
|
328
363
|
CreateRestApiRequest.add_member(:binary_media_types, Shapes::ShapeRef.new(shape: ListOfString, location_name: "binaryMediaTypes"))
|
329
364
|
CreateRestApiRequest.struct_class = Types::CreateRestApiRequest
|
@@ -335,6 +370,7 @@ module Aws
|
|
335
370
|
CreateStageRequest.add_member(:cache_cluster_enabled, Shapes::ShapeRef.new(shape: Boolean, location_name: "cacheClusterEnabled"))
|
336
371
|
CreateStageRequest.add_member(:cache_cluster_size, Shapes::ShapeRef.new(shape: CacheClusterSize, location_name: "cacheClusterSize"))
|
337
372
|
CreateStageRequest.add_member(:variables, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "variables"))
|
373
|
+
CreateStageRequest.add_member(:documentation_version, Shapes::ShapeRef.new(shape: String, location_name: "documentationVersion"))
|
338
374
|
CreateStageRequest.struct_class = Types::CreateStageRequest
|
339
375
|
|
340
376
|
CreateUsagePlanKeyRequest.add_member(:usage_plan_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "usageplanId"))
|
@@ -367,6 +403,14 @@ module Aws
|
|
367
403
|
DeleteDeploymentRequest.add_member(:deployment_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "deployment_id"))
|
368
404
|
DeleteDeploymentRequest.struct_class = Types::DeleteDeploymentRequest
|
369
405
|
|
406
|
+
DeleteDocumentationPartRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
407
|
+
DeleteDocumentationPartRequest.add_member(:documentation_part_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "part_id"))
|
408
|
+
DeleteDocumentationPartRequest.struct_class = Types::DeleteDocumentationPartRequest
|
409
|
+
|
410
|
+
DeleteDocumentationVersionRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
411
|
+
DeleteDocumentationVersionRequest.add_member(:documentation_version, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "doc_version"))
|
412
|
+
DeleteDocumentationVersionRequest.struct_class = Types::DeleteDocumentationVersionRequest
|
413
|
+
|
370
414
|
DeleteDomainNameRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "domain_name"))
|
371
415
|
DeleteDomainNameRequest.struct_class = Types::DeleteDomainNameRequest
|
372
416
|
|
@@ -424,6 +468,35 @@ module Aws
|
|
424
468
|
Deployments.add_member(:items, Shapes::ShapeRef.new(shape: ListOfDeployment, location_name: "item"))
|
425
469
|
Deployments.struct_class = Types::Deployments
|
426
470
|
|
471
|
+
DocumentationPart.add_member(:id, Shapes::ShapeRef.new(shape: String, location_name: "id"))
|
472
|
+
DocumentationPart.add_member(:location, Shapes::ShapeRef.new(shape: DocumentationPartLocation, location_name: "location"))
|
473
|
+
DocumentationPart.add_member(:properties, Shapes::ShapeRef.new(shape: String, location_name: "properties"))
|
474
|
+
DocumentationPart.struct_class = Types::DocumentationPart
|
475
|
+
|
476
|
+
DocumentationPartIds.add_member(:ids, Shapes::ShapeRef.new(shape: ListOfString, location_name: "ids"))
|
477
|
+
DocumentationPartIds.add_member(:warnings, Shapes::ShapeRef.new(shape: ListOfString, location_name: "warnings"))
|
478
|
+
DocumentationPartIds.struct_class = Types::DocumentationPartIds
|
479
|
+
|
480
|
+
DocumentationPartLocation.add_member(:type, Shapes::ShapeRef.new(shape: DocumentationPartType, required: true, location_name: "type"))
|
481
|
+
DocumentationPartLocation.add_member(:path, Shapes::ShapeRef.new(shape: String, location_name: "path"))
|
482
|
+
DocumentationPartLocation.add_member(:method, Shapes::ShapeRef.new(shape: String, location_name: "method"))
|
483
|
+
DocumentationPartLocation.add_member(:status_code, Shapes::ShapeRef.new(shape: DocumentationPartLocationStatusCode, location_name: "statusCode"))
|
484
|
+
DocumentationPartLocation.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "name"))
|
485
|
+
DocumentationPartLocation.struct_class = Types::DocumentationPartLocation
|
486
|
+
|
487
|
+
DocumentationParts.add_member(:position, Shapes::ShapeRef.new(shape: String, location_name: "position"))
|
488
|
+
DocumentationParts.add_member(:items, Shapes::ShapeRef.new(shape: ListOfDocumentationPart, location_name: "item"))
|
489
|
+
DocumentationParts.struct_class = Types::DocumentationParts
|
490
|
+
|
491
|
+
DocumentationVersion.add_member(:version, Shapes::ShapeRef.new(shape: String, location_name: "version"))
|
492
|
+
DocumentationVersion.add_member(:created_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "createdDate"))
|
493
|
+
DocumentationVersion.add_member(:description, Shapes::ShapeRef.new(shape: String, location_name: "description"))
|
494
|
+
DocumentationVersion.struct_class = Types::DocumentationVersion
|
495
|
+
|
496
|
+
DocumentationVersions.add_member(:position, Shapes::ShapeRef.new(shape: String, location_name: "position"))
|
497
|
+
DocumentationVersions.add_member(:items, Shapes::ShapeRef.new(shape: ListOfDocumentationVersion, location_name: "item"))
|
498
|
+
DocumentationVersions.struct_class = Types::DocumentationVersions
|
499
|
+
|
427
500
|
DomainName.add_member(:domain_name, Shapes::ShapeRef.new(shape: String, location_name: "domainName"))
|
428
501
|
DomainName.add_member(:certificate_name, Shapes::ShapeRef.new(shape: String, location_name: "certificateName"))
|
429
502
|
DomainName.add_member(:certificate_upload_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "certificateUploadDate"))
|
@@ -499,6 +572,27 @@ module Aws
|
|
499
572
|
GetDeploymentsRequest.add_member(:limit, Shapes::ShapeRef.new(shape: NullableInteger, location: "querystring", location_name: "limit"))
|
500
573
|
GetDeploymentsRequest.struct_class = Types::GetDeploymentsRequest
|
501
574
|
|
575
|
+
GetDocumentationPartRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
576
|
+
GetDocumentationPartRequest.add_member(:documentation_part_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "part_id"))
|
577
|
+
GetDocumentationPartRequest.struct_class = Types::GetDocumentationPartRequest
|
578
|
+
|
579
|
+
GetDocumentationPartsRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
580
|
+
GetDocumentationPartsRequest.add_member(:type, Shapes::ShapeRef.new(shape: DocumentationPartType, location: "querystring", location_name: "type"))
|
581
|
+
GetDocumentationPartsRequest.add_member(:name_query, Shapes::ShapeRef.new(shape: String, location: "querystring", location_name: "name"))
|
582
|
+
GetDocumentationPartsRequest.add_member(:path, Shapes::ShapeRef.new(shape: String, location: "querystring", location_name: "path"))
|
583
|
+
GetDocumentationPartsRequest.add_member(:position, Shapes::ShapeRef.new(shape: String, location: "querystring", location_name: "position"))
|
584
|
+
GetDocumentationPartsRequest.add_member(:limit, Shapes::ShapeRef.new(shape: NullableInteger, location: "querystring", location_name: "limit"))
|
585
|
+
GetDocumentationPartsRequest.struct_class = Types::GetDocumentationPartsRequest
|
586
|
+
|
587
|
+
GetDocumentationVersionRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
588
|
+
GetDocumentationVersionRequest.add_member(:documentation_version, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "doc_version"))
|
589
|
+
GetDocumentationVersionRequest.struct_class = Types::GetDocumentationVersionRequest
|
590
|
+
|
591
|
+
GetDocumentationVersionsRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
592
|
+
GetDocumentationVersionsRequest.add_member(:position, Shapes::ShapeRef.new(shape: String, location: "querystring", location_name: "position"))
|
593
|
+
GetDocumentationVersionsRequest.add_member(:limit, Shapes::ShapeRef.new(shape: NullableInteger, location: "querystring", location_name: "limit"))
|
594
|
+
GetDocumentationVersionsRequest.struct_class = Types::GetDocumentationVersionsRequest
|
595
|
+
|
502
596
|
GetDomainNameRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "domain_name"))
|
503
597
|
GetDomainNameRequest.struct_class = Types::GetDomainNameRequest
|
504
598
|
|
@@ -612,6 +706,14 @@ module Aws
|
|
612
706
|
ImportApiKeysRequest[:payload] = :body
|
613
707
|
ImportApiKeysRequest[:payload_member] = ImportApiKeysRequest.member(:body)
|
614
708
|
|
709
|
+
ImportDocumentationPartsRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
710
|
+
ImportDocumentationPartsRequest.add_member(:mode, Shapes::ShapeRef.new(shape: PutMode, location: "querystring", location_name: "mode"))
|
711
|
+
ImportDocumentationPartsRequest.add_member(:fail_on_warnings, Shapes::ShapeRef.new(shape: Boolean, location: "querystring", location_name: "failonwarnings"))
|
712
|
+
ImportDocumentationPartsRequest.add_member(:body, Shapes::ShapeRef.new(shape: Blob, required: true, location_name: "body"))
|
713
|
+
ImportDocumentationPartsRequest.struct_class = Types::ImportDocumentationPartsRequest
|
714
|
+
ImportDocumentationPartsRequest[:payload] = :body
|
715
|
+
ImportDocumentationPartsRequest[:payload_member] = ImportDocumentationPartsRequest.member(:body)
|
716
|
+
|
615
717
|
ImportRestApiRequest.add_member(:fail_on_warnings, Shapes::ShapeRef.new(shape: Boolean, location: "querystring", location_name: "failonwarnings"))
|
616
718
|
ImportRestApiRequest.add_member(:parameters, Shapes::ShapeRef.new(shape: MapOfStringToString, location: "querystring", location_name: "parameters"))
|
617
719
|
ImportRestApiRequest.add_member(:body, Shapes::ShapeRef.new(shape: Blob, required: true, location_name: "body"))
|
@@ -653,6 +755,10 @@ module Aws
|
|
653
755
|
|
654
756
|
ListOfDeployment.member = Shapes::ShapeRef.new(shape: Deployment)
|
655
757
|
|
758
|
+
ListOfDocumentationPart.member = Shapes::ShapeRef.new(shape: DocumentationPart)
|
759
|
+
|
760
|
+
ListOfDocumentationVersion.member = Shapes::ShapeRef.new(shape: DocumentationVersion)
|
761
|
+
|
656
762
|
ListOfDomainName.member = Shapes::ShapeRef.new(shape: DomainName)
|
657
763
|
|
658
764
|
ListOfLong.member = Shapes::ShapeRef.new(shape: Long)
|
@@ -830,6 +936,7 @@ module Aws
|
|
830
936
|
RestApi.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "name"))
|
831
937
|
RestApi.add_member(:description, Shapes::ShapeRef.new(shape: String, location_name: "description"))
|
832
938
|
RestApi.add_member(:created_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "createdDate"))
|
939
|
+
RestApi.add_member(:version, Shapes::ShapeRef.new(shape: String, location_name: "version"))
|
833
940
|
RestApi.add_member(:warnings, Shapes::ShapeRef.new(shape: ListOfString, location_name: "warnings"))
|
834
941
|
RestApi.add_member(:binary_media_types, Shapes::ShapeRef.new(shape: ListOfString, location_name: "binaryMediaTypes"))
|
835
942
|
RestApi.struct_class = Types::RestApi
|
@@ -854,6 +961,7 @@ module Aws
|
|
854
961
|
Stage.add_member(:cache_cluster_status, Shapes::ShapeRef.new(shape: CacheClusterStatus, location_name: "cacheClusterStatus"))
|
855
962
|
Stage.add_member(:method_settings, Shapes::ShapeRef.new(shape: MapOfMethodSettings, location_name: "methodSettings"))
|
856
963
|
Stage.add_member(:variables, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "variables"))
|
964
|
+
Stage.add_member(:documentation_version, Shapes::ShapeRef.new(shape: String, location_name: "documentationVersion"))
|
857
965
|
Stage.add_member(:created_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "createdDate"))
|
858
966
|
Stage.add_member(:last_updated_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdatedDate"))
|
859
967
|
Stage.struct_class = Types::Stage
|
@@ -933,6 +1041,16 @@ module Aws
|
|
933
1041
|
UpdateDeploymentRequest.add_member(:patch_operations, Shapes::ShapeRef.new(shape: ListOfPatchOperation, location_name: "patchOperations"))
|
934
1042
|
UpdateDeploymentRequest.struct_class = Types::UpdateDeploymentRequest
|
935
1043
|
|
1044
|
+
UpdateDocumentationPartRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
1045
|
+
UpdateDocumentationPartRequest.add_member(:documentation_part_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "part_id"))
|
1046
|
+
UpdateDocumentationPartRequest.add_member(:patch_operations, Shapes::ShapeRef.new(shape: ListOfPatchOperation, location_name: "patchOperations"))
|
1047
|
+
UpdateDocumentationPartRequest.struct_class = Types::UpdateDocumentationPartRequest
|
1048
|
+
|
1049
|
+
UpdateDocumentationVersionRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
|
1050
|
+
UpdateDocumentationVersionRequest.add_member(:documentation_version, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "doc_version"))
|
1051
|
+
UpdateDocumentationVersionRequest.add_member(:patch_operations, Shapes::ShapeRef.new(shape: ListOfPatchOperation, location_name: "patchOperations"))
|
1052
|
+
UpdateDocumentationVersionRequest.struct_class = Types::UpdateDocumentationVersionRequest
|
1053
|
+
|
936
1054
|
UpdateDomainNameRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "domain_name"))
|
937
1055
|
UpdateDomainNameRequest.add_member(:patch_operations, Shapes::ShapeRef.new(shape: ListOfPatchOperation, location_name: "patchOperations"))
|
938
1056
|
UpdateDomainNameRequest.struct_class = Types::UpdateDomainNameRequest
|
@@ -1004,6 +1122,7 @@ module Aws
|
|
1004
1122
|
UsagePlan.add_member(:api_stages, Shapes::ShapeRef.new(shape: ListOfApiStage, location_name: "apiStages"))
|
1005
1123
|
UsagePlan.add_member(:throttle, Shapes::ShapeRef.new(shape: ThrottleSettings, location_name: "throttle"))
|
1006
1124
|
UsagePlan.add_member(:quota, Shapes::ShapeRef.new(shape: QuotaSettings, location_name: "quota"))
|
1125
|
+
UsagePlan.add_member(:product_code, Shapes::ShapeRef.new(shape: String, location_name: "productCode"))
|
1007
1126
|
UsagePlan.struct_class = Types::UsagePlan
|
1008
1127
|
|
1009
1128
|
UsagePlanKey.add_member(:id, Shapes::ShapeRef.new(shape: String, location_name: "id"))
|
@@ -1088,6 +1207,34 @@ module Aws
|
|
1088
1207
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1089
1208
|
end)
|
1090
1209
|
|
1210
|
+
api.add_operation(:create_documentation_part, Seahorse::Model::Operation.new.tap do |o|
|
1211
|
+
o.name = "CreateDocumentationPart"
|
1212
|
+
o.http_method = "POST"
|
1213
|
+
o.http_request_uri = "/restapis/{restapi_id}/documentation/parts"
|
1214
|
+
o.input = Shapes::ShapeRef.new(shape: CreateDocumentationPartRequest)
|
1215
|
+
o.output = Shapes::ShapeRef.new(shape: DocumentationPart)
|
1216
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1217
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1218
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
1219
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1220
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1221
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1222
|
+
end)
|
1223
|
+
|
1224
|
+
api.add_operation(:create_documentation_version, Seahorse::Model::Operation.new.tap do |o|
|
1225
|
+
o.name = "CreateDocumentationVersion"
|
1226
|
+
o.http_method = "POST"
|
1227
|
+
o.http_request_uri = "/restapis/{restapi_id}/documentation/versions"
|
1228
|
+
o.input = Shapes::ShapeRef.new(shape: CreateDocumentationVersionRequest)
|
1229
|
+
o.output = Shapes::ShapeRef.new(shape: DocumentationVersion)
|
1230
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1231
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1232
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
1233
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1234
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1235
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1236
|
+
end)
|
1237
|
+
|
1091
1238
|
api.add_operation(:create_domain_name, Seahorse::Model::Operation.new.tap do |o|
|
1092
1239
|
o.name = "CreateDomainName"
|
1093
1240
|
o.http_method = "POST"
|
@@ -1240,6 +1387,32 @@ module Aws
|
|
1240
1387
|
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1241
1388
|
end)
|
1242
1389
|
|
1390
|
+
api.add_operation(:delete_documentation_part, Seahorse::Model::Operation.new.tap do |o|
|
1391
|
+
o.name = "DeleteDocumentationPart"
|
1392
|
+
o.http_method = "DELETE"
|
1393
|
+
o.http_request_uri = "/restapis/{restapi_id}/documentation/parts/{part_id}"
|
1394
|
+
o.input = Shapes::ShapeRef.new(shape: DeleteDocumentationPartRequest)
|
1395
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1396
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
1397
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1398
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1399
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1400
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1401
|
+
end)
|
1402
|
+
|
1403
|
+
api.add_operation(:delete_documentation_version, Seahorse::Model::Operation.new.tap do |o|
|
1404
|
+
o.name = "DeleteDocumentationVersion"
|
1405
|
+
o.http_method = "DELETE"
|
1406
|
+
o.http_request_uri = "/restapis/{restapi_id}/documentation/versions/{doc_version}"
|
1407
|
+
o.input = Shapes::ShapeRef.new(shape: DeleteDocumentationVersionRequest)
|
1408
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1409
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
1410
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1411
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1412
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1413
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1414
|
+
end)
|
1415
|
+
|
1243
1416
|
api.add_operation(:delete_domain_name, Seahorse::Model::Operation.new.tap do |o|
|
1244
1417
|
o.name = "DeleteDomainName"
|
1245
1418
|
o.http_method = "DELETE"
|
@@ -1559,6 +1732,52 @@ module Aws
|
|
1559
1732
|
)
|
1560
1733
|
end)
|
1561
1734
|
|
1735
|
+
api.add_operation(:get_documentation_part, Seahorse::Model::Operation.new.tap do |o|
|
1736
|
+
o.name = "GetDocumentationPart"
|
1737
|
+
o.http_method = "GET"
|
1738
|
+
o.http_request_uri = "/restapis/{restapi_id}/documentation/parts/{part_id}"
|
1739
|
+
o.input = Shapes::ShapeRef.new(shape: GetDocumentationPartRequest)
|
1740
|
+
o.output = Shapes::ShapeRef.new(shape: DocumentationPart)
|
1741
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
1742
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1743
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1744
|
+
end)
|
1745
|
+
|
1746
|
+
api.add_operation(:get_documentation_parts, Seahorse::Model::Operation.new.tap do |o|
|
1747
|
+
o.name = "GetDocumentationParts"
|
1748
|
+
o.http_method = "GET"
|
1749
|
+
o.http_request_uri = "/restapis/{restapi_id}/documentation/parts"
|
1750
|
+
o.input = Shapes::ShapeRef.new(shape: GetDocumentationPartsRequest)
|
1751
|
+
o.output = Shapes::ShapeRef.new(shape: DocumentationParts)
|
1752
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1753
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
1754
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1755
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1756
|
+
end)
|
1757
|
+
|
1758
|
+
api.add_operation(:get_documentation_version, Seahorse::Model::Operation.new.tap do |o|
|
1759
|
+
o.name = "GetDocumentationVersion"
|
1760
|
+
o.http_method = "GET"
|
1761
|
+
o.http_request_uri = "/restapis/{restapi_id}/documentation/versions/{doc_version}"
|
1762
|
+
o.input = Shapes::ShapeRef.new(shape: GetDocumentationVersionRequest)
|
1763
|
+
o.output = Shapes::ShapeRef.new(shape: DocumentationVersion)
|
1764
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
1765
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1766
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1767
|
+
end)
|
1768
|
+
|
1769
|
+
api.add_operation(:get_documentation_versions, Seahorse::Model::Operation.new.tap do |o|
|
1770
|
+
o.name = "GetDocumentationVersions"
|
1771
|
+
o.http_method = "GET"
|
1772
|
+
o.http_request_uri = "/restapis/{restapi_id}/documentation/versions"
|
1773
|
+
o.input = Shapes::ShapeRef.new(shape: GetDocumentationVersionsRequest)
|
1774
|
+
o.output = Shapes::ShapeRef.new(shape: DocumentationVersions)
|
1775
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1776
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
1777
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1778
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1779
|
+
end)
|
1780
|
+
|
1562
1781
|
api.add_operation(:get_domain_name, Seahorse::Model::Operation.new.tap do |o|
|
1563
1782
|
o.name = "GetDomainName"
|
1564
1783
|
o.http_method = "GET"
|
@@ -1869,6 +2088,19 @@ module Aws
|
|
1869
2088
|
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1870
2089
|
end)
|
1871
2090
|
|
2091
|
+
api.add_operation(:import_documentation_parts, Seahorse::Model::Operation.new.tap do |o|
|
2092
|
+
o.name = "ImportDocumentationParts"
|
2093
|
+
o.http_method = "PUT"
|
2094
|
+
o.http_request_uri = "/restapis/{restapi_id}/documentation/parts"
|
2095
|
+
o.input = Shapes::ShapeRef.new(shape: ImportDocumentationPartsRequest)
|
2096
|
+
o.output = Shapes::ShapeRef.new(shape: DocumentationPartIds)
|
2097
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
2098
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
2099
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
2100
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
2101
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
2102
|
+
end)
|
2103
|
+
|
1872
2104
|
api.add_operation(:import_rest_api, Seahorse::Model::Operation.new.tap do |o|
|
1873
2105
|
o.name = "ImportRestApi"
|
1874
2106
|
o.http_method = "POST"
|
@@ -2050,6 +2282,33 @@ module Aws
|
|
2050
2282
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
2051
2283
|
end)
|
2052
2284
|
|
2285
|
+
api.add_operation(:update_documentation_part, Seahorse::Model::Operation.new.tap do |o|
|
2286
|
+
o.name = "UpdateDocumentationPart"
|
2287
|
+
o.http_method = "PATCH"
|
2288
|
+
o.http_request_uri = "/restapis/{restapi_id}/documentation/parts/{part_id}"
|
2289
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateDocumentationPartRequest)
|
2290
|
+
o.output = Shapes::ShapeRef.new(shape: DocumentationPart)
|
2291
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
2292
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
2293
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
2294
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
2295
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
2296
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
2297
|
+
end)
|
2298
|
+
|
2299
|
+
api.add_operation(:update_documentation_version, Seahorse::Model::Operation.new.tap do |o|
|
2300
|
+
o.name = "UpdateDocumentationVersion"
|
2301
|
+
o.http_method = "PATCH"
|
2302
|
+
o.http_request_uri = "/restapis/{restapi_id}/documentation/versions/{doc_version}"
|
2303
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateDocumentationVersionRequest)
|
2304
|
+
o.output = Shapes::ShapeRef.new(shape: DocumentationVersion)
|
2305
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
2306
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
2307
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
2308
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
2309
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
2310
|
+
end)
|
2311
|
+
|
2053
2312
|
api.add_operation(:update_domain_name, Seahorse::Model::Operation.new.tap do |o|
|
2054
2313
|
o.name = "UpdateDomainName"
|
2055
2314
|
o.http_method = "PATCH"
|
@@ -101,6 +101,11 @@ module Aws
|
|
101
101
|
# The name of the API Key.
|
102
102
|
# @return [String]
|
103
103
|
#
|
104
|
+
# @!attribute [rw] customer_id
|
105
|
+
# An AWS Marketplace customer identifier , when integrating with the
|
106
|
+
# AWS SaaS Marketplace.
|
107
|
+
# @return [String]
|
108
|
+
#
|
104
109
|
# @!attribute [rw] description
|
105
110
|
# The description of the API Key.
|
106
111
|
# @return [String]
|
@@ -129,6 +134,7 @@ module Aws
|
|
129
134
|
:id,
|
130
135
|
:value,
|
131
136
|
:name,
|
137
|
+
:customer_id,
|
132
138
|
:description,
|
133
139
|
:enabled,
|
134
140
|
:created_date,
|
@@ -137,8 +143,7 @@ module Aws
|
|
137
143
|
include Aws::Structure
|
138
144
|
end
|
139
145
|
|
140
|
-
# The identifier of an
|
141
|
-
# plan.
|
146
|
+
# The identifier of an ApiKey used in a UsagePlan.
|
142
147
|
# @!attribute [rw] ids
|
143
148
|
# A list of all the ApiKey identifiers.
|
144
149
|
# @return [Array<String>]
|
@@ -469,6 +474,7 @@ module Aws
|
|
469
474
|
# stage_name: "String",
|
470
475
|
# },
|
471
476
|
# ],
|
477
|
+
# customer_id: "String",
|
472
478
|
# }
|
473
479
|
# @!attribute [rw] name
|
474
480
|
# The name of the ApiKey.
|
@@ -495,13 +501,19 @@ module Aws
|
|
495
501
|
# DEPRECATED FOR USAGE PLANS - Specifies stages associated with the
|
496
502
|
# API key.
|
497
503
|
# @return [Array<Types::StageKey>]
|
504
|
+
#
|
505
|
+
# @!attribute [rw] customer_id
|
506
|
+
# An AWS Marketplace customer identifier , when integrating with the
|
507
|
+
# AWS SaaS Marketplace.
|
508
|
+
# @return [String]
|
498
509
|
class CreateApiKeyRequest < Struct.new(
|
499
510
|
:name,
|
500
511
|
:description,
|
501
512
|
:enabled,
|
502
513
|
:generate_distinct_id,
|
503
514
|
:value,
|
504
|
-
:stage_keys
|
515
|
+
:stage_keys,
|
516
|
+
:customer_id)
|
505
517
|
include Aws::Structure
|
506
518
|
end
|
507
519
|
|
@@ -675,6 +687,78 @@ module Aws
|
|
675
687
|
include Aws::Structure
|
676
688
|
end
|
677
689
|
|
690
|
+
# Creates a new documentation part of a given API.
|
691
|
+
# @note When making an API call, pass CreateDocumentationPartRequest
|
692
|
+
# data as a hash:
|
693
|
+
#
|
694
|
+
# {
|
695
|
+
# rest_api_id: "String", # required
|
696
|
+
# location: { # required
|
697
|
+
# type: "API", # required, accepts API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY
|
698
|
+
# path: "String",
|
699
|
+
# method: "String",
|
700
|
+
# status_code: "DocumentationPartLocationStatusCode",
|
701
|
+
# name: "String",
|
702
|
+
# },
|
703
|
+
# properties: "String", # required
|
704
|
+
# }
|
705
|
+
# @!attribute [rw] rest_api_id
|
706
|
+
# \[Required\] The identifier of an API of the to-be-created
|
707
|
+
# documentation part.
|
708
|
+
# @return [String]
|
709
|
+
#
|
710
|
+
# @!attribute [rw] location
|
711
|
+
# \[Required\] The location of the targeted API entity of the
|
712
|
+
# to-be-created documentation part.
|
713
|
+
# @return [Types::DocumentationPartLocation]
|
714
|
+
#
|
715
|
+
# @!attribute [rw] properties
|
716
|
+
# \[Required\] The new documentation content map of the targeted API
|
717
|
+
# entity. Enclosed key-value pairs are API-specific, but only
|
718
|
+
# Swagger-compliant key-value pairs can be exported and, hence,
|
719
|
+
# published.
|
720
|
+
# @return [String]
|
721
|
+
class CreateDocumentationPartRequest < Struct.new(
|
722
|
+
:rest_api_id,
|
723
|
+
:location,
|
724
|
+
:properties)
|
725
|
+
include Aws::Structure
|
726
|
+
end
|
727
|
+
|
728
|
+
# Creates a new documentation version of a given API.
|
729
|
+
# @note When making an API call, pass CreateDocumentationVersionRequest
|
730
|
+
# data as a hash:
|
731
|
+
#
|
732
|
+
# {
|
733
|
+
# rest_api_id: "String", # required
|
734
|
+
# documentation_version: "String", # required
|
735
|
+
# stage_name: "String",
|
736
|
+
# description: "String",
|
737
|
+
# }
|
738
|
+
# @!attribute [rw] rest_api_id
|
739
|
+
# \[Required\] Specifies the API identifier of the to-be-created
|
740
|
+
# documentation version.
|
741
|
+
# @return [String]
|
742
|
+
#
|
743
|
+
# @!attribute [rw] documentation_version
|
744
|
+
# \[Required\] The version identifier of the new snapshot.
|
745
|
+
# @return [String]
|
746
|
+
#
|
747
|
+
# @!attribute [rw] stage_name
|
748
|
+
# The stage name to be associated with the new documentation snapshot.
|
749
|
+
# @return [String]
|
750
|
+
#
|
751
|
+
# @!attribute [rw] description
|
752
|
+
# A description about the new documentation snapshot.
|
753
|
+
# @return [String]
|
754
|
+
class CreateDocumentationVersionRequest < Struct.new(
|
755
|
+
:rest_api_id,
|
756
|
+
:documentation_version,
|
757
|
+
:stage_name,
|
758
|
+
:description)
|
759
|
+
include Aws::Structure
|
760
|
+
end
|
761
|
+
|
678
762
|
# A request to create a new domain name.
|
679
763
|
# @note When making an API call, pass CreateDomainNameRequest
|
680
764
|
# data as a hash:
|
@@ -799,6 +883,7 @@ module Aws
|
|
799
883
|
# {
|
800
884
|
# name: "String", # required
|
801
885
|
# description: "String",
|
886
|
+
# version: "String",
|
802
887
|
# clone_from: "String",
|
803
888
|
# binary_media_types: ["String"],
|
804
889
|
# }
|
@@ -810,6 +895,10 @@ module Aws
|
|
810
895
|
# The description of the RestApi.
|
811
896
|
# @return [String]
|
812
897
|
#
|
898
|
+
# @!attribute [rw] version
|
899
|
+
# A version identifier for the API.
|
900
|
+
# @return [String]
|
901
|
+
#
|
813
902
|
# @!attribute [rw] clone_from
|
814
903
|
# The ID of the RestApi that you want to clone from.
|
815
904
|
# @return [String]
|
@@ -821,6 +910,7 @@ module Aws
|
|
821
910
|
class CreateRestApiRequest < Struct.new(
|
822
911
|
:name,
|
823
912
|
:description,
|
913
|
+
:version,
|
824
914
|
:clone_from,
|
825
915
|
:binary_media_types)
|
826
916
|
include Aws::Structure
|
@@ -840,6 +930,7 @@ module Aws
|
|
840
930
|
# variables: {
|
841
931
|
# "String" => "String",
|
842
932
|
# },
|
933
|
+
# documentation_version: "String",
|
843
934
|
# }
|
844
935
|
# @!attribute [rw] rest_api_id
|
845
936
|
# The identifier of the RestApi resource for the Stage resource to
|
@@ -871,6 +962,10 @@ module Aws
|
|
871
962
|
# Variable names can have alphanumeric and underscore characters, and
|
872
963
|
# the values must match `[A-Za-z0-9-._~:/?#&=,]+`.
|
873
964
|
# @return [Hash<String,String>]
|
965
|
+
#
|
966
|
+
# @!attribute [rw] documentation_version
|
967
|
+
# The version of the associated API documentation.
|
968
|
+
# @return [String]
|
874
969
|
class CreateStageRequest < Struct.new(
|
875
970
|
:rest_api_id,
|
876
971
|
:stage_name,
|
@@ -878,7 +973,8 @@ module Aws
|
|
878
973
|
:description,
|
879
974
|
:cache_cluster_enabled,
|
880
975
|
:cache_cluster_size,
|
881
|
-
:variables
|
976
|
+
:variables,
|
977
|
+
:documentation_version)
|
882
978
|
include Aws::Structure
|
883
979
|
end
|
884
980
|
|
@@ -1059,6 +1155,51 @@ module Aws
|
|
1059
1155
|
include Aws::Structure
|
1060
1156
|
end
|
1061
1157
|
|
1158
|
+
# Deletes an existing documentation part of an API.
|
1159
|
+
# @note When making an API call, pass DeleteDocumentationPartRequest
|
1160
|
+
# data as a hash:
|
1161
|
+
#
|
1162
|
+
# {
|
1163
|
+
# rest_api_id: "String", # required
|
1164
|
+
# documentation_part_id: "String", # required
|
1165
|
+
# }
|
1166
|
+
# @!attribute [rw] rest_api_id
|
1167
|
+
# \[Required\] Specifies the identifier of an API of the to-be-deleted
|
1168
|
+
# documentation part.
|
1169
|
+
# @return [String]
|
1170
|
+
#
|
1171
|
+
# @!attribute [rw] documentation_part_id
|
1172
|
+
# \[Required\] The identifier of the to-be-deleted documentation part.
|
1173
|
+
# @return [String]
|
1174
|
+
class DeleteDocumentationPartRequest < Struct.new(
|
1175
|
+
:rest_api_id,
|
1176
|
+
:documentation_part_id)
|
1177
|
+
include Aws::Structure
|
1178
|
+
end
|
1179
|
+
|
1180
|
+
# Deletes an existing documentation version of an API.
|
1181
|
+
# @note When making an API call, pass DeleteDocumentationVersionRequest
|
1182
|
+
# data as a hash:
|
1183
|
+
#
|
1184
|
+
# {
|
1185
|
+
# rest_api_id: "String", # required
|
1186
|
+
# documentation_version: "String", # required
|
1187
|
+
# }
|
1188
|
+
# @!attribute [rw] rest_api_id
|
1189
|
+
# \[Required\] The identifier of an API of a to-be-deleted
|
1190
|
+
# documentation snapshot.
|
1191
|
+
# @return [String]
|
1192
|
+
#
|
1193
|
+
# @!attribute [rw] documentation_version
|
1194
|
+
# \[Required\] The version identifier of a to-be-deleted documentation
|
1195
|
+
# snapshot.
|
1196
|
+
# @return [String]
|
1197
|
+
class DeleteDocumentationVersionRequest < Struct.new(
|
1198
|
+
:rest_api_id,
|
1199
|
+
:documentation_version)
|
1200
|
+
include Aws::Structure
|
1201
|
+
end
|
1202
|
+
|
1062
1203
|
# A request to delete the DomainName resource.
|
1063
1204
|
# @note When making an API call, pass DeleteDomainNameRequest
|
1064
1205
|
# data as a hash:
|
@@ -1390,6 +1531,249 @@ module Aws
|
|
1390
1531
|
include Aws::Structure
|
1391
1532
|
end
|
1392
1533
|
|
1534
|
+
# A documentation part for a targeted API entity.
|
1535
|
+
#
|
1536
|
+
# <div class="remarks" markdown="1">
|
1537
|
+
# A documentation part consists of a content map (`properties`) and a
|
1538
|
+
# target (`location`). The target specifies an API entity to which the
|
1539
|
+
# documentation content applies. The supported API entity types are
|
1540
|
+
# `API`, `AUTHORIZER`, `MODEL`, `RESOURCE`, `METHOD`, `PATH_PARAMETER`,
|
1541
|
+
# `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`,
|
1542
|
+
# `RESPONSE_HEADER`, and `RESPONSE_BODY`. Valid `location` fields depend
|
1543
|
+
# on the API entity type. All valid fields are not required.
|
1544
|
+
#
|
1545
|
+
# The content map is a JSON string of API-specific key-value pairs.
|
1546
|
+
# Although an API can use any shape for the content map, only the
|
1547
|
+
# Swagger-compliant documentation fields will be injected into the
|
1548
|
+
# associated API entity definition in the exported Swagger definition
|
1549
|
+
# file.
|
1550
|
+
#
|
1551
|
+
# </div>
|
1552
|
+
#
|
1553
|
+
# <div class="seeAlso">
|
1554
|
+
# [Documenting an API][1], DocumentationParts
|
1555
|
+
# </div>
|
1556
|
+
#
|
1557
|
+
#
|
1558
|
+
#
|
1559
|
+
# [1]: http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
1560
|
+
# @!attribute [rw] id
|
1561
|
+
# The DocumentationPart identifier, generated by Amazon API Gateway
|
1562
|
+
# when the `DocumentationPart` is created.
|
1563
|
+
# @return [String]
|
1564
|
+
#
|
1565
|
+
# @!attribute [rw] location
|
1566
|
+
# The location of the API entity to which the documentation applies.
|
1567
|
+
# Valid fields depend on the targeted API entity type. All the valid
|
1568
|
+
# location fields are not required. If not explicitly specified, a
|
1569
|
+
# valid location field is treated as a wildcard and associated
|
1570
|
+
# documentation content may be inherited by matching entities, unless
|
1571
|
+
# overridden.
|
1572
|
+
# @return [Types::DocumentationPartLocation]
|
1573
|
+
#
|
1574
|
+
# @!attribute [rw] properties
|
1575
|
+
# A content map of API-specific key-value pairs describing the
|
1576
|
+
# targeted API entity. The map must be encoded as a JSON string, e.g.,
|
1577
|
+
# `"\{ "description": "The API does ..." \}"`. Only
|
1578
|
+
# Swagger-compliant documentation-related fields from the
|
1579
|
+
# <literal>properties</literal>
|
1580
|
+
#
|
1581
|
+
# map are exported and, hence, published as part of the API entity
|
1582
|
+
# definitions, while the original documentation parts are exported in
|
1583
|
+
# a Swagger extension of `x-amazon-apigateway-documentation`.
|
1584
|
+
# @return [String]
|
1585
|
+
class DocumentationPart < Struct.new(
|
1586
|
+
:id,
|
1587
|
+
:location,
|
1588
|
+
:properties)
|
1589
|
+
include Aws::Structure
|
1590
|
+
end
|
1591
|
+
|
1592
|
+
# A collection of the imported DocumentationPart identifiers.
|
1593
|
+
#
|
1594
|
+
# <div class="remarks">
|
1595
|
+
# This is used to return the result when documentation parts in an
|
1596
|
+
# external (e.g., Swagger) file are imported into Amazon API Gateway
|
1597
|
+
# </div>
|
1598
|
+
#
|
1599
|
+
# <div class="seeAlso">
|
1600
|
+
# [Documenting an API][1], [documentationpart:import][2],
|
1601
|
+
# DocumentationPart
|
1602
|
+
# </div>
|
1603
|
+
#
|
1604
|
+
#
|
1605
|
+
#
|
1606
|
+
# [1]: http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
1607
|
+
# [2]: http://docs.aws.amazon.com/apigateway/api-reference/link-relation/documentationpart-import/
|
1608
|
+
# @!attribute [rw] ids
|
1609
|
+
# A list of the returned documentation part identifiers.
|
1610
|
+
# @return [Array<String>]
|
1611
|
+
#
|
1612
|
+
# @!attribute [rw] warnings
|
1613
|
+
# A list of warning messages reported during import of documentation
|
1614
|
+
# parts.
|
1615
|
+
# @return [Array<String>]
|
1616
|
+
class DocumentationPartIds < Struct.new(
|
1617
|
+
:ids,
|
1618
|
+
:warnings)
|
1619
|
+
include Aws::Structure
|
1620
|
+
end
|
1621
|
+
|
1622
|
+
# Specifies the target API entity to which the documentation applies.
|
1623
|
+
# @note When making an API call, pass DocumentationPartLocation
|
1624
|
+
# data as a hash:
|
1625
|
+
#
|
1626
|
+
# {
|
1627
|
+
# type: "API", # required, accepts API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY
|
1628
|
+
# path: "String",
|
1629
|
+
# method: "String",
|
1630
|
+
# status_code: "DocumentationPartLocationStatusCode",
|
1631
|
+
# name: "String",
|
1632
|
+
# }
|
1633
|
+
# @!attribute [rw] type
|
1634
|
+
# The type of API entity to which the documentation content applies.
|
1635
|
+
# It is a valid and required field for API entity types of `API`,
|
1636
|
+
# `AUTHORIZER`, `MODEL`, `RESOURCE`, `METHOD`, `PATH_PARAMETER`,
|
1637
|
+
# `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`,
|
1638
|
+
# `RESPONSE_HEADER`, and `RESPONSE_BODY`. Content inheritance does not
|
1639
|
+
# apply to any entity of the `API`, `AUTHROZER`, `MODEL`, or
|
1640
|
+
# `RESOURCE` type.
|
1641
|
+
# @return [String]
|
1642
|
+
#
|
1643
|
+
# @!attribute [rw] path
|
1644
|
+
# The URL path of the target. It is a valid field for the API entity
|
1645
|
+
# types of `RESOURCE`, `METHOD`, `PATH_PARAMETER`, `QUERY_PARAMETER`,
|
1646
|
+
# `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`, `RESPONSE_HEADER`, and
|
1647
|
+
# `RESPONSE_BODY`. The default value is `/` for the root resource.
|
1648
|
+
# When an applicable child entity inherits the content of another
|
1649
|
+
# entity of the same type with more general specifications of the
|
1650
|
+
# other `location` attributes, the child entity's `path` attribute
|
1651
|
+
# must match that of the parent entity as a prefix.
|
1652
|
+
# @return [String]
|
1653
|
+
#
|
1654
|
+
# @!attribute [rw] method
|
1655
|
+
# The HTTP verb of a method. It is a valid field for the API entity
|
1656
|
+
# types of `METHOD`, `PATH_PARAMETER`, `QUERY_PARAMETER`,
|
1657
|
+
# `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`, `RESPONSE_HEADER`, and
|
1658
|
+
# `RESPONSE_BODY`. The default value is `*` for any method. When an
|
1659
|
+
# applicable child entity inherits the content of an entity of the
|
1660
|
+
# same type with more general specifications of the other `location`
|
1661
|
+
# attributes, the child entity's `method` attribute must match that
|
1662
|
+
# of the parent entity exactly.
|
1663
|
+
# @return [String]
|
1664
|
+
#
|
1665
|
+
# @!attribute [rw] status_code
|
1666
|
+
# The HTTP status code of a response. It is a valid field for the API
|
1667
|
+
# entity types of `RESPONSE`, `RESPONSE_HEADER`, and `RESPONSE_BODY`.
|
1668
|
+
# The default value is `*` for any status code. When an applicable
|
1669
|
+
# child entity inherits the content of an entity of the same type with
|
1670
|
+
# more general specifications of the other `location` attributes, the
|
1671
|
+
# child entity's `statusCode` attribute must match that of the parent
|
1672
|
+
# entity exactly.
|
1673
|
+
# @return [String]
|
1674
|
+
#
|
1675
|
+
# @!attribute [rw] name
|
1676
|
+
# The name of the targeted API entity. It is a valid and required
|
1677
|
+
# field for the API entity types of `AUTHORIZER`, `MODEL`,
|
1678
|
+
# `PATH_PARAMETER`, `QUERY_PARAMETER`, `REQUEST_HEADER`,
|
1679
|
+
# `REQUEST_BODY` and `RESPONSE_HEADER`. It is an invalid field for any
|
1680
|
+
# other entity type.
|
1681
|
+
# @return [String]
|
1682
|
+
class DocumentationPartLocation < Struct.new(
|
1683
|
+
:type,
|
1684
|
+
:path,
|
1685
|
+
:method,
|
1686
|
+
:status_code,
|
1687
|
+
:name)
|
1688
|
+
include Aws::Structure
|
1689
|
+
end
|
1690
|
+
|
1691
|
+
# The collection of documentation parts of an API.
|
1692
|
+
#
|
1693
|
+
# <div class="remarks"></div>
|
1694
|
+
#
|
1695
|
+
# <div class="seeAlso">
|
1696
|
+
# [Documenting an API][1], DocumentationPart
|
1697
|
+
# </div>
|
1698
|
+
#
|
1699
|
+
#
|
1700
|
+
#
|
1701
|
+
# [1]: http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
1702
|
+
# @!attribute [rw] position
|
1703
|
+
# @return [String]
|
1704
|
+
#
|
1705
|
+
# @!attribute [rw] items
|
1706
|
+
# The current page of DocumentationPart resources in the
|
1707
|
+
# DocumentationParts collection.
|
1708
|
+
# @return [Array<Types::DocumentationPart>]
|
1709
|
+
class DocumentationParts < Struct.new(
|
1710
|
+
:position,
|
1711
|
+
:items)
|
1712
|
+
include Aws::Structure
|
1713
|
+
end
|
1714
|
+
|
1715
|
+
# A snapshot of the documentation of an API.
|
1716
|
+
#
|
1717
|
+
# <div class="remarks" markdown="1">
|
1718
|
+
# Publishing API documentation involves creating a documentation version
|
1719
|
+
# associated with an API stage and exporting the versioned documentation
|
1720
|
+
# to an external (e.g., Swagger) file.
|
1721
|
+
#
|
1722
|
+
# </div>
|
1723
|
+
#
|
1724
|
+
# <div class="seeAlso">
|
1725
|
+
# [Documenting an API][1], DocumentationPart, DocumentationVersions
|
1726
|
+
# </div>
|
1727
|
+
#
|
1728
|
+
#
|
1729
|
+
#
|
1730
|
+
# [1]: http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
1731
|
+
# @!attribute [rw] version
|
1732
|
+
# The version identifier of the API documentation snapshot.
|
1733
|
+
# @return [String]
|
1734
|
+
#
|
1735
|
+
# @!attribute [rw] created_date
|
1736
|
+
# The date when the API documentation snapshot is created.
|
1737
|
+
# @return [Time]
|
1738
|
+
#
|
1739
|
+
# @!attribute [rw] description
|
1740
|
+
# The description of the API documentation snapshot.
|
1741
|
+
# @return [String]
|
1742
|
+
class DocumentationVersion < Struct.new(
|
1743
|
+
:version,
|
1744
|
+
:created_date,
|
1745
|
+
:description)
|
1746
|
+
include Aws::Structure
|
1747
|
+
end
|
1748
|
+
|
1749
|
+
# The collection of documentation snapshots of an API.
|
1750
|
+
#
|
1751
|
+
# <div class="remarks" markdown="1">
|
1752
|
+
# Use the DocumentationVersions to manage documentation snapshots
|
1753
|
+
# associated with various API stages.
|
1754
|
+
#
|
1755
|
+
# </div>
|
1756
|
+
#
|
1757
|
+
# <div class="seeAlso">
|
1758
|
+
# [Documenting an API][1], DocumentationPart, DocumentationVersion
|
1759
|
+
# </div>
|
1760
|
+
#
|
1761
|
+
#
|
1762
|
+
#
|
1763
|
+
# [1]: http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html
|
1764
|
+
# @!attribute [rw] position
|
1765
|
+
# @return [String]
|
1766
|
+
#
|
1767
|
+
# @!attribute [rw] items
|
1768
|
+
# The current page of DocumentationVersion items from the
|
1769
|
+
# DocumentationVersions collection of an API.
|
1770
|
+
# @return [Array<Types::DocumentationVersion>]
|
1771
|
+
class DocumentationVersions < Struct.new(
|
1772
|
+
:position,
|
1773
|
+
:items)
|
1774
|
+
include Aws::Structure
|
1775
|
+
end
|
1776
|
+
|
1393
1777
|
# Represents a domain name that is contained in a simpler, more
|
1394
1778
|
# intuitive URL that can be called.
|
1395
1779
|
#
|
@@ -1584,6 +1968,8 @@ module Aws
|
|
1584
1968
|
# @return [String]
|
1585
1969
|
#
|
1586
1970
|
# @!attribute [rw] customer_id
|
1971
|
+
# The identifier of a customer in AWS Marketplace or an external
|
1972
|
+
# system, such as a developer portal.
|
1587
1973
|
# @return [String]
|
1588
1974
|
#
|
1589
1975
|
# @!attribute [rw] include_values
|
@@ -1799,6 +2185,129 @@ module Aws
|
|
1799
2185
|
include Aws::Structure
|
1800
2186
|
end
|
1801
2187
|
|
2188
|
+
# Gets a specified documentation part of a given API.
|
2189
|
+
# @note When making an API call, pass GetDocumentationPartRequest
|
2190
|
+
# data as a hash:
|
2191
|
+
#
|
2192
|
+
# {
|
2193
|
+
# rest_api_id: "String", # required
|
2194
|
+
# documentation_part_id: "String", # required
|
2195
|
+
# }
|
2196
|
+
# @!attribute [rw] rest_api_id
|
2197
|
+
# \[Required\] The identifier of an API of the to-be-retrieved
|
2198
|
+
# documentation part.
|
2199
|
+
# @return [String]
|
2200
|
+
#
|
2201
|
+
# @!attribute [rw] documentation_part_id
|
2202
|
+
# \[Required\] The identifier of the to-be-retrieved documentation
|
2203
|
+
# part.
|
2204
|
+
# @return [String]
|
2205
|
+
class GetDocumentationPartRequest < Struct.new(
|
2206
|
+
:rest_api_id,
|
2207
|
+
:documentation_part_id)
|
2208
|
+
include Aws::Structure
|
2209
|
+
end
|
2210
|
+
|
2211
|
+
# Gets the documentation parts of an API. The result may be filtered by
|
2212
|
+
# the type, name, or path of API entities (targets).
|
2213
|
+
# @note When making an API call, pass GetDocumentationPartsRequest
|
2214
|
+
# data as a hash:
|
2215
|
+
#
|
2216
|
+
# {
|
2217
|
+
# rest_api_id: "String", # required
|
2218
|
+
# type: "API", # accepts API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY
|
2219
|
+
# name_query: "String",
|
2220
|
+
# path: "String",
|
2221
|
+
# position: "String",
|
2222
|
+
# limit: 1,
|
2223
|
+
# }
|
2224
|
+
# @!attribute [rw] rest_api_id
|
2225
|
+
# \[Required\] The identifier of the API of the to-be-retrieved
|
2226
|
+
# documentation parts.
|
2227
|
+
# @return [String]
|
2228
|
+
#
|
2229
|
+
# @!attribute [rw] type
|
2230
|
+
# The type of API entities of the to-be-retrieved documentation parts.
|
2231
|
+
# @return [String]
|
2232
|
+
#
|
2233
|
+
# @!attribute [rw] name_query
|
2234
|
+
# The name of API entities of the to-be-retrieved documentation parts.
|
2235
|
+
# @return [String]
|
2236
|
+
#
|
2237
|
+
# @!attribute [rw] path
|
2238
|
+
# The path of API entities of the to-be-retrieved documentation parts.
|
2239
|
+
# @return [String]
|
2240
|
+
#
|
2241
|
+
# @!attribute [rw] position
|
2242
|
+
# The position of the to-be-retrieved documentation part in the
|
2243
|
+
# DocumentationParts collection.
|
2244
|
+
# @return [String]
|
2245
|
+
#
|
2246
|
+
# @!attribute [rw] limit
|
2247
|
+
# The size of the paged results.
|
2248
|
+
# @return [Integer]
|
2249
|
+
class GetDocumentationPartsRequest < Struct.new(
|
2250
|
+
:rest_api_id,
|
2251
|
+
:type,
|
2252
|
+
:name_query,
|
2253
|
+
:path,
|
2254
|
+
:position,
|
2255
|
+
:limit)
|
2256
|
+
include Aws::Structure
|
2257
|
+
end
|
2258
|
+
|
2259
|
+
# Gets a documentation snapshot of an API.
|
2260
|
+
# @note When making an API call, pass GetDocumentationVersionRequest
|
2261
|
+
# data as a hash:
|
2262
|
+
#
|
2263
|
+
# {
|
2264
|
+
# rest_api_id: "String", # required
|
2265
|
+
# documentation_version: "String", # required
|
2266
|
+
# }
|
2267
|
+
# @!attribute [rw] rest_api_id
|
2268
|
+
# \[Required\] The identifier of the API of the to-be-retrieved
|
2269
|
+
# documentation snapshot.
|
2270
|
+
# @return [String]
|
2271
|
+
#
|
2272
|
+
# @!attribute [rw] documentation_version
|
2273
|
+
# \[Required\] The version identifier of the to-be-retrieved
|
2274
|
+
# documentation snapshot.
|
2275
|
+
# @return [String]
|
2276
|
+
class GetDocumentationVersionRequest < Struct.new(
|
2277
|
+
:rest_api_id,
|
2278
|
+
:documentation_version)
|
2279
|
+
include Aws::Structure
|
2280
|
+
end
|
2281
|
+
|
2282
|
+
# Gets the documentation versions of an API.
|
2283
|
+
# @note When making an API call, pass GetDocumentationVersionsRequest
|
2284
|
+
# data as a hash:
|
2285
|
+
#
|
2286
|
+
# {
|
2287
|
+
# rest_api_id: "String", # required
|
2288
|
+
# position: "String",
|
2289
|
+
# limit: 1,
|
2290
|
+
# }
|
2291
|
+
# @!attribute [rw] rest_api_id
|
2292
|
+
# \[Required\] The identifier of an API of the to-be-retrieved
|
2293
|
+
# documentation versions.
|
2294
|
+
# @return [String]
|
2295
|
+
#
|
2296
|
+
# @!attribute [rw] position
|
2297
|
+
# The position of the returned `DocumentationVersion` in the
|
2298
|
+
# DocumentationVersions collection.
|
2299
|
+
# @return [String]
|
2300
|
+
#
|
2301
|
+
# @!attribute [rw] limit
|
2302
|
+
# The page size of the returned documentation versions.
|
2303
|
+
# @return [Integer]
|
2304
|
+
class GetDocumentationVersionsRequest < Struct.new(
|
2305
|
+
:rest_api_id,
|
2306
|
+
:position,
|
2307
|
+
:limit)
|
2308
|
+
include Aws::Structure
|
2309
|
+
end
|
2310
|
+
|
1802
2311
|
# Request to get the name of a DomainName resource.
|
1803
2312
|
# @note When making an API call, pass GetDomainNameRequest
|
1804
2313
|
# data as a hash:
|
@@ -2452,6 +2961,47 @@ module Aws
|
|
2452
2961
|
include Aws::Structure
|
2453
2962
|
end
|
2454
2963
|
|
2964
|
+
# Import documentation parts from an external (e.g., Swagger) definition
|
2965
|
+
# file.
|
2966
|
+
# @note When making an API call, pass ImportDocumentationPartsRequest
|
2967
|
+
# data as a hash:
|
2968
|
+
#
|
2969
|
+
# {
|
2970
|
+
# rest_api_id: "String", # required
|
2971
|
+
# mode: "merge", # accepts merge, overwrite
|
2972
|
+
# fail_on_warnings: false,
|
2973
|
+
# body: "data", # required
|
2974
|
+
# }
|
2975
|
+
# @!attribute [rw] rest_api_id
|
2976
|
+
# \[Required\] The identifier of an API of the to-be-imported
|
2977
|
+
# documentation parts.
|
2978
|
+
# @return [String]
|
2979
|
+
#
|
2980
|
+
# @!attribute [rw] mode
|
2981
|
+
# A query parameter to indicate whether to overwrite (`OVERWRITE`) any
|
2982
|
+
# existing DocumentationParts definition or to merge (`MERGE`) the new
|
2983
|
+
# definition into the existing one. The default value is `MERGE`.
|
2984
|
+
# @return [String]
|
2985
|
+
#
|
2986
|
+
# @!attribute [rw] fail_on_warnings
|
2987
|
+
# A query parameter to specify whether to rollback the documentation
|
2988
|
+
# importation (`true`) or not (`false`) when a warning is encountered.
|
2989
|
+
# The default value is `false`.
|
2990
|
+
# @return [Boolean]
|
2991
|
+
#
|
2992
|
+
# @!attribute [rw] body
|
2993
|
+
# \[Required\] Raw byte array representing the to-be-imported
|
2994
|
+
# documentation parts. To import from a Swagger file, this is a JSON
|
2995
|
+
# object.
|
2996
|
+
# @return [String]
|
2997
|
+
class ImportDocumentationPartsRequest < Struct.new(
|
2998
|
+
:rest_api_id,
|
2999
|
+
:mode,
|
3000
|
+
:fail_on_warnings,
|
3001
|
+
:body)
|
3002
|
+
include Aws::Structure
|
3003
|
+
end
|
3004
|
+
|
2455
3005
|
# A POST request to import an API to Amazon API Gateway using an input
|
2456
3006
|
# of an API definition file.
|
2457
3007
|
# @note When making an API call, pass ImportRestApiRequest
|
@@ -3759,6 +4309,10 @@ module Aws
|
|
3759
4309
|
# [1]: http://www.iso.org/iso/home/standards/iso8601.htm
|
3760
4310
|
# @return [Time]
|
3761
4311
|
#
|
4312
|
+
# @!attribute [rw] version
|
4313
|
+
# A version identifier for the API.
|
4314
|
+
# @return [String]
|
4315
|
+
#
|
3762
4316
|
# @!attribute [rw] warnings
|
3763
4317
|
# The warning messages reported when `failonwarnings` is turned on
|
3764
4318
|
# during API import.
|
@@ -3773,6 +4327,7 @@ module Aws
|
|
3773
4327
|
:name,
|
3774
4328
|
:description,
|
3775
4329
|
:created_date,
|
4330
|
+
:version,
|
3776
4331
|
:warnings,
|
3777
4332
|
:binary_media_types)
|
3778
4333
|
include Aws::Structure
|
@@ -3874,6 +4429,10 @@ module Aws
|
|
3874
4429
|
# the values must match `[A-Za-z0-9-._~:/?#&=,]+`.
|
3875
4430
|
# @return [Hash<String,String>]
|
3876
4431
|
#
|
4432
|
+
# @!attribute [rw] documentation_version
|
4433
|
+
# The version of the associated API documentation.
|
4434
|
+
# @return [String]
|
4435
|
+
#
|
3877
4436
|
# @!attribute [rw] created_date
|
3878
4437
|
# The date and time that the stage was created, in [ISO 8601
|
3879
4438
|
# format][1].
|
@@ -3901,6 +4460,7 @@ module Aws
|
|
3901
4460
|
:cache_cluster_status,
|
3902
4461
|
:method_settings,
|
3903
4462
|
:variables,
|
4463
|
+
:documentation_version,
|
3904
4464
|
:created_date,
|
3905
4465
|
:last_updated_date)
|
3906
4466
|
include Aws::Structure
|
@@ -4395,6 +4955,79 @@ module Aws
|
|
4395
4955
|
include Aws::Structure
|
4396
4956
|
end
|
4397
4957
|
|
4958
|
+
# Updates an existing documentation part of a given API.
|
4959
|
+
# @note When making an API call, pass UpdateDocumentationPartRequest
|
4960
|
+
# data as a hash:
|
4961
|
+
#
|
4962
|
+
# {
|
4963
|
+
# rest_api_id: "String", # required
|
4964
|
+
# documentation_part_id: "String", # required
|
4965
|
+
# patch_operations: [
|
4966
|
+
# {
|
4967
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
4968
|
+
# path: "String",
|
4969
|
+
# value: "String",
|
4970
|
+
# from: "String",
|
4971
|
+
# },
|
4972
|
+
# ],
|
4973
|
+
# }
|
4974
|
+
# @!attribute [rw] rest_api_id
|
4975
|
+
# \[Required\] The identifier of an API of the to-be-updated
|
4976
|
+
# documentation part.
|
4977
|
+
# @return [String]
|
4978
|
+
#
|
4979
|
+
# @!attribute [rw] documentation_part_id
|
4980
|
+
# \[Required\] The identifier of the to-be-updated documentation part.
|
4981
|
+
# @return [String]
|
4982
|
+
#
|
4983
|
+
# @!attribute [rw] patch_operations
|
4984
|
+
# A list of update operations to be applied to the specified resource
|
4985
|
+
# and in the order specified in this list.
|
4986
|
+
# @return [Array<Types::PatchOperation>]
|
4987
|
+
class UpdateDocumentationPartRequest < Struct.new(
|
4988
|
+
:rest_api_id,
|
4989
|
+
:documentation_part_id,
|
4990
|
+
:patch_operations)
|
4991
|
+
include Aws::Structure
|
4992
|
+
end
|
4993
|
+
|
4994
|
+
# Updates an existing documentation version of an API.
|
4995
|
+
# @note When making an API call, pass UpdateDocumentationVersionRequest
|
4996
|
+
# data as a hash:
|
4997
|
+
#
|
4998
|
+
# {
|
4999
|
+
# rest_api_id: "String", # required
|
5000
|
+
# documentation_version: "String", # required
|
5001
|
+
# patch_operations: [
|
5002
|
+
# {
|
5003
|
+
# op: "add", # accepts add, remove, replace, move, copy, test
|
5004
|
+
# path: "String",
|
5005
|
+
# value: "String",
|
5006
|
+
# from: "String",
|
5007
|
+
# },
|
5008
|
+
# ],
|
5009
|
+
# }
|
5010
|
+
# @!attribute [rw] rest_api_id
|
5011
|
+
# \[Required\] The identifier of an API of the to-be-updated
|
5012
|
+
# documentation version.
|
5013
|
+
# @return [String]
|
5014
|
+
#
|
5015
|
+
# @!attribute [rw] documentation_version
|
5016
|
+
# \[Required\] The version identifier of the to-be-updated
|
5017
|
+
# documentation version.
|
5018
|
+
# @return [String]
|
5019
|
+
#
|
5020
|
+
# @!attribute [rw] patch_operations
|
5021
|
+
# A list of update operations to be applied to the specified resource
|
5022
|
+
# and in the order specified in this list.
|
5023
|
+
# @return [Array<Types::PatchOperation>]
|
5024
|
+
class UpdateDocumentationVersionRequest < Struct.new(
|
5025
|
+
:rest_api_id,
|
5026
|
+
:documentation_version,
|
5027
|
+
:patch_operations)
|
5028
|
+
include Aws::Structure
|
5029
|
+
end
|
5030
|
+
|
4398
5031
|
# A request to change information about the DomainName resource.
|
4399
5032
|
# @note When making an API call, pass UpdateDomainNameRequest
|
4400
5033
|
# data as a hash:
|
@@ -4888,13 +5521,19 @@ module Aws
|
|
4888
5521
|
# The maximum number of permitted requests per a given unit time
|
4889
5522
|
# interval.
|
4890
5523
|
# @return [Types::QuotaSettings]
|
5524
|
+
#
|
5525
|
+
# @!attribute [rw] product_code
|
5526
|
+
# The AWS Markeplace product identifier to associate with the usage
|
5527
|
+
# plan as a SaaS product on AWS Marketplace.
|
5528
|
+
# @return [String]
|
4891
5529
|
class UsagePlan < Struct.new(
|
4892
5530
|
:id,
|
4893
5531
|
:name,
|
4894
5532
|
:description,
|
4895
5533
|
:api_stages,
|
4896
5534
|
:throttle,
|
4897
|
-
:quota
|
5535
|
+
:quota,
|
5536
|
+
:product_code)
|
4898
5537
|
include Aws::Structure
|
4899
5538
|
end
|
4900
5539
|
|