@aws-sdk/client-api-gateway 3.321.1 → 3.326.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/dist-types/commands/CreateApiKeyCommand.d.ts +19 -0
  2. package/dist-types/commands/CreateAuthorizerCommand.d.ts +17 -0
  3. package/dist-types/commands/CreateBasePathMappingCommand.d.ts +8 -0
  4. package/dist-types/commands/CreateDeploymentCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateDocumentationPartCommand.d.ts +14 -0
  6. package/dist-types/commands/CreateDocumentationVersionCommand.d.ts +8 -0
  7. package/dist-types/commands/CreateDomainNameCommand.d.ts +37 -0
  8. package/dist-types/commands/CreateModelCommand.d.ts +10 -0
  9. package/dist-types/commands/CreateRequestValidatorCommand.d.ts +9 -0
  10. package/dist-types/commands/CreateResourceCommand.d.ts +68 -0
  11. package/dist-types/commands/CreateRestApiCommand.d.ts +31 -0
  12. package/dist-types/commands/CreateStageCommand.d.ts +49 -0
  13. package/dist-types/commands/CreateUsagePlanCommand.d.ts +33 -0
  14. package/dist-types/commands/CreateUsagePlanKeyCommand.d.ts +9 -0
  15. package/dist-types/commands/CreateVpcLinkCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteApiKeyCommand.d.ts +4 -0
  17. package/dist-types/commands/DeleteAuthorizerCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteBasePathMappingCommand.d.ts +4 -0
  19. package/dist-types/commands/DeleteClientCertificateCommand.d.ts +4 -0
  20. package/dist-types/commands/DeleteDeploymentCommand.d.ts +4 -0
  21. package/dist-types/commands/DeleteDocumentationPartCommand.d.ts +4 -0
  22. package/dist-types/commands/DeleteDocumentationVersionCommand.d.ts +4 -0
  23. package/dist-types/commands/DeleteDomainNameCommand.d.ts +4 -0
  24. package/dist-types/commands/DeleteGatewayResponseCommand.d.ts +4 -0
  25. package/dist-types/commands/DeleteIntegrationCommand.d.ts +4 -0
  26. package/dist-types/commands/DeleteIntegrationResponseCommand.d.ts +4 -0
  27. package/dist-types/commands/DeleteMethodCommand.d.ts +4 -0
  28. package/dist-types/commands/DeleteMethodResponseCommand.d.ts +4 -0
  29. package/dist-types/commands/DeleteModelCommand.d.ts +4 -0
  30. package/dist-types/commands/DeleteRequestValidatorCommand.d.ts +4 -0
  31. package/dist-types/commands/DeleteResourceCommand.d.ts +4 -0
  32. package/dist-types/commands/DeleteRestApiCommand.d.ts +4 -0
  33. package/dist-types/commands/DeleteStageCommand.d.ts +4 -0
  34. package/dist-types/commands/DeleteUsagePlanCommand.d.ts +4 -0
  35. package/dist-types/commands/DeleteUsagePlanKeyCommand.d.ts +4 -0
  36. package/dist-types/commands/DeleteVpcLinkCommand.d.ts +4 -0
  37. package/dist-types/commands/FlushStageAuthorizersCacheCommand.d.ts +4 -0
  38. package/dist-types/commands/FlushStageCacheCommand.d.ts +4 -0
  39. package/dist-types/commands/GenerateClientCertificateCommand.d.ts +13 -0
  40. package/dist-types/commands/GetAccountCommand.d.ts +14 -0
  41. package/dist-types/commands/GetApiKeyCommand.d.ts +19 -0
  42. package/dist-types/commands/GetApiKeysCommand.d.ts +27 -0
  43. package/dist-types/commands/GetAuthorizerCommand.d.ts +17 -0
  44. package/dist-types/commands/GetAuthorizersCommand.d.ts +22 -0
  45. package/dist-types/commands/GetBasePathMappingCommand.d.ts +8 -0
  46. package/dist-types/commands/GetBasePathMappingsCommand.d.ts +13 -0
  47. package/dist-types/commands/GetClientCertificateCommand.d.ts +13 -0
  48. package/dist-types/commands/GetClientCertificatesCommand.d.ts +18 -0
  49. package/dist-types/commands/GetDeploymentCommand.d.ts +16 -0
  50. package/dist-types/commands/GetDeploymentsCommand.d.ts +21 -0
  51. package/dist-types/commands/GetDocumentationPartCommand.d.ts +14 -0
  52. package/dist-types/commands/GetDocumentationPartsCommand.d.ts +19 -0
  53. package/dist-types/commands/GetDocumentationVersionCommand.d.ts +8 -0
  54. package/dist-types/commands/GetDocumentationVersionsCommand.d.ts +13 -0
  55. package/dist-types/commands/GetDomainNameCommand.d.ts +37 -0
  56. package/dist-types/commands/GetDomainNamesCommand.d.ts +42 -0
  57. package/dist-types/commands/GetExportCommand.d.ts +8 -0
  58. package/dist-types/commands/GetGatewayResponseCommand.d.ts +14 -0
  59. package/dist-types/commands/GetGatewayResponsesCommand.d.ts +19 -0
  60. package/dist-types/commands/GetIntegrationCommand.d.ts +40 -0
  61. package/dist-types/commands/GetIntegrationResponseCommand.d.ts +14 -0
  62. package/dist-types/commands/GetMethodCommand.d.ts +60 -0
  63. package/dist-types/commands/GetMethodResponseCommand.d.ts +12 -0
  64. package/dist-types/commands/GetModelCommand.d.ts +10 -0
  65. package/dist-types/commands/GetModelTemplateCommand.d.ts +6 -0
  66. package/dist-types/commands/GetModelsCommand.d.ts +15 -0
  67. package/dist-types/commands/GetRequestValidatorCommand.d.ts +9 -0
  68. package/dist-types/commands/GetRequestValidatorsCommand.d.ts +14 -0
  69. package/dist-types/commands/GetResourceCommand.d.ts +68 -0
  70. package/dist-types/commands/GetResourcesCommand.d.ts +73 -0
  71. package/dist-types/commands/GetRestApiCommand.d.ts +31 -0
  72. package/dist-types/commands/GetRestApisCommand.d.ts +36 -0
  73. package/dist-types/commands/GetSdkCommand.d.ts +8 -0
  74. package/dist-types/commands/GetSdkTypeCommand.d.ts +17 -0
  75. package/dist-types/commands/GetSdkTypesCommand.d.ts +21 -0
  76. package/dist-types/commands/GetStageCommand.d.ts +49 -0
  77. package/dist-types/commands/GetStagesCommand.d.ts +53 -0
  78. package/dist-types/commands/GetTagsCommand.d.ts +8 -0
  79. package/dist-types/commands/GetUsageCommand.d.ts +16 -0
  80. package/dist-types/commands/GetUsagePlanCommand.d.ts +33 -0
  81. package/dist-types/commands/GetUsagePlanKeyCommand.d.ts +9 -0
  82. package/dist-types/commands/GetUsagePlanKeysCommand.d.ts +14 -0
  83. package/dist-types/commands/GetUsagePlansCommand.d.ts +38 -0
  84. package/dist-types/commands/GetVpcLinkCommand.d.ts +16 -0
  85. package/dist-types/commands/GetVpcLinksCommand.d.ts +21 -0
  86. package/dist-types/commands/ImportApiKeysCommand.d.ts +11 -0
  87. package/dist-types/commands/ImportDocumentationPartsCommand.d.ts +11 -0
  88. package/dist-types/commands/ImportRestApiCommand.d.ts +31 -0
  89. package/dist-types/commands/PutGatewayResponseCommand.d.ts +14 -0
  90. package/dist-types/commands/PutIntegrationCommand.d.ts +40 -0
  91. package/dist-types/commands/PutIntegrationResponseCommand.d.ts +14 -0
  92. package/dist-types/commands/PutMethodCommand.d.ts +60 -0
  93. package/dist-types/commands/PutMethodResponseCommand.d.ts +12 -0
  94. package/dist-types/commands/PutRestApiCommand.d.ts +31 -0
  95. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  96. package/dist-types/commands/TestInvokeAuthorizerCommand.d.ts +18 -0
  97. package/dist-types/commands/TestInvokeMethodCommand.d.ts +17 -0
  98. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  99. package/dist-types/commands/UpdateAccountCommand.d.ts +14 -0
  100. package/dist-types/commands/UpdateApiKeyCommand.d.ts +19 -0
  101. package/dist-types/commands/UpdateAuthorizerCommand.d.ts +17 -0
  102. package/dist-types/commands/UpdateBasePathMappingCommand.d.ts +8 -0
  103. package/dist-types/commands/UpdateClientCertificateCommand.d.ts +13 -0
  104. package/dist-types/commands/UpdateDeploymentCommand.d.ts +16 -0
  105. package/dist-types/commands/UpdateDocumentationPartCommand.d.ts +14 -0
  106. package/dist-types/commands/UpdateDocumentationVersionCommand.d.ts +8 -0
  107. package/dist-types/commands/UpdateDomainNameCommand.d.ts +37 -0
  108. package/dist-types/commands/UpdateGatewayResponseCommand.d.ts +14 -0
  109. package/dist-types/commands/UpdateIntegrationCommand.d.ts +40 -0
  110. package/dist-types/commands/UpdateIntegrationResponseCommand.d.ts +14 -0
  111. package/dist-types/commands/UpdateMethodCommand.d.ts +60 -0
  112. package/dist-types/commands/UpdateMethodResponseCommand.d.ts +12 -0
  113. package/dist-types/commands/UpdateModelCommand.d.ts +10 -0
  114. package/dist-types/commands/UpdateRequestValidatorCommand.d.ts +9 -0
  115. package/dist-types/commands/UpdateResourceCommand.d.ts +68 -0
  116. package/dist-types/commands/UpdateRestApiCommand.d.ts +31 -0
  117. package/dist-types/commands/UpdateStageCommand.d.ts +49 -0
  118. package/dist-types/commands/UpdateUsageCommand.d.ts +16 -0
  119. package/dist-types/commands/UpdateUsagePlanCommand.d.ts +33 -0
  120. package/dist-types/commands/UpdateVpcLinkCommand.d.ts +16 -0
  121. package/package.json +17 -17
