/
docs-2.json
2198 lines (2198 loc) · 176 KB
/
docs-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version": "2.0",
"service": "<fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>",
"operations": {
"CreateApiKey": "<p>Create an ApiKey resource. </p>",
"CreateAuthorizer": "<p>Adds a new Authorizer resource to an existing RestApi resource.</p>",
"CreateBasePathMapping": "<p>Creates a new BasePathMapping resource.</p>",
"CreateDeployment": "<p>Creates a Deployment resource, which makes a specified RestApi callable over the internet.</p>",
"CreateDocumentationPart": "<p>Creates a documentation part.</p>",
"CreateDocumentationVersion": "<p>Creates a documentation version</p>",
"CreateDomainName": "<p>Creates a new domain name.</p>",
"CreateModel": "<p>Adds a new Model resource to an existing RestApi resource.</p>",
"CreateRequestValidator": "<p>Creates a RequestValidator of a given RestApi.</p>",
"CreateResource": "<p>Creates a Resource resource.</p>",
"CreateRestApi": "<p>Creates a new RestApi resource.</p>",
"CreateStage": "<p>Creates a new Stage resource that references a pre-existing Deployment for the API. </p>",
"CreateUsagePlan": "<p>Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload. </p>",
"CreateUsagePlanKey": "<p>Creates a usage plan key for adding an existing API key to a usage plan.</p>",
"CreateVpcLink": "<p>Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.</p>",
"DeleteApiKey": "<p>Deletes the ApiKey resource.</p>",
"DeleteAuthorizer": "<p>Deletes an existing Authorizer resource.</p>",
"DeleteBasePathMapping": "<p>Deletes the BasePathMapping resource.</p>",
"DeleteClientCertificate": "<p>Deletes the ClientCertificate resource.</p>",
"DeleteDeployment": "<p>Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.</p>",
"DeleteDocumentationPart": "<p>Deletes a documentation part</p>",
"DeleteDocumentationVersion": "<p>Deletes a documentation version.</p>",
"DeleteDomainName": "<p>Deletes the DomainName resource.</p>",
"DeleteGatewayResponse": "<p>Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.</p>",
"DeleteIntegration": "<p>Represents a delete integration.</p>",
"DeleteIntegrationResponse": "<p>Represents a delete integration response.</p>",
"DeleteMethod": "<p>Deletes an existing Method resource.</p>",
"DeleteMethodResponse": "<p>Deletes an existing MethodResponse resource.</p>",
"DeleteModel": "<p>Deletes a model.</p>",
"DeleteRequestValidator": "<p>Deletes a RequestValidator of a given RestApi.</p>",
"DeleteResource": "<p>Deletes a Resource resource.</p>",
"DeleteRestApi": "<p>Deletes the specified API.</p>",
"DeleteStage": "<p>Deletes a Stage resource.</p>",
"DeleteUsagePlan": "<p>Deletes a usage plan of a given plan Id.</p>",
"DeleteUsagePlanKey": "<p>Deletes a usage plan key and remove the underlying API key from the associated usage plan.</p>",
"DeleteVpcLink": "<p>Deletes an existing VpcLink of a specified identifier.</p>",
"FlushStageAuthorizersCache": "<p>Flushes all authorizer cache entries on a stage.</p>",
"FlushStageCache": "<p>Flushes a stage's cache.</p>",
"GenerateClientCertificate": "<p>Generates a ClientCertificate resource.</p>",
"GetAccount": "<p>Gets information about the current Account resource.</p>",
"GetApiKey": "<p>Gets information about the current ApiKey resource.</p>",
"GetApiKeys": "<p>Gets information about the current ApiKeys resource.</p>",
"GetAuthorizer": "<p>Describe an existing Authorizer resource.</p>",
"GetAuthorizers": "<p>Describe an existing Authorizers resource.</p>",
"GetBasePathMapping": "<p>Describe a BasePathMapping resource.</p>",
"GetBasePathMappings": "<p>Represents a collection of BasePathMapping resources.</p>",
"GetClientCertificate": "<p>Gets information about the current ClientCertificate resource.</p>",
"GetClientCertificates": "<p>Gets a collection of ClientCertificate resources.</p>",
"GetDeployment": "<p>Gets information about a Deployment resource.</p>",
"GetDeployments": "<p>Gets information about a Deployments collection.</p>",
"GetDocumentationPart": "<p>Gets a documentation part.</p>",
"GetDocumentationParts": "<p>Gets documentation parts.</p>",
"GetDocumentationVersion": "<p>Gets a documentation version.</p>",
"GetDocumentationVersions": "<p>Gets documentation versions.</p>",
"GetDomainName": "<p>Represents a domain name that is contained in a simpler, more intuitive URL that can be called.</p>",
"GetDomainNames": "<p>Represents a collection of DomainName resources.</p>",
"GetExport": "<p>Exports a deployed version of a RestApi in a specified format.</p>",
"GetGatewayResponse": "<p>Gets a GatewayResponse of a specified response type on the given RestApi.</p>",
"GetGatewayResponses": "<p>Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.</p>",
"GetIntegration": "<p>Get the integration settings.</p>",
"GetIntegrationResponse": "<p>Represents a get integration response.</p>",
"GetMethod": "<p>Describe an existing Method resource.</p>",
"GetMethodResponse": "<p>Describes a MethodResponse resource.</p>",
"GetModel": "<p>Describes an existing model defined for a RestApi resource.</p>",
"GetModelTemplate": "<p>Generates a sample mapping template that can be used to transform a payload into the structure of a model.</p>",
"GetModels": "<p>Describes existing Models defined for a RestApi resource.</p>",
"GetRequestValidator": "<p>Gets a RequestValidator of a given RestApi.</p>",
"GetRequestValidators": "<p>Gets the RequestValidators collection of a given RestApi.</p>",
"GetResource": "<p>Lists information about a resource.</p>",
"GetResources": "<p>Lists information about a collection of Resource resources.</p>",
"GetRestApi": "<p>Lists the RestApi resource in the collection.</p>",
"GetRestApis": "<p>Lists the RestApis resources for your collection.</p>",
"GetSdk": "<p>Generates a client SDK for a RestApi and Stage.</p>",
"GetSdkType": "<p>Gets an SDK type.</p>",
"GetSdkTypes": "<p>Gets SDK types</p>",
"GetStage": "<p>Gets information about a Stage resource.</p>",
"GetStages": "<p>Gets information about one or more Stage resources.</p>",
"GetTags": "<p>Gets the Tags collection for a given resource.</p>",
"GetUsage": "<p>Gets the usage data of a usage plan in a specified time interval.</p>",
"GetUsagePlan": "<p>Gets a usage plan of a given plan identifier.</p>",
"GetUsagePlanKey": "<p>Gets a usage plan key of a given key identifier.</p>",
"GetUsagePlanKeys": "<p>Gets all the usage plan keys representing the API keys added to a specified usage plan.</p>",
"GetUsagePlans": "<p>Gets all the usage plans of the caller's account.</p>",
"GetVpcLink": "<p>Gets a specified VPC link under the caller's account in a region.</p>",
"GetVpcLinks": "<p>Gets the VpcLinks collection under the caller's account in a selected region.</p>",
"ImportApiKeys": "<p>Import API keys from an external source, such as a CSV-formatted file.</p>",
"ImportDocumentationParts": "<p>Imports documentation parts</p>",
"ImportRestApi": "<p>A feature of the API Gateway control service for creating a new API from an external API definition file.</p>",
"PutGatewayResponse": "<p>Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.</p>",
"PutIntegration": "<p>Sets up a method's integration.</p>",
"PutIntegrationResponse": "<p>Represents a put integration.</p>",
"PutMethod": "<p>Add a method to an existing Resource resource.</p>",
"PutMethodResponse": "<p>Adds a MethodResponse to an existing Method resource.</p>",
"PutRestApi": "<p>A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.</p>",
"TagResource": "<p>Adds or updates a tag on a given resource.</p>",
"TestInvokeAuthorizer": "<p>Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.</p>",
"TestInvokeMethod": "<p>Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.</p>",
"UntagResource": "<p>Removes a tag from a given resource.</p>",
"UpdateAccount": "<p>Changes information about the current Account resource.</p>",
"UpdateApiKey": "<p>Changes information about an ApiKey resource.</p>",
"UpdateAuthorizer": "<p>Updates an existing Authorizer resource.</p>",
"UpdateBasePathMapping": "<p>Changes information about the BasePathMapping resource.</p>",
"UpdateClientCertificate": "<p>Changes information about an ClientCertificate resource.</p>",
"UpdateDeployment": "<p>Changes information about a Deployment resource.</p>",
"UpdateDocumentationPart": "<p>Updates a documentation part.</p>",
"UpdateDocumentationVersion": "<p>Updates a documentation version.</p>",
"UpdateDomainName": "<p>Changes information about the DomainName resource.</p>",
"UpdateGatewayResponse": "<p>Updates a GatewayResponse of a specified response type on the given RestApi.</p>",
"UpdateIntegration": "<p>Represents an update integration.</p>",
"UpdateIntegrationResponse": "<p>Represents an update integration response.</p>",
"UpdateMethod": "<p>Updates an existing Method resource.</p>",
"UpdateMethodResponse": "<p>Updates an existing MethodResponse resource.</p>",
"UpdateModel": "<p>Changes information about a model.</p>",
"UpdateRequestValidator": "<p>Updates a RequestValidator of a given RestApi.</p>",
"UpdateResource": "<p>Changes information about a Resource resource.</p>",
"UpdateRestApi": "<p>Changes information about the specified API.</p>",
"UpdateStage": "<p>Changes information about a Stage resource.</p>",
"UpdateUsage": "<p>Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.</p>",
"UpdateUsagePlan": "<p>Updates a usage plan of a given plan Id.</p>",
"UpdateVpcLink": "<p>Updates an existing VpcLink of a specified identifier.</p>"
},
"shapes": {
"AccessLogSettings": {
"base": "<p>Access log settings, including the access log format and access log destination ARN.</p>",
"refs": {
"Stage$accessLogSettings": "<p>Settings for logging access in this stage.</p>"
}
},
"Account": {
"base": "<p>Represents an AWS account that is associated with API Gateway.</p>",
"refs": {
}
},
"ApiKey": {
"base": "<p>A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.</p>",
"refs": {
"ListOfApiKey$member": null
}
},
"ApiKeyIds": {
"base": "<p>The identifier of an ApiKey used in a UsagePlan.</p>",
"refs": {
}
},
"ApiKeySourceType": {
"base": null,
"refs": {
"CreateRestApiRequest$apiKeySource": "<p>The source of the API key for metering requests according to a usage plan. Valid values are: ><code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a request. <code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code> from a custom authorizer.</p>",
"RestApi$apiKeySource": "<p>The source of the API key for metering requests according to a usage plan. Valid values are: ><code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a request. <code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code> from a custom authorizer.</p>"
}
},
"ApiKeys": {
"base": "<p>Represents a collection of API keys as represented by an ApiKeys resource.</p>",
"refs": {
}
},
"ApiKeysFormat": {
"base": null,
"refs": {
"ImportApiKeysRequest$format": "<p>A query parameter to specify the input format to imported API keys. Currently, only the <code>csv</code> format is supported.</p>"
}
},
"ApiStage": {
"base": "<p>API stage name of the associated API stage in a usage plan.</p>",
"refs": {
"ListOfApiStage$member": null
}
},
"Authorizer": {
"base": "<p>Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.</p>",
"refs": {
"ListOfAuthorizer$member": null
}
},
"AuthorizerType": {
"base": "<p>The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</p>",
"refs": {
"Authorizer$type": "<p>The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</p>",
"CreateAuthorizerRequest$type": "<p>The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</p>"
}
},
"Authorizers": {
"base": "<p>Represents a collection of Authorizer resources.</p>",
"refs": {
}
},
"BadRequestException": {
"base": "<p>The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>",
"refs": {
}
},
"BasePathMapping": {
"base": "<p>Represents the base path that callers of the API must provide as part of the URL after the domain name.</p>",
"refs": {
"ListOfBasePathMapping$member": null
}
},
"BasePathMappings": {
"base": "<p>Represents a collection of BasePathMapping resources.</p>",
"refs": {
}
},
"Blob": {
"base": null,
"refs": {
"ExportResponse$body": "<p>The binary blob response to GetExport, which contains the export.</p>",
"ImportApiKeysRequest$body": "<p>The payload of the POST request to import API keys. For the payload format, see API Key File Format.</p>",
"ImportDocumentationPartsRequest$body": "<p>Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.</p>",
"ImportRestApiRequest$body": "<p>The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.</p>",
"PutRestApiRequest$body": "<p>The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.</p>",
"SdkResponse$body": "<p>The binary blob response to GetSdk, which contains the generated SDK.</p>"
}
},
"Boolean": {
"base": null,
"refs": {
"ApiKey$enabled": "<p>Specifies whether the API Key can be used by callers.</p>",
"CanarySettings$useStageCache": "<p>A Boolean flag to indicate whether the canary deployment uses the stage cache or not.</p>",
"CreateApiKeyRequest$enabled": "<p>Specifies whether the ApiKey can be used by callers.</p>",
"CreateApiKeyRequest$generateDistinctId": "<p>Specifies whether (<code>true</code>) or not (<code>false</code>) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.</p>",
"CreateRequestValidatorRequest$validateRequestBody": "<p>A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (<code>true</code>) or not (<code>false</code>).</p>",
"CreateRequestValidatorRequest$validateRequestParameters": "<p>A Boolean flag to indicate whether to validate request parameters, <code>true</code>, or not <code>false</code>.</p>",
"CreateRestApiRequest$disableExecuteApiEndpoint": "<p>Specifies whether clients can invoke your API by using the default <code>execute-api</code> endpoint. By default, clients can invoke your API with the default <code>https://{api_id}.execute-api.{region}.amazonaws.com</code> endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint</p>",
"CreateStageRequest$cacheClusterEnabled": "<p>Whether cache clustering is enabled for the stage.</p>",
"CreateStageRequest$tracingEnabled": "<p>Specifies whether active tracing with X-ray is enabled for the Stage.</p>",
"DeploymentCanarySettings$useStageCache": "<p>A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.</p>",
"GatewayResponse$defaultResponse": "<p>A Boolean flag to indicate whether this GatewayResponse is the default gateway response (<code>true</code>) or not (<code>false</code>). A default gateway response is one generated by API Gateway without any customization by an API developer. </p>",
"GetModelRequest$flatten": "<p>A query parameter of a Boolean value to resolve (<code>true</code>) all external model references and returns a flattened model schema or not (<code>false</code>) The default is <code>false</code>.</p>",
"ImportApiKeysRequest$failOnWarnings": "<p>A query parameter to indicate whether to rollback ApiKey importation (<code>true</code>) or not (<code>false</code>) when error is encountered.</p>",
"ImportDocumentationPartsRequest$failOnWarnings": "<p>A query parameter to specify whether to rollback the documentation importation (<code>true</code>) or not (<code>false</code>) when a warning is encountered. The default value is <code>false</code>.</p>",
"ImportRestApiRequest$failOnWarnings": "<p>A query parameter to indicate whether to rollback the API creation (<code>true</code>) or not (<code>false</code>) when a warning is encountered. The default value is <code>false</code>.</p>",
"MethodSetting$metricsEnabled": "<p>Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is <code>/{method_setting_key}/metrics/enabled</code>, and the value is a Boolean.</p>",
"MethodSetting$dataTraceEnabled": "<p>Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is <code>/{method_setting_key}/logging/dataTrace</code>, and the value is a Boolean.</p>",
"MethodSetting$cachingEnabled": "<p>Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is <code>/{method_setting_key}/caching/enabled</code>, and the value is a Boolean.</p>",
"MethodSetting$cacheDataEncrypted": "<p>Specifies whether the cached responses are encrypted. The PATCH path for this setting is <code>/{method_setting_key}/caching/dataEncrypted</code>, and the value is a Boolean.</p>",
"MethodSetting$requireAuthorizationForCacheControl": "<p>Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is <code>/{method_setting_key}/caching/requireAuthorizationForCacheControl</code>, and the value is a Boolean.</p>",
"MethodSnapshot$apiKeyRequired": "<p>Specifies whether the method requires a valid ApiKey.</p>",
"PutMethodRequest$apiKeyRequired": "<p>Specifies whether the method required a valid ApiKey.</p>",
"PutRestApiRequest$failOnWarnings": "<p>A query parameter to indicate whether to rollback the API update (<code>true</code>) or not (<code>false</code>) when a warning is encountered. The default value is <code>false</code>.</p>",
"RequestValidator$validateRequestBody": "<p>A Boolean flag to indicate whether to validate a request body according to the configured Model schema.</p>",
"RequestValidator$validateRequestParameters": "<p>A Boolean flag to indicate whether to validate request parameters (<code>true</code>) or not (<code>false</code>).</p>",
"RestApi$disableExecuteApiEndpoint": "<p>Specifies whether clients can invoke your API by using the default <code>execute-api</code> endpoint. By default, clients can invoke your API with the default <code>https://{api_id}.execute-api.{region}.amazonaws.com</code> endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>",
"SdkConfigurationProperty$required": "<p>A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (<code>true</code>) or not (<code>false</code>).</p>",
"Stage$cacheClusterEnabled": "<p>Specifies whether a cache cluster is enabled for the stage.</p>",
"Stage$tracingEnabled": "<p>Specifies whether active tracing with X-ray is enabled for the Stage.</p>",
"TlsConfig$insecureSkipVerification": "<p>Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a supported certificate authority. This isn’t recommended, but it enables you to use certificates that are signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway still performs basic certificate validation, which includes checking the certificate's expiration date, hostname, and presence of a root certificate authority. Supported only for <code>HTTP</code> and <code>HTTP_PROXY</code> integrations.</p> <important> <p>Enabling <code>insecureSkipVerification</code> isn't recommended, especially for integrations with public HTTPS endpoints. If you enable <code>insecureSkipVerification</code>, you increase the risk of man-in-the-middle attacks.</p> </important>"
}
},
"CacheClusterSize": {
"base": "<p>Returns the size of the CacheCluster.</p>",
"refs": {
"CreateDeploymentRequest$cacheClusterSize": "<p>Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.</p>",
"CreateStageRequest$cacheClusterSize": "<p>The stage's cache cluster size.</p>",
"Stage$cacheClusterSize": "<p>The size of the cache cluster for the stage, if enabled.</p>"
}
},
"CacheClusterStatus": {
"base": "<p>Returns the status of the CacheCluster.</p>",
"refs": {
"Stage$cacheClusterStatus": "<p>The status of the cache cluster for the stage, if enabled.</p>"
}
},
"CanarySettings": {
"base": "<p>Configuration settings of a canary deployment.</p>",
"refs": {
"CreateStageRequest$canarySettings": "<p>The canary deployment settings of this stage.</p>",
"Stage$canarySettings": "<p>Settings for the canary deployment in this stage.</p>"
}
},
"ClientCertificate": {
"base": "<p>Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.</p>",
"refs": {
"ListOfClientCertificate$member": null
}
},
"ClientCertificates": {
"base": "<p>Represents a collection of ClientCertificate resources.</p>",
"refs": {
}
},
"ConflictException": {
"base": "<p>The request configuration has conflicts. For details, see the accompanying error message.</p>",
"refs": {
}
},
"ConnectionType": {
"base": null,
"refs": {
"Integration$connectionType": "<p>The type of the network connection to the integration endpoint. The valid value is <code>INTERNET</code> for connections through the public routable internet or <code>VPC_LINK</code> for private connections between API Gateway and a network load balancer in a VPC. The default value is <code>INTERNET</code>.</p>",
"PutIntegrationRequest$connectionType": "<p>The type of the network connection to the integration endpoint. The valid value is <code>INTERNET</code> for connections through the public routable internet or <code>VPC_LINK</code> for private connections between API Gateway and a network load balancer in a VPC. The default value is <code>INTERNET</code>.</p>"
}
},
"ContentHandlingStrategy": {
"base": null,
"refs": {
"Integration$contentHandling": "<p>Specifies how to handle request payload content type conversions. Supported values are <code>CONVERT_TO_BINARY</code> and <code>CONVERT_TO_TEXT</code>, with the following behaviors:</p> <p>If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the <code>passthroughBehavior</code> is configured to support payload pass-through.</p>",
"IntegrationResponse$contentHandling": "<p>Specifies how to handle response payload content type conversions. Supported values are <code>CONVERT_TO_BINARY</code> and <code>CONVERT_TO_TEXT</code>, with the following behaviors:</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.</p>",
"PutIntegrationRequest$contentHandling": "<p>Specifies how to handle request payload content type conversions. Supported values are <code>CONVERT_TO_BINARY</code> and <code>CONVERT_TO_TEXT</code>, with the following behaviors:</p> <p>If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the <code>passthroughBehavior</code> is configured to support payload pass-through.</p>",
"PutIntegrationResponseRequest$contentHandling": "<p>Specifies how to handle response payload content type conversions. Supported values are <code>CONVERT_TO_BINARY</code> and <code>CONVERT_TO_TEXT</code>, with the following behaviors:</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.</p>"
}
},
"CreateApiKeyRequest": {
"base": "<p>Request to create an ApiKey resource.</p>",
"refs": {
}
},
"CreateAuthorizerRequest": {
"base": "<p>Request to add a new Authorizer to an existing RestApi resource.</p>",
"refs": {
}
},
"CreateBasePathMappingRequest": {
"base": "<p>Requests API Gateway to create a new BasePathMapping resource.</p>",
"refs": {
}
},
"CreateDeploymentRequest": {
"base": "<p>Requests API Gateway to create a Deployment resource.</p>",
"refs": {
}
},
"CreateDocumentationPartRequest": {
"base": "<p>Creates a new documentation part of a given API.</p>",
"refs": {
}
},
"CreateDocumentationVersionRequest": {
"base": "<p>Creates a new documentation version of a given API.</p>",
"refs": {
}
},
"CreateDomainNameRequest": {
"base": "<p>A request to create a new domain name.</p>",
"refs": {
}
},
"CreateModelRequest": {
"base": "<p>Request to add a new Model to an existing RestApi resource.</p>",
"refs": {
}
},
"CreateRequestValidatorRequest": {
"base": "<p>Creates a RequestValidator of a given RestApi.</p>",
"refs": {
}
},
"CreateResourceRequest": {
"base": "<p>Requests API Gateway to create a Resource resource.</p>",
"refs": {
}
},
"CreateRestApiRequest": {
"base": "<p>The POST Request to add a new RestApi resource to your collection.</p>",
"refs": {
}
},
"CreateStageRequest": {
"base": "<p>Requests API Gateway to create a Stage resource.</p>",
"refs": {
}
},
"CreateUsagePlanKeyRequest": {
"base": "<p>The POST request to create a usage plan key for adding an existing API key to a usage plan.</p>",
"refs": {
}
},
"CreateUsagePlanRequest": {
"base": "<p>The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.</p>",
"refs": {
}
},
"CreateVpcLinkRequest": {
"base": "<p>Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.</p>",
"refs": {
}
},
"DeleteApiKeyRequest": {
"base": "<p>A request to delete the ApiKey resource.</p>",
"refs": {
}
},
"DeleteAuthorizerRequest": {
"base": "<p>Request to delete an existing Authorizer resource.</p>",
"refs": {
}
},
"DeleteBasePathMappingRequest": {
"base": "<p>A request to delete the BasePathMapping resource.</p>",
"refs": {
}
},
"DeleteClientCertificateRequest": {
"base": "<p>A request to delete the ClientCertificate resource.</p>",
"refs": {
}
},
"DeleteDeploymentRequest": {
"base": "<p>Requests API Gateway to delete a Deployment resource.</p>",
"refs": {
}
},
"DeleteDocumentationPartRequest": {
"base": "<p>Deletes an existing documentation part of an API.</p>",
"refs": {
}
},
"DeleteDocumentationVersionRequest": {
"base": "<p>Deletes an existing documentation version of an API.</p>",
"refs": {
}
},
"DeleteDomainNameRequest": {
"base": "<p>A request to delete the DomainName resource.</p>",
"refs": {
}
},
"DeleteGatewayResponseRequest": {
"base": "<p>Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.</p>",
"refs": {
}
},
"DeleteIntegrationRequest": {
"base": "<p>Represents a delete integration request.</p>",
"refs": {
}
},
"DeleteIntegrationResponseRequest": {
"base": "<p>Represents a delete integration response request.</p>",
"refs": {
}
},
"DeleteMethodRequest": {
"base": "<p>Request to delete an existing Method resource.</p>",
"refs": {
}
},
"DeleteMethodResponseRequest": {
"base": "<p>A request to delete an existing MethodResponse resource.</p>",
"refs": {
}
},
"DeleteModelRequest": {
"base": "<p>Request to delete an existing model in an existing RestApi resource.</p>",
"refs": {
}
},
"DeleteRequestValidatorRequest": {
"base": "<p>Deletes a specified RequestValidator of a given RestApi.</p>",
"refs": {
}
},
"DeleteResourceRequest": {
"base": "<p>Request to delete a Resource.</p>",
"refs": {
}
},
"DeleteRestApiRequest": {
"base": "<p>Request to delete the specified API from your collection.</p>",
"refs": {
}
},
"DeleteStageRequest": {
"base": "<p>Requests API Gateway to delete a Stage resource.</p>",
"refs": {
}
},
"DeleteUsagePlanKeyRequest": {
"base": "<p>The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.</p>",
"refs": {
}
},
"DeleteUsagePlanRequest": {
"base": "<p>The DELETE request to delete a usage plan of a given plan Id.</p>",
"refs": {
}
},
"DeleteVpcLinkRequest": {
"base": "<p>Deletes an existing VpcLink of a specified identifier.</p>",
"refs": {
}
},
"Deployment": {
"base": "<p>An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.</p>",
"refs": {
"ListOfDeployment$member": null
}
},
"DeploymentCanarySettings": {
"base": "<p>The input configuration for a canary deployment.</p>",
"refs": {
"CreateDeploymentRequest$canarySettings": "<p>The input configuration for the canary deployment when the deployment is a canary release deployment. </p>"
}
},
"Deployments": {
"base": "<p>Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.</p>",
"refs": {
}
},
"DocumentationPart": {
"base": "<p>A documentation part for a targeted API entity.</p>",
"refs": {
"ListOfDocumentationPart$member": null
}
},
"DocumentationPartIds": {
"base": "<p>A collection of the imported DocumentationPart identifiers.</p>",
"refs": {
}
},
"DocumentationPartLocation": {
"base": "<p>Specifies the target API entity to which the documentation applies.</p>",
"refs": {
"CreateDocumentationPartRequest$location": "<p>The location of the targeted API entity of the to-be-created documentation part.</p>",
"DocumentationPart$location": "<p>The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.</p>"
}
},
"DocumentationPartLocationStatusCode": {
"base": null,
"refs": {
"DocumentationPartLocation$statusCode": "<p>The HTTP status code of a response. It is a valid field for the API entity types of <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. The default value is <code>*</code> for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other <code>location</code> attributes, the child entity's <code>statusCode</code> attribute must match that of the parent entity exactly.</p>"
}
},
"DocumentationPartType": {
"base": null,
"refs": {
"DocumentationPartLocation$type": "<p>The type of API entity to which the documentation content applies. Valid values are <code>API</code>, <code>AUTHORIZER</code>, <code>MODEL</code>, <code>RESOURCE</code>, <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. Content inheritance does not apply to any entity of the <code>API</code>, <code>AUTHORIZER</code>, <code>METHOD</code>, <code>MODEL</code>, <code>REQUEST_BODY</code>, or <code>RESOURCE</code> type.</p>",
"GetDocumentationPartsRequest$type": "<p>The type of API entities of the to-be-retrieved documentation parts. </p>"
}
},
"DocumentationParts": {
"base": "<p>The collection of documentation parts of an API.</p>",
"refs": {
}
},
"DocumentationVersion": {
"base": "<p>A snapshot of the documentation of an API.</p>",
"refs": {
"ListOfDocumentationVersion$member": null
}
},
"DocumentationVersions": {
"base": "<p>The collection of documentation snapshots of an API. </p>",
"refs": {
}
},
"DomainName": {
"base": "<p>Represents a custom domain name as a user-friendly host name of an API (RestApi).</p>",
"refs": {
"ListOfDomainName$member": null
}
},
"DomainNameStatus": {
"base": null,
"refs": {
"DomainName$domainNameStatus": "<p>The status of the DomainName migration. The valid values are <code>AVAILABLE</code> and <code>UPDATING</code>. If the status is <code>UPDATING</code>, the domain cannot be modified further until the existing operation is complete. If it is <code>AVAILABLE</code>, the domain can be updated.</p>"
}
},
"DomainNames": {
"base": "<p>Represents a collection of DomainName resources.</p>",
"refs": {
}
},
"Double": {
"base": null,
"refs": {
"CanarySettings$percentTraffic": "<p>The percent (0-100) of traffic diverted to a canary deployment.</p>",
"DeploymentCanarySettings$percentTraffic": "<p>The percentage (0.0-100.0) of traffic routed to the canary deployment.</p>",
"MethodSetting$throttlingRateLimit": "<p>Specifies the throttling rate limit. The PATCH path for this setting is <code>/{method_setting_key}/throttling/rateLimit</code>, and the value is a double.</p>",
"ThrottleSettings$rateLimit": "<p>The API target request rate limit.</p>"
}
},
"EndpointConfiguration": {
"base": "<p>The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. </p>",
"refs": {
"CreateDomainNameRequest$endpointConfiguration": "<p>The endpoint configuration of this DomainName showing the endpoint types of the domain name. </p>",
"CreateRestApiRequest$endpointConfiguration": "<p>The endpoint configuration of this RestApi showing the endpoint types of the API. </p>",
"DomainName$endpointConfiguration": "<p>The endpoint configuration of this DomainName showing the endpoint types of the domain name. </p>",
"RestApi$endpointConfiguration": "<p>The endpoint configuration of this RestApi showing the endpoint types of the API. </p>"
}
},
"EndpointType": {
"base": "<p>The endpoint type. The valid values are <code>EDGE</code> for edge-optimized API setup, most suitable for mobile applications; <code>REGIONAL</code> for regional API endpoint setup, most suitable for calling from AWS Region; and <code>PRIVATE</code> for private APIs.</p>",
"refs": {
"ListOfEndpointType$member": null
}
},
"ExportResponse": {
"base": "<p>The binary blob response to GetExport, which contains the generated SDK.</p>",
"refs": {
}
},
"FlushStageAuthorizersCacheRequest": {
"base": "<p>Request to flush authorizer cache entries on a specified stage.</p>",
"refs": {
}
},
"FlushStageCacheRequest": {
"base": "<p>Requests API Gateway to flush a stage's cache.</p>",
"refs": {
}
},
"GatewayResponse": {
"base": "<p>A gateway response of a given response type and status code, with optional response parameters and mapping templates.</p>",
"refs": {
"ListOfGatewayResponse$member": null
}
},
"GatewayResponseType": {
"base": null,
"refs": {
"DeleteGatewayResponseRequest$responseType": "<p>The response type of the associated GatewayResponse.</p>",
"GatewayResponse$responseType": "<p>The response type of the associated GatewayResponse.</p>",
"GetGatewayResponseRequest$responseType": "<p>The response type of the associated GatewayResponse.</p>",
"PutGatewayResponseRequest$responseType": "<p>The response type of the associated GatewayResponse</p>",
"UpdateGatewayResponseRequest$responseType": "<p>The response type of the associated GatewayResponse.</p>"
}
},
"GatewayResponses": {
"base": "<p>The collection of the GatewayResponse instances of a RestApi as a <code>responseType</code>-to-GatewayResponse object map of key-value pairs. As such, pagination is not supported for querying this collection.</p>",
"refs": {
}
},
"GenerateClientCertificateRequest": {
"base": "<p>A request to generate a ClientCertificate resource.</p>",
"refs": {
}
},
"GetAccountRequest": {
"base": "<p>Requests API Gateway to get information about the current Account resource.</p>",
"refs": {
}
},
"GetApiKeyRequest": {
"base": "<p>A request to get information about the current ApiKey resource.</p>",
"refs": {
}
},
"GetApiKeysRequest": {
"base": "<p>A request to get information about the current ApiKeys resource.</p>",
"refs": {
}
},
"GetAuthorizerRequest": {
"base": "<p>Request to describe an existing Authorizer resource.</p>",
"refs": {
}
},
"GetAuthorizersRequest": {
"base": "<p>Request to describe an existing Authorizers resource.</p>",
"refs": {
}
},
"GetBasePathMappingRequest": {
"base": "<p>Request to describe a BasePathMapping resource.</p>",
"refs": {
}
},
"GetBasePathMappingsRequest": {
"base": "<p>A request to get information about a collection of BasePathMapping resources.</p>",
"refs": {
}
},
"GetClientCertificateRequest": {
"base": "<p>A request to get information about the current ClientCertificate resource.</p>",
"refs": {
}
},
"GetClientCertificatesRequest": {
"base": "<p>A request to get information about a collection of ClientCertificate resources.</p>",
"refs": {
}
},
"GetDeploymentRequest": {
"base": "<p>Requests API Gateway to get information about a Deployment resource.</p>",
"refs": {
}
},
"GetDeploymentsRequest": {
"base": "<p>Requests API Gateway to get information about a Deployments collection.</p>",
"refs": {
}
},
"GetDocumentationPartRequest": {
"base": "<p>Gets a specified documentation part of a given API.</p>",
"refs": {
}
},
"GetDocumentationPartsRequest": {
"base": "<p>Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).</p>",
"refs": {
}
},
"GetDocumentationVersionRequest": {
"base": "<p>Gets a documentation snapshot of an API.</p>",
"refs": {
}
},
"GetDocumentationVersionsRequest": {
"base": "<p>Gets the documentation versions of an API.</p>",
"refs": {
}
},
"GetDomainNameRequest": {
"base": "<p>Request to get the name of a DomainName resource.</p>",
"refs": {
}
},
"GetDomainNamesRequest": {
"base": "<p>Request to describe a collection of DomainName resources.</p>",
"refs": {
}
},
"GetExportRequest": {
"base": "<p>Request a new export of a RestApi for a particular Stage.</p>",
"refs": {
}
},
"GetGatewayResponseRequest": {
"base": "<p>Gets a GatewayResponse of a specified response type on the given RestApi.</p>",
"refs": {
}
},
"GetGatewayResponsesRequest": {
"base": "<p>Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.</p>",
"refs": {
}
},
"GetIntegrationRequest": {
"base": "<p>Represents a request to get the integration configuration.</p>",
"refs": {
}
},
"GetIntegrationResponseRequest": {
"base": "<p>Represents a get integration response request.</p>",
"refs": {
}
},
"GetMethodRequest": {
"base": "<p>Request to describe an existing Method resource.</p>",
"refs": {
}
},
"GetMethodResponseRequest": {
"base": "<p>Request to describe a MethodResponse resource.</p>",
"refs": {
}
},
"GetModelRequest": {
"base": "<p>Request to list information about a model in an existing RestApi resource.</p>",
"refs": {
}
},
"GetModelTemplateRequest": {
"base": "<p>Request to generate a sample mapping template used to transform the payload.</p>",
"refs": {
}
},
"GetModelsRequest": {
"base": "<p>Request to list existing Models defined for a RestApi resource.</p>",
"refs": {
}
},
"GetRequestValidatorRequest": {
"base": "<p>Gets a RequestValidator of a given RestApi.</p>",
"refs": {
}
},
"GetRequestValidatorsRequest": {
"base": "<p>Gets the RequestValidators collection of a given RestApi.</p>",
"refs": {
}
},
"GetResourceRequest": {
"base": "<p>Request to list information about a resource.</p>",
"refs": {
}
},
"GetResourcesRequest": {
"base": "<p>Request to list information about a collection of resources.</p>",
"refs": {
}
},
"GetRestApiRequest": {
"base": "<p>The GET request to list an existing RestApi defined for your collection. </p>",
"refs": {
}
},
"GetRestApisRequest": {
"base": "<p>The GET request to list existing RestApis defined for your collection.</p>",
"refs": {
}
},
"GetSdkRequest": {
"base": "<p>Request a new generated client SDK for a RestApi and Stage.</p>",
"refs": {
}
},
"GetSdkTypeRequest": {
"base": "<p>Get an SdkType instance.</p>",
"refs": {
}
},
"GetSdkTypesRequest": {
"base": "<p>Get the SdkTypes collection.</p>",
"refs": {
}
},
"GetStageRequest": {
"base": "<p>Requests API Gateway to get information about a Stage resource.</p>",
"refs": {
}
},
"GetStagesRequest": {
"base": "<p>Requests API Gateway to get information about one or more Stage resources.</p>",
"refs": {
}
},
"GetTagsRequest": {
"base": "<p>Gets the Tags collection for a given resource.</p>",
"refs": {
}
},
"GetUsagePlanKeyRequest": {
"base": "<p>The GET request to get a usage plan key of a given key identifier.</p>",
"refs": {
}
},
"GetUsagePlanKeysRequest": {
"base": "<p>The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.</p>",
"refs": {
}
},
"GetUsagePlanRequest": {
"base": "<p>The GET request to get a usage plan of a given plan identifier.</p>",
"refs": {
}
},
"GetUsagePlansRequest": {
"base": "<p>The GET request to get all the usage plans of the caller's account.</p>",
"refs": {
}
},
"GetUsageRequest": {
"base": "<p>The GET request to get the usage data of a usage plan in a specified time interval.</p>",
"refs": {
}
},
"GetVpcLinkRequest": {
"base": "<p>Gets a specified VPC link under the caller's account in a region.</p>",
"refs": {
}
},
"GetVpcLinksRequest": {
"base": "<p>Gets the VpcLinks collection under the caller's account in a selected region.</p>",
"refs": {
}
},
"ImportApiKeysRequest": {
"base": "<p>The POST request to import API keys from an external source, such as a CSV-formatted file.</p>",
"refs": {
}
},
"ImportDocumentationPartsRequest": {
"base": "<p>Import documentation parts from an external (e.g., OpenAPI) definition file. </p>",
"refs": {
}
},
"ImportRestApiRequest": {
"base": "<p>A POST request to import an API to API Gateway using an input of an API definition file.</p>",
"refs": {
}
},
"Integer": {
"base": null,
"refs": {
"Integration$timeoutInMillis": "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.</p>",
"MethodSetting$throttlingBurstLimit": "<p>Specifies the throttling burst limit. The PATCH path for this setting is <code>/{method_setting_key}/throttling/burstLimit</code>, and the value is an integer.</p>",
"MethodSetting$cacheTtlInSeconds": "<p>Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is <code>/{method_setting_key}/caching/ttlInSeconds</code>, and the value is an integer.</p>",
"QuotaSettings$limit": "<p>The target maximum number of requests that can be made in a given time period.</p>",
"QuotaSettings$offset": "<p>The number of requests subtracted from the given limit in the initial time period.</p>",
"TestInvokeAuthorizerResponse$clientStatus": "<p>The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.</p>",
"TestInvokeMethodResponse$status": "<p>The HTTP status code.</p>",
"ThrottleSettings$burstLimit": "<p>The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.</p>"
}
},
"Integration": {
"base": "<p>Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.</p>",
"refs": {
"Method$methodIntegration": "<p>Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.</p>"
}
},
"IntegrationResponse": {
"base": "<p>Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.</p>",
"refs": {
"MapOfIntegrationResponse$value": null
}
},
"IntegrationType": {
"base": "<p>The integration type. The valid value is <code>HTTP</code> for integrating an API method with an HTTP backend; <code>AWS</code> with any AWS service endpoints; <code>MOCK</code> for testing without actually invoking the backend; <code>HTTP_PROXY</code> for integrating with the HTTP proxy integration; <code>AWS_PROXY</code> for integrating with the Lambda proxy integration. </p>",
"refs": {
"Integration$type": "<p>Specifies an API method integration type. The valid value is one of the following:</p> <p>For the HTTP and HTTP proxy integrations, each integration can specify a protocol (<code>http/https</code>), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a <code>connectionType</code> of <code>VPC_LINK</code> is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.</p>",
"PutIntegrationRequest$type": "<p>Specifies a put integration input's type.</p>"
}
},
"LimitExceededException": {
"base": "<p>The request exceeded the rate limit. Retry after the specified time period.</p>",
"refs": {
}
},
"ListOfARNs": {
"base": null,
"refs": {
"Authorizer$providerARNs": "<p>A list of the Amazon Cognito user pool ARNs for the <code>COGNITO_USER_POOLS</code> authorizer. Each element is of this format: <code>arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}</code>. For a <code>TOKEN</code> or <code>REQUEST</code> authorizer, this is not defined. </p>",
"CreateAuthorizerRequest$providerARNs": "<p>A list of the Amazon Cognito user pool ARNs for the <code>COGNITO_USER_POOLS</code> authorizer. Each element is of this format: <code>arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}</code>. For a <code>TOKEN</code> or <code>REQUEST</code> authorizer, this is not defined. </p>"
}
},
"ListOfApiKey": {
"base": null,
"refs": {
"ApiKeys$items": "<p>The current page of elements from this collection.</p>"
}
},
"ListOfApiStage": {
"base": null,
"refs": {
"CreateUsagePlanRequest$apiStages": "<p>The associated API stages of the usage plan.</p>",
"UsagePlan$apiStages": "<p>The associated API stages of a usage plan.</p>"
}
},
"ListOfAuthorizer": {
"base": null,
"refs": {
"Authorizers$items": "<p>The current page of elements from this collection.</p>"
}
},
"ListOfBasePathMapping": {
"base": null,
"refs": {
"BasePathMappings$items": "<p>The current page of elements from this collection.</p>"
}
},
"ListOfClientCertificate": {
"base": null,
"refs": {
"ClientCertificates$items": "<p>The current page of elements from this collection.</p>"
}
},
"ListOfDeployment": {
"base": null,
"refs": {
"Deployments$items": "<p>The current page of elements from this collection.</p>"
}
},
"ListOfDocumentationPart": {
"base": null,
"refs": {
"DocumentationParts$items": "<p>The current page of elements from this collection.</p>"
}
},
"ListOfDocumentationVersion": {
"base": null,
"refs": {
"DocumentationVersions$items": "<p>The current page of elements from this collection.</p>"
}
},
"ListOfDomainName": {
"base": null,
"refs": {
"DomainNames$items": "<p>The current page of elements from this collection.</p>"
}
},
"ListOfEndpointType": {
"base": null,
"refs": {
"EndpointConfiguration$types": "<p>A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is <code>\"EDGE\"</code>. For a regional API and its custom domain name, the endpoint type is <code>REGIONAL</code>. For a private API, the endpoint type is <code>PRIVATE</code>.</p>"
}
},
"ListOfGatewayResponse": {
"base": null,
"refs": {
"GatewayResponses$items": "<p>Returns the entire collection, because of no pagination support.</p>"
}
},
"ListOfLong": {
"base": null,
"refs": {
"ListOfUsage$member": null
}
},
"ListOfModel": {
"base": null,
"refs": {
"Models$items": "<p>The current page of elements from this collection.</p>"
}
},
"ListOfPatchOperation": {