-
Notifications
You must be signed in to change notification settings - Fork 2.8k
/
AmazonApiGateway.java
2912 lines (2782 loc) · 145 KB
/
AmazonApiGateway.java
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
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.apigateway;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.apigateway.model.*;
/**
* Interface for accessing Amazon API Gateway.
* <p>
* <b>Note:</b> Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.apigateway.AbstractAmazonApiGateway} instead.
* </p>
* <p>
* <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 Lambda, Amazon EC2, or
* other publicly addressable web services that are hosted outside of AWS.
* </p>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonApiGateway {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "apigateway";
/**
* Overrides the default endpoint for this client ("https://apigateway.us-east-1.amazonaws.com"). Callers can use
* this method to control which AWS region they want to work with.
* <p>
* Callers can pass in just the endpoint (ex: "apigateway.us-east-1.amazonaws.com") or a full URL, including the
* protocol (ex: "https://apigateway.us-east-1.amazonaws.com"). If the protocol is not specified here, the default
* protocol from this client's {@link ClientConfiguration} will be used, which by default is HTTPS.
* <p>
* For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available
* endpoints for all AWS services, see: <a href=
* "https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection-choose-endpoint"
* > https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection-
* choose-endpoint</a>
* <p>
* <b>This method is not threadsafe. An endpoint should be configured when the client is created and before any
* service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in
* transit or retrying.</b>
*
* @param endpoint
* The endpoint (ex: "apigateway.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
* "https://apigateway.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will
* communicate with.
* @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for
* example:
* {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));}
*/
@Deprecated
void setEndpoint(String endpoint);
/**
* An alternative to {@link AmazonApiGateway#setEndpoint(String)}, sets the regional endpoint for this client's
* service calls. Callers can use this method to control which AWS region they want to work with.
* <p>
* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
* {@link ClientConfiguration} supplied at construction.
* <p>
* <b>This method is not threadsafe. A region should be configured when the client is created and before any service
* requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit
* or retrying.</b>
*
* @param region
* The region this client will communicate with. See {@link Region#getRegion(com.amazonaws.regions.Regions)}
* for accessing a given region. Must not be null and must be a region where the service is available.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
* <p>
* Create an ApiKey resource.
* </p>
*
* @param createApiKeyRequest
* Request to create an ApiKey resource.
* @return Result of the CreateApiKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.CreateApiKey
*/
CreateApiKeyResult createApiKey(CreateApiKeyRequest createApiKeyRequest);
/**
* <p>
* Adds a new Authorizer resource to an existing RestApi resource.
* </p>
*
* @param createAuthorizerRequest
* Request to add a new Authorizer to an existing RestApi resource.
* @return Result of the CreateAuthorizer operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.CreateAuthorizer
*/
CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest);
/**
* <p>
* Creates a new BasePathMapping resource.
* </p>
*
* @param createBasePathMappingRequest
* Requests API Gateway to create a new BasePathMapping resource.
* @return Result of the CreateBasePathMapping operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.CreateBasePathMapping
*/
CreateBasePathMappingResult createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest);
/**
* <p>
* Creates a Deployment resource, which makes a specified RestApi callable over the internet.
* </p>
*
* @param createDeploymentRequest
* Requests API Gateway to create a Deployment resource.
* @return Result of the CreateDeployment operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws ServiceUnavailableException
* The requested service is not available. For details see the accompanying error message. Retry after the
* specified time period.
* @sample AmazonApiGateway.CreateDeployment
*/
CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest);
/**
* <p>
* Creates a documentation part.
* </p>
*
* @param createDocumentationPartRequest
* Creates a new documentation part of a given API.
* @return Result of the CreateDocumentationPart operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.CreateDocumentationPart
*/
CreateDocumentationPartResult createDocumentationPart(CreateDocumentationPartRequest createDocumentationPartRequest);
/**
* <p>
* Creates a documentation version
* </p>
*
* @param createDocumentationVersionRequest
* Creates a new documentation version of a given API.
* @return Result of the CreateDocumentationVersion operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.CreateDocumentationVersion
*/
CreateDocumentationVersionResult createDocumentationVersion(CreateDocumentationVersionRequest createDocumentationVersionRequest);
/**
* <p>
* Creates a new domain name.
* </p>
*
* @param createDomainNameRequest
* A request to create a new domain name.
* @return Result of the CreateDomainName operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.CreateDomainName
*/
CreateDomainNameResult createDomainName(CreateDomainNameRequest createDomainNameRequest);
/**
* <p>
* Adds a new Model resource to an existing RestApi resource.
* </p>
*
* @param createModelRequest
* Request to add a new Model to an existing RestApi resource.
* @return Result of the CreateModel operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.CreateModel
*/
CreateModelResult createModel(CreateModelRequest createModelRequest);
/**
* <p>
* Creates a RequestValidator of a given RestApi.
* </p>
*
* @param createRequestValidatorRequest
* Creates a RequestValidator of a given RestApi.
* @return Result of the CreateRequestValidator operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.CreateRequestValidator
*/
CreateRequestValidatorResult createRequestValidator(CreateRequestValidatorRequest createRequestValidatorRequest);
/**
* <p>
* Creates a Resource resource.
* </p>
*
* @param createResourceRequest
* Requests API Gateway to create a Resource resource.
* @return Result of the CreateResource operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.CreateResource
*/
CreateResourceResult createResource(CreateResourceRequest createResourceRequest);
/**
* <p>
* Creates a new RestApi resource.
* </p>
*
* @param createRestApiRequest
* The POST Request to add a new RestApi resource to your collection.
* @return Result of the CreateRestApi operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.CreateRestApi
*/
CreateRestApiResult createRestApi(CreateRestApiRequest createRestApiRequest);
/**
* <p>
* Creates a new Stage resource that references a pre-existing Deployment for the API.
* </p>
*
* @param createStageRequest
* Requests API Gateway to create a Stage resource.
* @return Result of the CreateStage operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.CreateStage
*/
CreateStageResult createStage(CreateStageRequest createStageRequest);
/**
* <p>
* Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the
* payload.
* </p>
*
* @param createUsagePlanRequest
* 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.
* @return Result of the CreateUsagePlan operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.CreateUsagePlan
*/
CreateUsagePlanResult createUsagePlan(CreateUsagePlanRequest createUsagePlanRequest);
/**
* <p>
* Creates a usage plan key for adding an existing API key to a usage plan.
* </p>
*
* @param createUsagePlanKeyRequest
* The POST request to create a usage plan key for adding an existing API key to a usage plan.
* @return Result of the CreateUsagePlanKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.CreateUsagePlanKey
*/
CreateUsagePlanKeyResult createUsagePlanKey(CreateUsagePlanKeyRequest createUsagePlanKeyRequest);
/**
* <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>
*
* @param createVpcLinkRequest
* 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.
* @return Result of the CreateVpcLink operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.CreateVpcLink
*/
CreateVpcLinkResult createVpcLink(CreateVpcLinkRequest createVpcLinkRequest);
/**
* <p>
* Deletes the ApiKey resource.
* </p>
*
* @param deleteApiKeyRequest
* A request to delete the ApiKey resource.
* @return Result of the DeleteApiKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteApiKey
*/
DeleteApiKeyResult deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest);
/**
* <p>
* Deletes an existing Authorizer resource.
* </p>
*
* @param deleteAuthorizerRequest
* Request to delete an existing Authorizer resource.
* @return Result of the DeleteAuthorizer operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteAuthorizer
*/
DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest);
/**
* <p>
* Deletes the BasePathMapping resource.
* </p>
*
* @param deleteBasePathMappingRequest
* A request to delete the BasePathMapping resource.
* @return Result of the DeleteBasePathMapping operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteBasePathMapping
*/
DeleteBasePathMappingResult deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest);
/**
* <p>
* Deletes the ClientCertificate resource.
* </p>
*
* @param deleteClientCertificateRequest
* A request to delete the ClientCertificate resource.
* @return Result of the DeleteClientCertificate operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteClientCertificate
*/
DeleteClientCertificateResult deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest);
/**
* <p>
* Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated
* with it.
* </p>
*
* @param deleteDeploymentRequest
* Requests API Gateway to delete a Deployment resource.
* @return Result of the DeleteDeployment operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteDeployment
*/
DeleteDeploymentResult deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest);
/**
* <p>
* Deletes a documentation part
* </p>
*
* @param deleteDocumentationPartRequest
* Deletes an existing documentation part of an API.
* @return Result of the DeleteDocumentationPart operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteDocumentationPart
*/
DeleteDocumentationPartResult deleteDocumentationPart(DeleteDocumentationPartRequest deleteDocumentationPartRequest);
/**
* <p>
* Deletes a documentation version.
* </p>
*
* @param deleteDocumentationVersionRequest
* Deletes an existing documentation version of an API.
* @return Result of the DeleteDocumentationVersion operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteDocumentationVersion
*/
DeleteDocumentationVersionResult deleteDocumentationVersion(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest);
/**
* <p>
* Deletes the DomainName resource.
* </p>
*
* @param deleteDomainNameRequest
* A request to delete the DomainName resource.
* @return Result of the DeleteDomainName operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteDomainName
*/
DeleteDomainNameResult deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest);
/**
* <p>
* Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it
* with the default settings.
* </p>
*
* @param deleteGatewayResponseRequest
* Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets
* it with the default settings.
* @return Result of the DeleteGatewayResponse operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteGatewayResponse
*/
DeleteGatewayResponseResult deleteGatewayResponse(DeleteGatewayResponseRequest deleteGatewayResponseRequest);
/**
* <p>
* Represents a delete integration.
* </p>
*
* @param deleteIntegrationRequest
* Represents a delete integration request.
* @return Result of the DeleteIntegration operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteIntegration
*/
DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest);
/**
* <p>
* Represents a delete integration response.
* </p>
*
* @param deleteIntegrationResponseRequest
* Represents a delete integration response request.
* @return Result of the DeleteIntegrationResponse operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteIntegrationResponse
*/
DeleteIntegrationResponseResult deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest);
/**
* <p>
* Deletes an existing Method resource.
* </p>
*
* @param deleteMethodRequest
* Request to delete an existing Method resource.
* @return Result of the DeleteMethod operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @sample AmazonApiGateway.DeleteMethod
*/
DeleteMethodResult deleteMethod(DeleteMethodRequest deleteMethodRequest);
/**
* <p>
* Deletes an existing MethodResponse resource.
* </p>
*
* @param deleteMethodResponseRequest
* A request to delete an existing MethodResponse resource.
* @return Result of the DeleteMethodResponse operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @sample AmazonApiGateway.DeleteMethodResponse
*/
DeleteMethodResponseResult deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest);
/**
* <p>
* Deletes a model.
* </p>
*
* @param deleteModelRequest
* Request to delete an existing model in an existing RestApi resource.
* @return Result of the DeleteModel operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteModel
*/
DeleteModelResult deleteModel(DeleteModelRequest deleteModelRequest);
/**
* <p>
* Deletes a RequestValidator of a given RestApi.
* </p>
*
* @param deleteRequestValidatorRequest
* Deletes a specified RequestValidator of a given RestApi.
* @return Result of the DeleteRequestValidator operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteRequestValidator
*/
DeleteRequestValidatorResult deleteRequestValidator(DeleteRequestValidatorRequest deleteRequestValidatorRequest);
/**
* <p>
* Deletes a Resource resource.
* </p>
*
* @param deleteResourceRequest
* Request to delete a Resource.
* @return Result of the DeleteResource operation returned by the service.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteResource
*/
DeleteResourceResult deleteResource(DeleteResourceRequest deleteResourceRequest);
/**
* <p>
* Deletes the specified API.
* </p>
*
* @param deleteRestApiRequest
* Request to delete the specified API from your collection.
* @return Result of the DeleteRestApi operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteRestApi
*/
DeleteRestApiResult deleteRestApi(DeleteRestApiRequest deleteRestApiRequest);
/**
* <p>
* Deletes a Stage resource.
* </p>
*
* @param deleteStageRequest
* Requests API Gateway to delete a Stage resource.
* @return Result of the DeleteStage operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteStage
*/
DeleteStageResult deleteStage(DeleteStageRequest deleteStageRequest);
/**
* <p>
* Deletes a usage plan of a given plan Id.
* </p>
*
* @param deleteUsagePlanRequest
* The DELETE request to delete a usage plan of a given plan Id.
* @return Result of the DeleteUsagePlan operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteUsagePlan
*/
DeleteUsagePlanResult deleteUsagePlan(DeleteUsagePlanRequest deleteUsagePlanRequest);
/**
* <p>
* Deletes a usage plan key and remove the underlying API key from the associated usage plan.
* </p>
*
* @param deleteUsagePlanKeyRequest
* The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage
* plan.
* @return Result of the DeleteUsagePlanKey operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteUsagePlanKey
*/
DeleteUsagePlanKeyResult deleteUsagePlanKey(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest);
/**
* <p>
* Deletes an existing VpcLink of a specified identifier.
* </p>
*
* @param deleteVpcLinkRequest
* Deletes an existing VpcLink of a specified identifier.
* @return Result of the DeleteVpcLink operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.DeleteVpcLink
*/
DeleteVpcLinkResult deleteVpcLink(DeleteVpcLinkRequest deleteVpcLinkRequest);
/**
* <p>
* Flushes all authorizer cache entries on a stage.
* </p>
*
* @param flushStageAuthorizersCacheRequest
* Request to flush authorizer cache entries on a specified stage.
* @return Result of the FlushStageAuthorizersCache operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.
* @throws ConflictException
* The request configuration has conflicts. For details, see the accompanying error message.
* @throws LimitExceededException
* The request exceeded the rate limit. Retry after the specified time period.
* @throws NotFoundException
* The requested resource is not found. Make sure that the request URI is correct.
* @throws UnauthorizedException
* The request is denied because the caller has insufficient permissions.
* @throws TooManyRequestsException
* The request has reached its throttling limit. Retry after the specified time period.
* @sample AmazonApiGateway.FlushStageAuthorizersCache
*/
FlushStageAuthorizersCacheResult flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest);
/**
* <p>
* Flushes a stage's cache.
* </p>
*
* @param flushStageCacheRequest
* Requests API Gateway to flush a stage's cache.
* @return Result of the FlushStageCache operation returned by the service.
* @throws BadRequestException
* The submitted request is not valid, for example, the input is incomplete or incorrect. See the
* accompanying error message for details.