@aws-sdk/client-api-gateway 3.325.0 → 3.327.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 +8 -8
@@ -33,6 +33,42 @@ export interface GetUsagePlansCommandOutput extends UsagePlans, __MetadataBearer
33
33
  * };
34
34
  * const command = new GetUsagePlansCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // UsagePlans
37
+ * // items: [ // ListOfUsagePlan
38
+ * // { // UsagePlan
39
+ * // id: "STRING_VALUE",
40
+ * // name: "STRING_VALUE",
41
+ * // description: "STRING_VALUE",
42
+ * // apiStages: [ // ListOfApiStage
43
+ * // { // ApiStage
44
+ * // apiId: "STRING_VALUE",
45
+ * // stage: "STRING_VALUE",
46
+ * // throttle: { // MapOfApiStageThrottleSettings
47
+ * // "<keys>": { // ThrottleSettings
48
+ * // burstLimit: Number("int"),
49
+ * // rateLimit: Number("double"),
50
+ * // },
51
+ * // },
52
+ * // },
53
+ * // ],
54
+ * // throttle: {
55
+ * // burstLimit: Number("int"),
56
+ * // rateLimit: Number("double"),
57
+ * // },
58
+ * // quota: { // QuotaSettings
59
+ * // limit: Number("int"),
60
+ * // offset: Number("int"),
61
+ * // period: "DAY" || "WEEK" || "MONTH",
62
+ * // },
63
+ * // productCode: "STRING_VALUE",
64
+ * // tags: { // MapOfStringToString
65
+ * // "<keys>": "STRING_VALUE",
66
+ * // },
67
+ * // },
68
+ * // ],
69
+ * // position: "STRING_VALUE",
70
+ * // };
71
+ *
36
72
  * ```
37
73
  *
38
74
  * @param GetUsagePlansCommandInput - {@link GetUsagePlansCommandInput}
@@ -53,6 +89,8 @@ export interface GetUsagePlansCommandOutput extends UsagePlans, __MetadataBearer
53
89
  * @throws {@link UnauthorizedException} (client fault)
54
90
  * <p>The request is denied because the caller has insufficient permissions.</p>
55
91
  *
92
+ * @throws {@link APIGatewayServiceException}
93
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
56
94
  *
57
95
  */
58
96
  export declare class GetUsagePlansCommand extends $Command<GetUsagePlansCommandInput, GetUsagePlansCommandOutput, APIGatewayClientResolvedConfig> {
@@ -31,6 +31,20 @@ export interface GetVpcLinkCommandOutput extends VpcLink, __MetadataBearer {
31
31
  * };
32
32
  * const command = new GetVpcLinkCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // VpcLink
35
+ * // id: "STRING_VALUE",
36
+ * // name: "STRING_VALUE",
37
+ * // description: "STRING_VALUE",
38
+ * // targetArns: [ // ListOfString
39
+ * // "STRING_VALUE",
40
+ * // ],
41
+ * // status: "AVAILABLE" || "PENDING" || "DELETING" || "FAILED",
42
+ * // statusMessage: "STRING_VALUE",
43
+ * // tags: { // MapOfStringToString
44
+ * // "<keys>": "STRING_VALUE",
45
+ * // },
46
+ * // };
47
+ *
34
48
  * ```
35
49
  *
36
50
  * @param GetVpcLinkCommandInput - {@link GetVpcLinkCommandInput}