@@ -32,6 +32,8 @@ export interface DeleteDocumentationPartCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteDocumentationPartCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteDocumentationPartCommandInput - {@link DeleteDocumentationPartCommandInput}
@@ -55,6 +57,8 @@ export interface DeleteDocumentationPartCommandOutput extends __MetadataBearer {
55
57
  * @throws {@link UnauthorizedException} (client fault)
56
58
  * <p>The request is denied because the caller has insufficient permissions.</p>
57
59
  *
60
+ * @throws {@link APIGatewayServiceException}
61
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
58
62
  *
59
63
  */
60
64
  export declare class DeleteDocumentationPartCommand extends $Command<DeleteDocumentationPartCommandInput, DeleteDocumentationPartCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteDocumentationVersionCommandOutput extends __MetadataBeare
32
32
  * };
33
33
  * const command = new DeleteDocumentationVersionCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteDocumentationVersionCommandInput - {@link DeleteDocumentationVersionCommandInput}
@@ -55,6 +57,8 @@ export interface DeleteDocumentationVersionCommandOutput extends __MetadataBeare
55
57
  * @throws {@link UnauthorizedException} (client fault)
56
58
  * <p>The request is denied because the caller has insufficient permissions.</p>
57
59
  *
60
+ * @throws {@link APIGatewayServiceException}
61
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
58
62
  *