@@ -51,6 +65,8 @@ export interface GetVpcLinkCommandOutput extends VpcLink, __MetadataBearer {
51
65
  * @throws {@link UnauthorizedException} (client fault)
52
66
  * <p>The request is denied because the caller has insufficient permissions.</p>
53
67
  *
68
+ * @throws {@link APIGatewayServiceException}
69
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
54
70
  *
55
71
  */
56
72
  export declare class GetVpcLinkCommand extends $Command<GetVpcLinkCommandInput, GetVpcLinkCommandOutput, APIGatewayClientResolvedConfig> {
@@ -32,6 +32,25 @@ export interface GetVpcLinksCommandOutput extends VpcLinks, __MetadataBearer {
32
32
  * };
33
33
  * const command = new GetVpcLinksCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // VpcLinks
36
+ * // items: [ // ListOfVpcLink
37
+ * // { // VpcLink
38
+ * // id: "STRING_VALUE",
39
+ * // name: "STRING_VALUE",
40
+ * // description: "STRING_VALUE",
41
+ * // targetArns: [ // ListOfString
42
+ * // "STRING_VALUE",
43
+ * // ],
44
+ * // status: "AVAILABLE" || "PENDING" || "DELETING" || "FAILED",
45
+ * // statusMessage: "STRING_VALUE",
46
+ * // tags: { // MapOfStringToString
47
+ * // "<keys>": "STRING_VALUE",
48
+ * // },
49
+ * // },
50
+ * // ],
51
+ * // position: "STRING_VALUE",
52
+ * // };
53
+ *
35
54
  * ```
36
55
  *
37
56
  * @param GetVpcLinksCommandInput - {@link GetVpcLinksCommandInput}
@@ -52,6 +71,8 @@ export interface GetVpcLinksCommandOutput extends VpcLinks, __MetadataBearer {
52
71
  * @throws {@link UnauthorizedException} (client fault)
53
72
  * <p>The request is denied because the caller has insufficient permissions.</p>
54
73
  *
74
+ * @throws {@link APIGatewayServiceException}
75
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
55
76
  *
56
77
  */
57
78
  export declare class GetVpcLinksCommand extends $Command<GetVpcLinksCommandInput, GetVpcLinksCommandOutput, APIGatewayClientResolvedConfig> {
@@ -33,6 +33,15 @@ export interface ImportApiKeysCommandOutput extends ApiKeyIds, __MetadataBearer
33
33
  * };
34
34
  * const command = new ImportApiKeysCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ApiKeyIds
37
+ * // ids: [ // ListOfString
38
+ * // "STRING_VALUE",
39
+ * // ],
40
+ * // warnings: [
41
+ * // "STRING_VALUE",
42
+ * // ],
43
+ * // };
44
+ *
36
45
  * ```
37
46
  *
38
47
  * @param ImportApiKeysCommandInput - {@link ImportApiKeysCommandInput}
@@ -59,6 +68,8 @@ export interface ImportApiKeysCommandOutput extends ApiKeyIds, __MetadataBearer
59
68
  * @throws {@link UnauthorizedException} (client fault)
60
69
  * <p>The request is denied because the caller has insufficient permissions.</p>
61
70
  *
71
+ * @throws {@link APIGatewayServiceException}
72
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
62
73
  *
63
74
  */
64
75
  export declare class ImportApiKeysCommand extends $Command<ImportApiKeysCommandInput, ImportApiKeysCommandOutput, APIGatewayClientResolvedConfig> {
@@ -34,6 +34,15 @@ export interface ImportDocumentationPartsCommandOutput extends DocumentationPart
34
34
  * };
35
35
  * const command = new ImportDocumentationPartsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // DocumentationPartIds
38
+ * // ids: [ // ListOfString
39
+ * // "STRING_VALUE",
40
+ * // ],
41
+ * // warnings: [
42
+ * // "STRING_VALUE",
43
+ * // ],
44
+ * // };
45
+ *
37
46
  * ```
38
47
  *
39
48
  * @param ImportDocumentationPartsCommandInput - {@link ImportDocumentationPartsCommandInput}
@@ -60,6 +69,8 @@ export interface ImportDocumentationPartsCommandOutput extends DocumentationPart
60
69
  * @throws {@link UnauthorizedException} (client fault)
61
70
  * <p>The request is denied because the caller has insufficient permissions.</p>
62
71
  *
72
+ * @throws {@link APIGatewayServiceException}
73
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
63
74
  *
64
75
  */
65
76
  export declare class ImportDocumentationPartsCommand extends $Command<ImportDocumentationPartsCommandInput, ImportDocumentationPartsCommandOutput, APIGatewayClientResolvedConfig> {
@@ -35,6 +35,35 @@ export interface ImportRestApiCommandOutput extends RestApi, __MetadataBearer {
35
35
  * };
36
36
  * const command = new ImportRestApiCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // RestApi
39
+ * // id: "STRING_VALUE",
40
+ * // name: "STRING_VALUE",
41
+ * // description: "STRING_VALUE",
42
+ * // createdDate: new Date("TIMESTAMP"),
43
+ * // version: "STRING_VALUE",
44
+ * // warnings: [ // ListOfString
45
+ * // "STRING_VALUE",
46
+ * // ],
47
+ * // binaryMediaTypes: [
48
+ * // "STRING_VALUE",
49
+ * // ],
50
+ * // minimumCompressionSize: Number("int"),
51
+ * // apiKeySource: "HEADER" || "AUTHORIZER",
52
+ * // endpointConfiguration: { // EndpointConfiguration
53
+ * // types: [ // ListOfEndpointType
54
+ * // "REGIONAL" || "EDGE" || "PRIVATE",
55
+ * // ],
56
+ * // vpcEndpointIds: [
57
+ * // "STRING_VALUE",
58
+ * // ],
59
+ * // },
60
+ * // policy: "STRING_VALUE",
61
+ * // tags: { // MapOfStringToString
62
+ * // "<keys>": "STRING_VALUE",
63
+ * // },
64
+ * // disableExecuteApiEndpoint: true || false,
65
+ * // };
66
+ *
38
67
  * ```
39
68
  *
40
69
  * @param ImportRestApiCommandInput - {@link ImportRestApiCommandInput}
@@ -61,6 +90,8 @@ export interface ImportRestApiCommandOutput extends RestApi, __MetadataBearer {
61
90
  * @throws {@link UnauthorizedException} (client fault)
62
91
  * <p>The request is denied because the caller has insufficient permissions.</p>
63
92
  *
93
+ * @throws {@link APIGatewayServiceException}
94
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
64
95
  *
65
96
  */
66
97
  export declare class ImportRestApiCommand extends $Command<ImportRestApiCommandInput, ImportRestApiCommandOutput, APIGatewayClientResolvedConfig> {
@@ -39,6 +39,18 @@ export interface PutGatewayResponseCommandOutput extends GatewayResponse, __Meta
39
39
  * };
40
40
  * const command = new PutGatewayResponseCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // GatewayResponse
43
+ * // responseType: "DEFAULT_4XX" || "DEFAULT_5XX" || "RESOURCE_NOT_FOUND" || "UNAUTHORIZED" || "INVALID_API_KEY" || "ACCESS_DENIED" || "AUTHORIZER_FAILURE" || "AUTHORIZER_CONFIGURATION_ERROR" || "INVALID_SIGNATURE" || "EXPIRED_TOKEN" || "MISSING_AUTHENTICATION_TOKEN" || "INTEGRATION_FAILURE" || "INTEGRATION_TIMEOUT" || "API_CONFIGURATION_ERROR" || "UNSUPPORTED_MEDIA_TYPE" || "BAD_REQUEST_PARAMETERS" || "BAD_REQUEST_BODY" || "REQUEST_TOO_LARGE" || "THROTTLED" || "QUOTA_EXCEEDED" || "WAF_FILTERED",
44
+ * // statusCode: "STRING_VALUE",
45
+ * // responseParameters: { // MapOfStringToString
46
+ * // "<keys>": "STRING_VALUE",
47
+ * // },
48
+ * // responseTemplates: {
49
+ * // "<keys>": "STRING_VALUE",
50
+ * // },
51
+ * // defaultResponse: true || false,
52
+ * // };
53
+ *
42
54
  * ```
43
55
  *
44
56
  * @param PutGatewayResponseCommandInput - {@link PutGatewayResponseCommandInput}
@@ -65,6 +77,8 @@ export interface PutGatewayResponseCommandOutput extends GatewayResponse, __Meta
65
77
  * @throws {@link UnauthorizedException} (client fault)
66
78
  * <p>The request is denied because the caller has insufficient permissions.</p>
67
79
  *
80
+ * @throws {@link APIGatewayServiceException}
81
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
68
82
  *
69
83
  */
70
84
  export declare class PutGatewayResponseCommand extends $Command<PutGatewayResponseCommandInput, PutGatewayResponseCommandOutput, APIGatewayClientResolvedConfig> {
@@ -55,6 +55,44 @@ export interface PutIntegrationCommandOutput extends Integration, __MetadataBear
55
55
  * };
56
56
  * const command = new PutIntegrationCommand(input);
57
57
  * const response = await client.send(command);
58
+ * // { // Integration
59
+ * // type: "HTTP" || "AWS" || "MOCK" || "HTTP_PROXY" || "AWS_PROXY",
60
+ * // httpMethod: "STRING_VALUE",
61
+ * // uri: "STRING_VALUE",
62
+ * // connectionType: "INTERNET" || "VPC_LINK",
63
+ * // connectionId: "STRING_VALUE",
64
+ * // credentials: "STRING_VALUE",
65
+ * // requestParameters: { // MapOfStringToString
66
+ * // "<keys>": "STRING_VALUE",
67
+ * // },
68
+ * // requestTemplates: {
69
+ * // "<keys>": "STRING_VALUE",
70
+ * // },
71
+ * // passthroughBehavior: "STRING_VALUE",
72
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
73
+ * // timeoutInMillis: Number("int"),
74
+ * // cacheNamespace: "STRING_VALUE",
75
+ * // cacheKeyParameters: [ // ListOfString
76
+ * // "STRING_VALUE",
77
+ * // ],
78
+ * // integrationResponses: { // MapOfIntegrationResponse
79
+ * // "<keys>": { // IntegrationResponse
80
+ * // statusCode: "STRING_VALUE",
81
+ * // selectionPattern: "STRING_VALUE",
82
+ * // responseParameters: {
83
+ * // "<keys>": "STRING_VALUE",
84
+ * // },
85
+ * // responseTemplates: {
86
+ * // "<keys>": "STRING_VALUE",
87
+ * // },
88
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
89
+ * // },
90
+ * // },
91
+ * // tlsConfig: { // TlsConfig
92
+ * // insecureSkipVerification: true || false,
93
+ * // },
94
+ * // };
95
+ *
58
96
  * ```
59
97
  *
60
98
  * @param PutIntegrationCommandInput - {@link PutIntegrationCommandInput}
@@ -81,6 +119,8 @@ export interface PutIntegrationCommandOutput extends Integration, __MetadataBear
81
119
  * @throws {@link UnauthorizedException} (client fault)
82
120
  * <p>The request is denied because the caller has insufficient permissions.</p>
83
121
  *
122
+ * @throws {@link APIGatewayServiceException}
123
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
84
124
  *
85
125
  */
86
126
  export declare class PutIntegrationCommand extends $Command<PutIntegrationCommandInput, PutIntegrationCommandOutput, APIGatewayClientResolvedConfig> {
@@ -42,6 +42,18 @@ export interface PutIntegrationResponseCommandOutput extends IntegrationResponse
42
42
  * };
43
43
  * const command = new PutIntegrationResponseCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // IntegrationResponse
46
+ * // statusCode: "STRING_VALUE",
47
+ * // selectionPattern: "STRING_VALUE",
48
+ * // responseParameters: { // MapOfStringToString
49
+ * // "<keys>": "STRING_VALUE",
50
+ * // },
51
+ * // responseTemplates: {
52
+ * // "<keys>": "STRING_VALUE",
53
+ * // },
54
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
55
+ * // };
56
+ *
45
57
  * ```
46
58
  *
47
59
  * @param PutIntegrationResponseCommandInput - {@link PutIntegrationResponseCommandInput}
@@ -68,6 +80,8 @@ export interface PutIntegrationResponseCommandOutput extends IntegrationResponse
68
80
  * @throws {@link UnauthorizedException} (client fault)
69
81
  * <p>The request is denied because the caller has insufficient permissions.</p>
70
82
  *
83
+ * @throws {@link APIGatewayServiceException}
84
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
71
85
  *
72
86
  */
73
87
  export declare class PutIntegrationResponseCommand extends $Command<PutIntegrationResponseCommandInput, PutIntegrationResponseCommandOutput, APIGatewayClientResolvedConfig> {
@@ -47,6 +47,64 @@ export interface PutMethodCommandOutput extends Method, __MetadataBearer {
47
47
  * };
48
48
  * const command = new PutMethodCommand(input);
49
49
  * const response = await client.send(command);
50
+ * // { // Method
51
+ * // httpMethod: "STRING_VALUE",
52
+ * // authorizationType: "STRING_VALUE",
53
+ * // authorizerId: "STRING_VALUE",
54
+ * // apiKeyRequired: true || false,
55
+ * // requestValidatorId: "STRING_VALUE",
56
+ * // operationName: "STRING_VALUE",
57
+ * // requestParameters: { // MapOfStringToBoolean
58
+ * // "<keys>": true || false,
59
+ * // },
60
+ * // requestModels: { // MapOfStringToString
61
+ * // "<keys>": "STRING_VALUE",
62
+ * // },
63
+ * // methodResponses: { // MapOfMethodResponse
64
+ * // "<keys>": { // MethodResponse
65
+ * // statusCode: "STRING_VALUE",
66
+ * // responseParameters: {
67
+ * // "<keys>": true || false,
68
+ * // },
69
+ * // responseModels: {
70
+ * // "<keys>": "STRING_VALUE",
71
+ * // },
72
+ * // },
73
+ * // },
74
+ * // methodIntegration: { // Integration
75
+ * // type: "HTTP" || "AWS" || "MOCK" || "HTTP_PROXY" || "AWS_PROXY",
76
+ * // httpMethod: "STRING_VALUE",
77
+ * // uri: "STRING_VALUE",
78
+ * // connectionType: "INTERNET" || "VPC_LINK",
79
+ * // connectionId: "STRING_VALUE",
80
+ * // credentials: "STRING_VALUE",
81
+ * // requestParameters: "<MapOfStringToString>",
82
+ * // requestTemplates: "<MapOfStringToString>",
83
+ * // passthroughBehavior: "STRING_VALUE",
84
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
85
+ * // timeoutInMillis: Number("int"),
86
+ * // cacheNamespace: "STRING_VALUE",
87
+ * // cacheKeyParameters: [ // ListOfString
88
+ * // "STRING_VALUE",
89
+ * // ],
90
+ * // integrationResponses: { // MapOfIntegrationResponse
91
+ * // "<keys>": { // IntegrationResponse
92
+ * // statusCode: "STRING_VALUE",
93
+ * // selectionPattern: "STRING_VALUE",
94
+ * // responseParameters: "<MapOfStringToString>",
95
+ * // responseTemplates: "<MapOfStringToString>",
96
+ * // contentHandling: "CONVERT_TO_BINARY" || "CONVERT_TO_TEXT",
97
+ * // },
98
+ * // },
99
+ * // tlsConfig: { // TlsConfig
100
+ * // insecureSkipVerification: true || false,
101
+ * // },
102
+ * // },
103
+ * // authorizationScopes: [
104
+ * // "STRING_VALUE",
105
+ * // ],
106
+ * // };
107
+ *
50
108
  * ```
51
109
  *
52
110
  * @param PutMethodCommandInput - {@link PutMethodCommandInput}
@@ -73,6 +131,8 @@ export interface PutMethodCommandOutput extends Method, __MetadataBearer {
73
131
  * @throws {@link UnauthorizedException} (client fault)
74
132
  * <p>The request is denied because the caller has insufficient permissions.</p>
75
133
  *
134
+ * @throws {@link APIGatewayServiceException}
135
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
76
136
  *
77
137
  */
78
138
  export declare class PutMethodCommand extends $Command<PutMethodCommandInput, PutMethodCommandOutput, APIGatewayClientResolvedConfig> {
@@ -40,6 +40,16 @@ export interface PutMethodResponseCommandOutput extends MethodResponse, __Metada
40
40
  * };
41
41
  * const command = new PutMethodResponseCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // MethodResponse
44
+ * // statusCode: "STRING_VALUE",
45
+ * // responseParameters: { // MapOfStringToBoolean
46
+ * // "<keys>": true || false,
47
+ * // },
48
+ * // responseModels: { // MapOfStringToString
49
+ * // "<keys>": "STRING_VALUE",
50
+ * // },
51
+ * // };
52
+ *
43
53
  * ```
44
54
  *
45
55
  * @param PutMethodResponseCommandInput - {@link PutMethodResponseCommandInput}
@@ -66,6 +76,8 @@ export interface PutMethodResponseCommandOutput extends MethodResponse, __Metada
66
76
  * @throws {@link UnauthorizedException} (client fault)
67
77
  * <p>The request is denied because the caller has insufficient permissions.</p>
68
78
  *
79
+ * @throws {@link APIGatewayServiceException}
80
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
69
81
  *
70
82
  */
71
83
  export declare class PutMethodResponseCommand extends $Command<PutMethodResponseCommandInput, PutMethodResponseCommandOutput, APIGatewayClientResolvedConfig> {
@@ -38,6 +38,35 @@ export interface PutRestApiCommandOutput extends RestApi, __MetadataBearer {
38
38
  * };
39
39
  * const command = new PutRestApiCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // RestApi
42
+ * // id: "STRING_VALUE",
43
+ * // name: "STRING_VALUE",
44
+ * // description: "STRING_VALUE",
45
+ * // createdDate: new Date("TIMESTAMP"),
46
+ * // version: "STRING_VALUE",
47
+ * // warnings: [ // ListOfString
48
+ * // "STRING_VALUE",
49
+ * // ],
50
+ * // binaryMediaTypes: [
51
+ * // "STRING_VALUE",
52
+ * // ],
53
+ * // minimumCompressionSize: Number("int"),
54
+ * // apiKeySource: "HEADER" || "AUTHORIZER",
55
+ * // endpointConfiguration: { // EndpointConfiguration
56
+ * // types: [ // ListOfEndpointType
57
+ * // "REGIONAL" || "EDGE" || "PRIVATE",
58
+ * // ],
59
+ * // vpcEndpointIds: [
60
+ * // "STRING_VALUE",
61
+ * // ],
62
+ * // },
63
+ * // policy: "STRING_VALUE",
64
+ * // tags: { // MapOfStringToString
65
+ * // "<keys>": "STRING_VALUE",
66
+ * // },
67
+ * // disableExecuteApiEndpoint: true || false,
68
+ * // };
69
+ *
41
70
  * ```
42
71
  *
43
72
  * @param PutRestApiCommandInput - {@link PutRestApiCommandInput}
@@ -64,6 +93,8 @@ export interface PutRestApiCommandOutput extends RestApi, __MetadataBearer {
64
93
  * @throws {@link UnauthorizedException} (client fault)
65
94
  * <p>The request is denied because the caller has insufficient permissions.</p>
66
95
  *
96
+ * @throws {@link APIGatewayServiceException}
97
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
67
98
  *
68
99
  */
69
100
  export declare class PutRestApiCommand extends $Command<PutRestApiCommandInput, PutRestApiCommandOutput, APIGatewayClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
34
34
  * };
35
35
  * const command = new TagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -60,6 +62,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
60
62
  * @throws {@link UnauthorizedException} (client fault)
61
63
  * <p>The request is denied because the caller has insufficient permissions.</p>
62
64
  *
65
+ * @throws {@link APIGatewayServiceException}
66
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
63
67
  *
64
68
  */
65
69
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, APIGatewayClientResolvedConfig> {
@@ -48,6 +48,22 @@ export interface TestInvokeAuthorizerCommandOutput extends TestInvokeAuthorizerR
48
48
  * };
49
49
  * const command = new TestInvokeAuthorizerCommand(input);
50
50
  * const response = await client.send(command);
51
+ * // { // TestInvokeAuthorizerResponse
52
+ * // clientStatus: Number("int"),
53
+ * // log: "STRING_VALUE",
54
+ * // latency: Number("long"),
55
+ * // principalId: "STRING_VALUE",
56
+ * // policy: "STRING_VALUE",
57
+ * // authorization: { // MapOfStringToList
58
+ * // "<keys>": [ // ListOfString
59
+ * // "STRING_VALUE",
60
+ * // ],
61
+ * // },
62
+ * // claims: { // MapOfStringToString
63
+ * // "<keys>": "STRING_VALUE",
64
+ * // },
65
+ * // };
66
+ *
51
67
  * ```
52
68
  *
53
69
  * @param TestInvokeAuthorizerCommandInput - {@link TestInvokeAuthorizerCommandInput}
@@ -68,6 +84,8 @@ export interface TestInvokeAuthorizerCommandOutput extends TestInvokeAuthorizerR
68
84
  * @throws {@link UnauthorizedException} (client fault)
69
85
  * <p>The request is denied because the caller has insufficient permissions.</p>
70
86
  *
87
+ * @throws {@link APIGatewayServiceException}
88
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
71
89
  *
72
90
  */
73
91
  export declare class TestInvokeAuthorizerCommand extends $Command<TestInvokeAuthorizerCommandInput, TestInvokeAuthorizerCommandOutput, APIGatewayClientResolvedConfig> {
@@ -47,6 +47,21 @@ export interface TestInvokeMethodCommandOutput extends TestInvokeMethodResponse,
47
47
  * };
48
48
  * const command = new TestInvokeMethodCommand(input);
49
49
  * const response = await client.send(command);
50
+ * // { // TestInvokeMethodResponse
51
+ * // status: Number("int"),
52
+ * // body: "STRING_VALUE",
53
+ * // headers: { // MapOfStringToString
54
+ * // "<keys>": "STRING_VALUE",
55
+ * // },
56
+ * // multiValueHeaders: { // MapOfStringToList
57
+ * // "<keys>": [ // ListOfString
58
+ * // "STRING_VALUE",
59
+ * // ],
60
+ * // },
61
+ * // log: "STRING_VALUE",
62
+ * // latency: Number("long"),
63
+ * // };
64
+ *
50
65
  * ```
51
66
  *
52
67
  * @param TestInvokeMethodCommandInput - {@link TestInvokeMethodCommandInput}
@@ -67,6 +82,8 @@ export interface TestInvokeMethodCommandOutput extends TestInvokeMethodResponse,
67
82
  * @throws {@link UnauthorizedException} (client fault)
68
83
  * <p>The request is denied because the caller has insufficient permissions.</p>
69
84
  *
85
+ * @throws {@link APIGatewayServiceException}
86
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
70
87
  *
71
88
  */
72
89
  export declare class TestInvokeMethodCommand extends $Command<TestInvokeMethodCommandInput, TestInvokeMethodCommandOutput, APIGatewayClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
34
34
  * };
35
35
  * const command = new UntagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -60,6 +62,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
60
62
  * @throws {@link UnauthorizedException} (client fault)
61
63
  * <p>The request is denied because the caller has insufficient permissions.</p>
62
64
  *
65
+ * @throws {@link APIGatewayServiceException}
66
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
63
67
  *
64
68
  */
65
69
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, APIGatewayClientResolvedConfig> {
@@ -38,6 +38,18 @@ export interface UpdateAccountCommandOutput extends Account, __MetadataBearer {
38
38
  * };
39
39
  * const command = new UpdateAccountCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // Account
42
+ * // cloudwatchRoleArn: "STRING_VALUE",
43
+ * // throttleSettings: { // ThrottleSettings
44
+ * // burstLimit: Number("int"),
45
+ * // rateLimit: Number("double"),
46
+ * // },
47
+ * // features: [ // ListOfString
48
+ * // "STRING_VALUE",
49
+ * // ],
50
+ * // apiKeyVersion: "STRING_VALUE",
51
+ * // };
52
+ *
41
53
  * ```
42
54
  *
43
55
  * @param UpdateAccountCommandInput - {@link UpdateAccountCommandInput}
@@ -64,6 +76,8 @@ export interface UpdateAccountCommandOutput extends Account, __MetadataBearer {
64
76
  * @throws {@link UnauthorizedException} (client fault)
65
77
  * <p>The request is denied because the caller has insufficient permissions.</p>
66
78
  *
79
+ * @throws {@link APIGatewayServiceException}
80
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
67
81
  *
68
82
  */
69
83
  export declare class UpdateAccountCommand extends $Command<UpdateAccountCommandInput, UpdateAccountCommandOutput, APIGatewayClientResolvedConfig> {
@@ -39,6 +39,23 @@ export interface UpdateApiKeyCommandOutput extends ApiKey, __MetadataBearer {
39
39
  * };
40
40
  * const command = new UpdateApiKeyCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // ApiKey
43
+ * // id: "STRING_VALUE",
44
+ * // value: "STRING_VALUE",
45
+ * // name: "STRING_VALUE",
46
+ * // customerId: "STRING_VALUE",
47
+ * // description: "STRING_VALUE",
48
+ * // enabled: true || false,
49
+ * // createdDate: new Date("TIMESTAMP"),
50
+ * // lastUpdatedDate: new Date("TIMESTAMP"),
51
+ * // stageKeys: [ // ListOfString
52
+ * // "STRING_VALUE",
53
+ * // ],
54
+ * // tags: { // MapOfStringToString
55
+ * // "<keys>": "STRING_VALUE",
56
+ * // },
57
+ * // };
58
+ *
42
59
  * ```
43
60
  *
44
61
  * @param UpdateApiKeyCommandInput - {@link UpdateApiKeyCommandInput}
@@ -65,6 +82,8 @@ export interface UpdateApiKeyCommandOutput extends ApiKey, __MetadataBearer {
65
82
  * @throws {@link UnauthorizedException} (client fault)
66
83
  * <p>The request is denied because the caller has insufficient permissions.</p>
67
84
  *
85
+ * @throws {@link APIGatewayServiceException}
86
+ * <p>Base exception class for all service exceptions from APIGateway service.</p>
68
87
  *
69
88
  */
70
89
  export declare class UpdateApiKeyCommand extends $Command<UpdateApiKeyCommandInput, UpdateApiKeyCommandOutput, APIGatewayClientResolvedConfig> {