59
63
  */
60
64
  export declare class DeleteDocumentationVersionCommand extends $Command<DeleteDocumentationVersionCommandInput, DeleteDocumentationVersionCommandOutput, APIGatewayClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteDomainNameCommandOutput extends __MetadataBearer {
31
31
  * };
32
32
  * const command = new DeleteDomainNameCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteDomainNameCommandInput - {@link DeleteDomainNameCommandInput}
@@ -54,6 +56,8 @@ export interface DeleteDomainNameCommandOutput extends __MetadataBearer {
54
56
  * @throws {@link UnauthorizedException} (client fault)
55
57
  * <p>The request is denied because the caller has insufficient permissions.</p>
56
58
  *
59
+ * @throws {@link APIGatewayServiceException}
60
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
57
61
  *
58
62
  */
59
63
  export declare class DeleteDomainNameCommand extends $Command<DeleteDomainNameCommandInput, DeleteDomainNameCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteGatewayResponseCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteGatewayResponseCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteGatewayResponseCommandInput - {@link DeleteGatewayResponseCommandInput}
@@ -55,6 +57,8 @@ export interface DeleteGatewayResponseCommandOutput extends __MetadataBearer {
55
57
  * @throws {@link UnauthorizedException} (client fault)
56
58
  * <p>The request is denied because the caller has insufficient permissions.</p>
57
59
  *
60
+ * @throws {@link APIGatewayServiceException}
61
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
58
62
  *
59
63
  */
60
64
  export declare class DeleteGatewayResponseCommand extends $Command<DeleteGatewayResponseCommandInput, DeleteGatewayResponseCommandOutput, APIGatewayClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeleteIntegrationCommandOutput extends __MetadataBearer {
33
33
  * };
34
34
  * const command = new DeleteIntegrationCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteIntegrationCommandInput - {@link DeleteIntegrationCommandInput}
@@ -56,6 +58,8 @@ export interface DeleteIntegrationCommandOutput extends __MetadataBearer {
56
58
  * @throws {@link UnauthorizedException} (client fault)
57
59
  * <p>The request is denied because the caller has insufficient permissions.</p>
58
60
  *
61
+ * @throws {@link APIGatewayServiceException}
62
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
59
63
  *
60
64
  */
61
65
  export declare class DeleteIntegrationCommand extends $Command<DeleteIntegrationCommandInput, DeleteIntegrationCommandOutput, APIGatewayClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface DeleteIntegrationResponseCommandOutput extends __MetadataBearer
34
34
  * };
35
35
  * const command = new DeleteIntegrationResponseCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param DeleteIntegrationResponseCommandInput - {@link DeleteIntegrationResponseCommandInput}
@@ -57,6 +59,8 @@ export interface DeleteIntegrationResponseCommandOutput extends __MetadataBearer
57
59
  * @throws {@link UnauthorizedException} (client fault)
58
60
  * <p>The request is denied because the caller has insufficient permissions.</p>
59
61
  *
62
+ * @throws {@link APIGatewayServiceException}
63
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
60
64
  *
61
65
  */
62
66
  export declare class DeleteIntegrationResponseCommand extends $Command<DeleteIntegrationResponseCommandInput, DeleteIntegrationResponseCommandOutput, APIGatewayClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeleteMethodCommandOutput extends __MetadataBearer {
33
33
  * };
34
34
  * const command = new DeleteMethodCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteMethodCommandInput - {@link DeleteMethodCommandInput}
@@ -53,6 +55,8 @@ export interface DeleteMethodCommandOutput extends __MetadataBearer {
53
55
  * @throws {@link UnauthorizedException} (client fault)
54
56
  * <p>The request is denied because the caller has insufficient permissions.</p>
55
57
  *
58
+ * @throws {@link APIGatewayServiceException}
59
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
56
60
  *
57
61
  */
58
62
  export declare class DeleteMethodCommand extends $Command<DeleteMethodCommandInput, DeleteMethodCommandOutput, APIGatewayClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface DeleteMethodResponseCommandOutput extends __MetadataBearer {
34
34
  * };
35
35
  * const command = new DeleteMethodResponseCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param DeleteMethodResponseCommandInput - {@link DeleteMethodResponseCommandInput}
@@ -57,6 +59,8 @@ export interface DeleteMethodResponseCommandOutput extends __MetadataBearer {
57
59
  * @throws {@link UnauthorizedException} (client fault)
58
60
  * <p>The request is denied because the caller has insufficient permissions.</p>
59
61
  *
62
+ * @throws {@link APIGatewayServiceException}
63
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
60
64
  *
61
65
  */
62
66
  export declare class DeleteMethodResponseCommand extends $Command<DeleteMethodResponseCommandInput, DeleteMethodResponseCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteModelCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteModelCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteModelCommandInput - {@link DeleteModelCommandInput}
@@ -55,6 +57,8 @@ export interface DeleteModelCommandOutput extends __MetadataBearer {
55
57
  * @throws {@link UnauthorizedException} (client fault)
56
58
  * <p>The request is denied because the caller has insufficient permissions.</p>
57
59
  *
60
+ * @throws {@link APIGatewayServiceException}
61
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
58
62
  *
59
63
  */
60
64
  export declare class DeleteModelCommand extends $Command<DeleteModelCommandInput, DeleteModelCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteRequestValidatorCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteRequestValidatorCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteRequestValidatorCommandInput - {@link DeleteRequestValidatorCommandInput}
@@ -55,6 +57,8 @@ export interface DeleteRequestValidatorCommandOutput extends __MetadataBearer {
55
57
  * @throws {@link UnauthorizedException} (client fault)
56
58
  * <p>The request is denied because the caller has insufficient permissions.</p>
57
59
  *
60
+ * @throws {@link APIGatewayServiceException}
61
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
58
62
  *
59
63
  */
60
64
  export declare class DeleteRequestValidatorCommand extends $Command<DeleteRequestValidatorCommandInput, DeleteRequestValidatorCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteResourceCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteResourceCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteResourceCommandInput - {@link DeleteResourceCommandInput}
@@ -55,6 +57,8 @@ export interface DeleteResourceCommandOutput extends __MetadataBearer {
55
57
  * @throws {@link UnauthorizedException} (client fault)
56
58
  * <p>The request is denied because the caller has insufficient permissions.</p>
57
59
  *
60
+ * @throws {@link APIGatewayServiceException}
61
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
58
62
  *
59
63
  */
60
64
  export declare class DeleteResourceCommand extends $Command<DeleteResourceCommandInput, DeleteResourceCommandOutput, APIGatewayClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteRestApiCommandOutput extends __MetadataBearer {
31
31
  * };
32
32
  * const command = new DeleteRestApiCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteRestApiCommandInput - {@link DeleteRestApiCommandInput}
@@ -54,6 +56,8 @@ export interface DeleteRestApiCommandOutput extends __MetadataBearer {
54
56
  * @throws {@link UnauthorizedException} (client fault)
55
57
  * <p>The request is denied because the caller has insufficient permissions.</p>
56
58
  *
59
+ * @throws {@link APIGatewayServiceException}
60
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
57
61
  *
58
62
  */
59
63
  export declare class DeleteRestApiCommand extends $Command<DeleteRestApiCommandInput, DeleteRestApiCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteStageCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteStageCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteStageCommandInput - {@link DeleteStageCommandInput}
@@ -58,6 +60,8 @@ export interface DeleteStageCommandOutput extends __MetadataBearer {
58
60
  * @throws {@link UnauthorizedException} (client fault)
59
61
  * <p>The request is denied because the caller has insufficient permissions.</p>
60
62
  *
63
+ * @throws {@link APIGatewayServiceException}
64
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
61
65
  *
62
66
  */
63
67
  export declare class DeleteStageCommand extends $Command<DeleteStageCommandInput, DeleteStageCommandOutput, APIGatewayClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteUsagePlanCommandOutput extends __MetadataBearer {
31
31
  * };
32
32
  * const command = new DeleteUsagePlanCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteUsagePlanCommandInput - {@link DeleteUsagePlanCommandInput}
@@ -54,6 +56,8 @@ export interface DeleteUsagePlanCommandOutput extends __MetadataBearer {
54
56
  * @throws {@link UnauthorizedException} (client fault)
55
57
  * <p>The request is denied because the caller has insufficient permissions.</p>
56
58
  *
59
+ * @throws {@link APIGatewayServiceException}
60
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
57
61
  *
58
62
  */
59
63
  export declare class DeleteUsagePlanCommand extends $Command<DeleteUsagePlanCommandInput, DeleteUsagePlanCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteUsagePlanKeyCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteUsagePlanKeyCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteUsagePlanKeyCommandInput - {@link DeleteUsagePlanKeyCommandInput}
@@ -55,6 +57,8 @@ export interface DeleteUsagePlanKeyCommandOutput extends __MetadataBearer {
55
57
  * @throws {@link UnauthorizedException} (client fault)
56
58
  * <p>The request is denied because the caller has insufficient permissions.</p>
57
59
  *
60
+ * @throws {@link APIGatewayServiceException}
61
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
58
62
  *
59
63
  */
60
64
  export declare class DeleteUsagePlanKeyCommand extends $Command<DeleteUsagePlanKeyCommandInput, DeleteUsagePlanKeyCommandOutput, APIGatewayClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteVpcLinkCommandOutput extends __MetadataBearer {
31
31
  * };
32
32
  * const command = new DeleteVpcLinkCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteVpcLinkCommandInput - {@link DeleteVpcLinkCommandInput}
@@ -54,6 +56,8 @@ export interface DeleteVpcLinkCommandOutput extends __MetadataBearer {
54
56
  * @throws {@link UnauthorizedException} (client fault)
55
57
  * <p>The request is denied because the caller has insufficient permissions.</p>
56
58
  *
59
+ * @throws {@link APIGatewayServiceException}
60
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
57
61
  *
58
62
  */
59
63
  export declare class DeleteVpcLinkCommand extends $Command<DeleteVpcLinkCommandInput, DeleteVpcLinkCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface FlushStageAuthorizersCacheCommandOutput extends __MetadataBeare
32
32
  * };
33
33
  * const command = new FlushStageAuthorizersCacheCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param FlushStageAuthorizersCacheCommandInput - {@link FlushStageAuthorizersCacheCommandInput}
@@ -58,6 +60,8 @@ export interface FlushStageAuthorizersCacheCommandOutput extends __MetadataBeare
58
60
  * @throws {@link UnauthorizedException} (client fault)
59
61
  * <p>The request is denied because the caller has insufficient permissions.</p>
60
62
  *
63
+ * @throws {@link APIGatewayServiceException}
64
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
61
65
  *
62
66
  */
63
67
  export declare class FlushStageAuthorizersCacheCommand extends $Command<FlushStageAuthorizersCacheCommandInput, FlushStageAuthorizersCacheCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface FlushStageCacheCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new FlushStageCacheCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param FlushStageCacheCommandInput - {@link FlushStageCacheCommandInput}
@@ -58,6 +60,8 @@ export interface FlushStageCacheCommandOutput extends __MetadataBearer {
58
60
  * @throws {@link UnauthorizedException} (client fault)
59
61
  * <p>The request is denied because the caller has insufficient permissions.</p>
60
62
  *
63
+ * @throws {@link APIGatewayServiceException}
64
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
61
65
  *
62
66
  */
63
67
  export declare class FlushStageCacheCommand extends $Command<FlushStageCacheCommandInput, FlushStageCacheCommandOutput, APIGatewayClientResolvedConfig> {
@@ -34,6 +34,17 @@ export interface GenerateClientCertificateCommandOutput extends ClientCertificat
34
34
  * };
35
35
  * const command = new GenerateClientCertificateCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ClientCertificate
38
+ * // clientCertificateId: "STRING_VALUE",
39
+ * // description: "STRING_VALUE",
40
+ * // pemEncodedCertificate: "STRING_VALUE",
41
+ * // createdDate: new Date("TIMESTAMP"),
42
+ * // expirationDate: new Date("TIMESTAMP"),
43
+ * // tags: { // MapOfStringToString
44
+ * // "<keys>": "STRING_VALUE",
45
+ * // },
46
+ * // };
47
+ *
37
48
  * ```
38
49
  *
39
50
  * @param GenerateClientCertificateCommandInput - {@link GenerateClientCertificateCommandInput}
@@ -57,6 +68,8 @@ export interface GenerateClientCertificateCommandOutput extends ClientCertificat
57
68
  * @throws {@link UnauthorizedException} (client fault)
58
69
  * <p>The request is denied because the caller has insufficient permissions.</p>
59
70
  *
71
+ * @throws {@link APIGatewayServiceException}
72
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
60
73
  *
61
74
  */
62
75
  export declare class GenerateClientCertificateCommand extends $Command<GenerateClientCertificateCommandInput, GenerateClientCertificateCommandOutput, APIGatewayClientResolvedConfig> {
@@ -29,6 +29,18 @@ export interface GetAccountCommandOutput extends Account, __MetadataBearer {
29
29
  * const input = {};
30
30
  * const command = new GetAccountCommand(input);
31
31
  * const response = await client.send(command);
32
+ * // { // Account
33
+ * // cloudwatchRoleArn: "STRING_VALUE",
34
+ * // throttleSettings: { // ThrottleSettings
35
+ * // burstLimit: Number("int"),
36
+ * // rateLimit: Number("double"),
37
+ * // },
38
+ * // features: [ // ListOfString
39
+ * // "STRING_VALUE",
40
+ * // ],
41
+ * // apiKeyVersion: "STRING_VALUE",
42
+ * // };
43
+ *
32
44
  * ```
33
45
  *
34
46
  * @param GetAccountCommandInput - {@link GetAccountCommandInput}
@@ -49,6 +61,8 @@ export interface GetAccountCommandOutput extends Account, __MetadataBearer {
49
61
  * @throws {@link UnauthorizedException} (client fault)
50
62
  * <p>The request is denied because the caller has insufficient permissions.</p>
51
63
  *
64
+ * @throws {@link APIGatewayServiceException}
65
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
52
66
  *
53
67
  */
54
68
  export declare class GetAccountCommand extends $Command<GetAccountCommandInput, GetAccountCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,23 @@ export interface GetApiKeyCommandOutput extends ApiKey, __MetadataBearer {
32
32
  * };
33
33
  * const command = new GetApiKeyCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ApiKey
36
+ * // id: "STRING_VALUE",
37
+ * // value: "STRING_VALUE",
38
+ * // name: "STRING_VALUE",
39
+ * // customerId: "STRING_VALUE",
40
+ * // description: "STRING_VALUE",
41
+ * // enabled: true || false,
42
+ * // createdDate: new Date("TIMESTAMP"),
43
+ * // lastUpdatedDate: new Date("TIMESTAMP"),
44
+ * // stageKeys: [ // ListOfString
45
+ * // "STRING_VALUE",
46
+ * // ],
47
+ * // tags: { // MapOfStringToString
48
+ * // "<keys>": "STRING_VALUE",
49
+ * // },
50
+ * // };
51
+ *
35
52
  * ```
36
53
  *
37
54
  * @param GetApiKeyCommandInput - {@link GetApiKeyCommandInput}
@@ -52,6 +69,8 @@ export interface GetApiKeyCommandOutput extends ApiKey, __MetadataBearer {
52
69
  * @throws {@link UnauthorizedException} (client fault)
53
70
  * <p>The request is denied because the caller has insufficient permissions.</p>
54
71
  *
72
+ * @throws {@link APIGatewayServiceException}
73
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
55
74
  *
56
75
  */
57
76
  export declare class GetApiKeyCommand extends $Command<GetApiKeyCommandInput, GetApiKeyCommandOutput, APIGatewayClientResolvedConfig> {
@@ -35,6 +35,31 @@ export interface GetApiKeysCommandOutput extends ApiKeys, __MetadataBearer {
35
35
  * };
36
36
  * const command = new GetApiKeysCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ApiKeys
39
+ * // warnings: [ // ListOfString
40
+ * // "STRING_VALUE",
41
+ * // ],
42
+ * // items: [ // ListOfApiKey
43
+ * // { // ApiKey
44
+ * // id: "STRING_VALUE",
45
+ * // value: "STRING_VALUE",
46
+ * // name: "STRING_VALUE",
47
+ * // customerId: "STRING_VALUE",
48
+ * // description: "STRING_VALUE",
49
+ * // enabled: true || false,
50
+ * // createdDate: new Date("TIMESTAMP"),
51
+ * // lastUpdatedDate: new Date("TIMESTAMP"),
52
+ * // stageKeys: [
53
+ * // "STRING_VALUE",
54
+ * // ],
55
+ * // tags: { // MapOfStringToString
56
+ * // "<keys>": "STRING_VALUE",
57
+ * // },
58
+ * // },
59
+ * // ],
60
+ * // position: "STRING_VALUE",
61
+ * // };
62
+ *
38
63
  * ```
39
64
  *
40
65
  * @param GetApiKeysCommandInput - {@link GetApiKeysCommandInput}
@@ -55,6 +80,8 @@ export interface GetApiKeysCommandOutput extends ApiKeys, __MetadataBearer {
55
80
  * @throws {@link UnauthorizedException} (client fault)
56
81
  * <p>The request is denied because the caller has insufficient permissions.</p>
57
82
  *
83
+ * @throws {@link APIGatewayServiceException}
84
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
58
85
  *
59
86
  */
60
87
  export declare class GetApiKeysCommand extends $Command<GetApiKeysCommandInput, GetApiKeysCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,21 @@ export interface GetAuthorizerCommandOutput extends Authorizer, __MetadataBearer
32
32
  * };
33
33
  * const command = new GetAuthorizerCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // Authorizer
36
+ * // id: "STRING_VALUE",
37
+ * // name: "STRING_VALUE",
38
+ * // type: "TOKEN" || "REQUEST" || "COGNITO_USER_POOLS",
39
+ * // providerARNs: [ // ListOfARNs
40
+ * // "STRING_VALUE",
41
+ * // ],
42
+ * // authType: "STRING_VALUE",
43
+ * // authorizerUri: "STRING_VALUE",
44
+ * // authorizerCredentials: "STRING_VALUE",
45
+ * // identitySource: "STRING_VALUE",
46
+ * // identityValidationExpression: "STRING_VALUE",
47
+ * // authorizerResultTtlInSeconds: Number("int"),
48
+ * // };
49
+ *
35
50
  * ```
36
51
  *
37
52
  * @param GetAuthorizerCommandInput - {@link GetAuthorizerCommandInput}
@@ -52,6 +67,8 @@ export interface GetAuthorizerCommandOutput extends Authorizer, __MetadataBearer
52
67
  * @throws {@link UnauthorizedException} (client fault)
53
68
  * <p>The request is denied because the caller has insufficient permissions.</p>
54
69
  *
70
+ * @throws {@link APIGatewayServiceException}
71
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
55
72
  *
56
73
  */
57
74
  export declare class GetAuthorizerCommand extends $Command<GetAuthorizerCommandInput, GetAuthorizerCommandOutput, APIGatewayClientResolvedConfig> {
@@ -33,6 +33,26 @@ export interface GetAuthorizersCommandOutput extends Authorizers, __MetadataBear
33
33
  * };
34
34
  * const command = new GetAuthorizersCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // Authorizers
37
+ * // items: [ // ListOfAuthorizer
38
+ * // { // Authorizer
39
+ * // id: "STRING_VALUE",
40
+ * // name: "STRING_VALUE",
41
+ * // type: "TOKEN" || "REQUEST" || "COGNITO_USER_POOLS",
42
+ * // providerARNs: [ // ListOfARNs
43
+ * // "STRING_VALUE",
44
+ * // ],
45
+ * // authType: "STRING_VALUE",
46
+ * // authorizerUri: "STRING_VALUE",
47
+ * // authorizerCredentials: "STRING_VALUE",
48
+ * // identitySource: "STRING_VALUE",
49
+ * // identityValidationExpression: "STRING_VALUE",
50
+ * // authorizerResultTtlInSeconds: Number("int"),
51
+ * // },
52
+ * // ],
53
+ * // position: "STRING_VALUE",
54
+ * // };
55
+ *
36
56
  * ```
37
57
  *
38
58
  * @param GetAuthorizersCommandInput - {@link GetAuthorizersCommandInput}
@@ -53,6 +73,8 @@ export interface GetAuthorizersCommandOutput extends Authorizers, __MetadataBear
53
73
  * @throws {@link UnauthorizedException} (client fault)
54
74
  * <p>The request is denied because the caller has insufficient permissions.</p>
55
75
  *
76
+ * @throws {@link APIGatewayServiceException}
77
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
56
78
  *
57
79
  */
58
80
  export declare class GetAuthorizersCommand extends $Command<GetAuthorizersCommandInput, GetAuthorizersCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,12 @@ export interface GetBasePathMappingCommandOutput extends BasePathMapping, __Meta
32
32
  * };
33
33
  * const command = new GetBasePathMappingCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // BasePathMapping
36
+ * // basePath: "STRING_VALUE",
37
+ * // restApiId: "STRING_VALUE",
38
+ * // stage: "STRING_VALUE",
39
+ * // };
40
+ *
35
41
  * ```
36
42
  *
37
43
  * @param GetBasePathMappingCommandInput - {@link GetBasePathMappingCommandInput}
@@ -52,6 +58,8 @@ export interface GetBasePathMappingCommandOutput extends BasePathMapping, __Meta
52
58
  * @throws {@link UnauthorizedException} (client fault)
53
59
  * <p>The request is denied because the caller has insufficient permissions.</p>
54
60
  *
61
+ * @throws {@link APIGatewayServiceException}
62
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
55
63
  *
56
64
  */
57
65
  export declare class GetBasePathMappingCommand extends $Command<GetBasePathMappingCommandInput, GetBasePathMappingCommandOutput, APIGatewayClientResolvedConfig> {
@@ -33,6 +33,17 @@ export interface GetBasePathMappingsCommandOutput extends BasePathMappings, __Me
33
33
  * };
34
34
  * const command = new GetBasePathMappingsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // BasePathMappings
37
+ * // items: [ // ListOfBasePathMapping
38
+ * // { // BasePathMapping
39
+ * // basePath: "STRING_VALUE",
40
+ * // restApiId: "STRING_VALUE",
41
+ * // stage: "STRING_VALUE",
42
+ * // },
43
+ * // ],
44
+ * // position: "STRING_VALUE",
45
+ * // };
46
+ *
36
47
  * ```
37
48
  *
38
49
  * @param GetBasePathMappingsCommandInput - {@link GetBasePathMappingsCommandInput}
@@ -53,6 +64,8 @@ export interface GetBasePathMappingsCommandOutput extends BasePathMappings, __Me
53
64
  * @throws {@link UnauthorizedException} (client fault)
54
65
  * <p>The request is denied because the caller has insufficient permissions.</p>
55
66
  *
67
+ * @throws {@link APIGatewayServiceException}
68
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
56
69
  *
57
70
  */
58
71
  export declare class GetBasePathMappingsCommand extends $Command<GetBasePathMappingsCommandInput, GetBasePathMappingsCommandOutput, APIGatewayClientResolvedConfig> {
@@ -31,6 +31,17 @@ export interface GetClientCertificateCommandOutput extends ClientCertificate, __
31
31
  * };
32
32
  * const command = new GetClientCertificateCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ClientCertificate
35
+ * // clientCertificateId: "STRING_VALUE",
36
+ * // description: "STRING_VALUE",
37
+ * // pemEncodedCertificate: "STRING_VALUE",
38
+ * // createdDate: new Date("TIMESTAMP"),
39
+ * // expirationDate: new Date("TIMESTAMP"),
40
+ * // tags: { // MapOfStringToString
41
+ * // "<keys>": "STRING_VALUE",
42
+ * // },
43
+ * // };
44
+ *
34
45
  * ```
35
46
  *
36
47
  * @param GetClientCertificateCommandInput - {@link GetClientCertificateCommandInput}
@@ -51,6 +62,8 @@ export interface GetClientCertificateCommandOutput extends ClientCertificate, __
51
62
  * @throws {@link UnauthorizedException} (client fault)
52
63
  * <p>The request is denied because the caller has insufficient permissions.</p>
53
64
  *
65
+ * @throws {@link APIGatewayServiceException}
66
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
54
67
  *
55
68
  */
56
69
  export declare class GetClientCertificateCommand extends $Command<GetClientCertificateCommandInput, GetClientCertificateCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,22 @@ export interface GetClientCertificatesCommandOutput extends ClientCertificates,
32
32
  * };
33
33
  * const command = new GetClientCertificatesCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ClientCertificates
36
+ * // items: [ // ListOfClientCertificate
37
+ * // { // ClientCertificate
38
+ * // clientCertificateId: "STRING_VALUE",
39
+ * // description: "STRING_VALUE",
40
+ * // pemEncodedCertificate: "STRING_VALUE",
41
+ * // createdDate: new Date("TIMESTAMP"),
42
+ * // expirationDate: new Date("TIMESTAMP"),
43
+ * // tags: { // MapOfStringToString
44
+ * // "<keys>": "STRING_VALUE",
45
+ * // },
46
+ * // },
47
+ * // ],
48
+ * // position: "STRING_VALUE",
49
+ * // };
50
+ *
35
51
  * ```
36
52
  *
37
53
  * @param GetClientCertificatesCommandInput - {@link GetClientCertificatesCommandInput}
@@ -52,6 +68,8 @@ export interface GetClientCertificatesCommandOutput extends ClientCertificates,
52
68
  * @throws {@link UnauthorizedException} (client fault)
53
69
  * <p>The request is denied because the caller has insufficient permissions.</p>
54
70
  *
71
+ * @throws {@link APIGatewayServiceException}
72
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
55
73
  *
56
74
  */
57
75
  export declare class GetClientCertificatesCommand extends $Command<GetClientCertificatesCommandInput, GetClientCertificatesCommandOutput, APIGatewayClientResolvedConfig> {