UNPKG

202 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class APIGateway extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: APIGateway.Types.ClientConfiguration)
13 config: Config & APIGateway.Types.ClientConfiguration;
14 /**
15 * Create an ApiKey resource. AWS CLI
16 */
17 createApiKey(params: APIGateway.Types.CreateApiKeyRequest, callback?: (err: AWSError, data: APIGateway.Types.ApiKey) => void): Request<APIGateway.Types.ApiKey, AWSError>;
18 /**
19 * Create an ApiKey resource. AWS CLI
20 */
21 createApiKey(callback?: (err: AWSError, data: APIGateway.Types.ApiKey) => void): Request<APIGateway.Types.ApiKey, AWSError>;
22 /**
23 * Adds a new Authorizer resource to an existing RestApi resource. AWS CLI
24 */
25 createAuthorizer(params: APIGateway.Types.CreateAuthorizerRequest, callback?: (err: AWSError, data: APIGateway.Types.Authorizer) => void): Request<APIGateway.Types.Authorizer, AWSError>;
26 /**
27 * Adds a new Authorizer resource to an existing RestApi resource. AWS CLI
28 */
29 createAuthorizer(callback?: (err: AWSError, data: APIGateway.Types.Authorizer) => void): Request<APIGateway.Types.Authorizer, AWSError>;
30 /**
31 * Creates a new BasePathMapping resource.
32 */
33 createBasePathMapping(params: APIGateway.Types.CreateBasePathMappingRequest, callback?: (err: AWSError, data: APIGateway.Types.BasePathMapping) => void): Request<APIGateway.Types.BasePathMapping, AWSError>;
34 /**
35 * Creates a new BasePathMapping resource.
36 */
37 createBasePathMapping(callback?: (err: AWSError, data: APIGateway.Types.BasePathMapping) => void): Request<APIGateway.Types.BasePathMapping, AWSError>;
38 /**
39 * Creates a Deployment resource, which makes a specified RestApi callable over the internet.
40 */
41 createDeployment(params: APIGateway.Types.CreateDeploymentRequest, callback?: (err: AWSError, data: APIGateway.Types.Deployment) => void): Request<APIGateway.Types.Deployment, AWSError>;
42 /**
43 * Creates a Deployment resource, which makes a specified RestApi callable over the internet.
44 */
45 createDeployment(callback?: (err: AWSError, data: APIGateway.Types.Deployment) => void): Request<APIGateway.Types.Deployment, AWSError>;
46 /**
47 *
48 */
49 createDocumentationPart(params: APIGateway.Types.CreateDocumentationPartRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationPart) => void): Request<APIGateway.Types.DocumentationPart, AWSError>;
50 /**
51 *
52 */
53 createDocumentationPart(callback?: (err: AWSError, data: APIGateway.Types.DocumentationPart) => void): Request<APIGateway.Types.DocumentationPart, AWSError>;
54 /**
55 *
56 */
57 createDocumentationVersion(params: APIGateway.Types.CreateDocumentationVersionRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersion) => void): Request<APIGateway.Types.DocumentationVersion, AWSError>;
58 /**
59 *
60 */
61 createDocumentationVersion(callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersion) => void): Request<APIGateway.Types.DocumentationVersion, AWSError>;
62 /**
63 * Creates a new domain name.
64 */
65 createDomainName(params: APIGateway.Types.CreateDomainNameRequest, callback?: (err: AWSError, data: APIGateway.Types.DomainName) => void): Request<APIGateway.Types.DomainName, AWSError>;
66 /**
67 * Creates a new domain name.
68 */
69 createDomainName(callback?: (err: AWSError, data: APIGateway.Types.DomainName) => void): Request<APIGateway.Types.DomainName, AWSError>;
70 /**
71 * Adds a new Model resource to an existing RestApi resource.
72 */
73 createModel(params: APIGateway.Types.CreateModelRequest, callback?: (err: AWSError, data: APIGateway.Types.Model) => void): Request<APIGateway.Types.Model, AWSError>;
74 /**
75 * Adds a new Model resource to an existing RestApi resource.
76 */
77 createModel(callback?: (err: AWSError, data: APIGateway.Types.Model) => void): Request<APIGateway.Types.Model, AWSError>;
78 /**
79 * Creates a ReqeustValidator of a given RestApi.
80 */
81 createRequestValidator(params: APIGateway.Types.CreateRequestValidatorRequest, callback?: (err: AWSError, data: APIGateway.Types.RequestValidator) => void): Request<APIGateway.Types.RequestValidator, AWSError>;
82 /**
83 * Creates a ReqeustValidator of a given RestApi.
84 */
85 createRequestValidator(callback?: (err: AWSError, data: APIGateway.Types.RequestValidator) => void): Request<APIGateway.Types.RequestValidator, AWSError>;
86 /**
87 * Creates a Resource resource.
88 */
89 createResource(params: APIGateway.Types.CreateResourceRequest, callback?: (err: AWSError, data: APIGateway.Types.Resource) => void): Request<APIGateway.Types.Resource, AWSError>;
90 /**
91 * Creates a Resource resource.
92 */
93 createResource(callback?: (err: AWSError, data: APIGateway.Types.Resource) => void): Request<APIGateway.Types.Resource, AWSError>;
94 /**
95 * Creates a new RestApi resource.
96 */
97 createRestApi(params: APIGateway.Types.CreateRestApiRequest, callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
98 /**
99 * Creates a new RestApi resource.
100 */
101 createRestApi(callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
102 /**
103 * Creates a new Stage resource that references a pre-existing Deployment for the API.
104 */
105 createStage(params: APIGateway.Types.CreateStageRequest, callback?: (err: AWSError, data: APIGateway.Types.Stage) => void): Request<APIGateway.Types.Stage, AWSError>;
106 /**
107 * Creates a new Stage resource that references a pre-existing Deployment for the API.
108 */
109 createStage(callback?: (err: AWSError, data: APIGateway.Types.Stage) => void): Request<APIGateway.Types.Stage, AWSError>;
110 /**
111 * Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
112 */
113 createUsagePlan(params: APIGateway.Types.CreateUsagePlanRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlan) => void): Request<APIGateway.Types.UsagePlan, AWSError>;
114 /**
115 * Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
116 */
117 createUsagePlan(callback?: (err: AWSError, data: APIGateway.Types.UsagePlan) => void): Request<APIGateway.Types.UsagePlan, AWSError>;
118 /**
119 * Creates a usage plan key for adding an existing API key to a usage plan.
120 */
121 createUsagePlanKey(params: APIGateway.Types.CreateUsagePlanKeyRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlanKey) => void): Request<APIGateway.Types.UsagePlanKey, AWSError>;
122 /**
123 * Creates a usage plan key for adding an existing API key to a usage plan.
124 */
125 createUsagePlanKey(callback?: (err: AWSError, data: APIGateway.Types.UsagePlanKey) => void): Request<APIGateway.Types.UsagePlanKey, AWSError>;
126 /**
127 * 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.
128 */
129 createVpcLink(params: APIGateway.Types.CreateVpcLinkRequest, callback?: (err: AWSError, data: APIGateway.Types.VpcLink) => void): Request<APIGateway.Types.VpcLink, AWSError>;
130 /**
131 * 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.
132 */
133 createVpcLink(callback?: (err: AWSError, data: APIGateway.Types.VpcLink) => void): Request<APIGateway.Types.VpcLink, AWSError>;
134 /**
135 * Deletes the ApiKey resource.
136 */
137 deleteApiKey(params: APIGateway.Types.DeleteApiKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
138 /**
139 * Deletes the ApiKey resource.
140 */
141 deleteApiKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
142 /**
143 * Deletes an existing Authorizer resource. AWS CLI
144 */
145 deleteAuthorizer(params: APIGateway.Types.DeleteAuthorizerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
146 /**
147 * Deletes an existing Authorizer resource. AWS CLI
148 */
149 deleteAuthorizer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
150 /**
151 * Deletes the BasePathMapping resource.
152 */
153 deleteBasePathMapping(params: APIGateway.Types.DeleteBasePathMappingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
154 /**
155 * Deletes the BasePathMapping resource.
156 */
157 deleteBasePathMapping(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
158 /**
159 * Deletes the ClientCertificate resource.
160 */
161 deleteClientCertificate(params: APIGateway.Types.DeleteClientCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
162 /**
163 * Deletes the ClientCertificate resource.
164 */
165 deleteClientCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
166 /**
167 * Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
168 */
169 deleteDeployment(params: APIGateway.Types.DeleteDeploymentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
170 /**
171 * Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
172 */
173 deleteDeployment(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
174 /**
175 *
176 */
177 deleteDocumentationPart(params: APIGateway.Types.DeleteDocumentationPartRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
178 /**
179 *
180 */
181 deleteDocumentationPart(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
182 /**
183 *
184 */
185 deleteDocumentationVersion(params: APIGateway.Types.DeleteDocumentationVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
186 /**
187 *
188 */
189 deleteDocumentationVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
190 /**
191 * Deletes the DomainName resource.
192 */
193 deleteDomainName(params: APIGateway.Types.DeleteDomainNameRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
194 /**
195 * Deletes the DomainName resource.
196 */
197 deleteDomainName(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
198 /**
199 * Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
200 */
201 deleteGatewayResponse(params: APIGateway.Types.DeleteGatewayResponseRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
202 /**
203 * Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
204 */
205 deleteGatewayResponse(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
206 /**
207 * Represents a delete integration.
208 */
209 deleteIntegration(params: APIGateway.Types.DeleteIntegrationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
210 /**
211 * Represents a delete integration.
212 */
213 deleteIntegration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
214 /**
215 * Represents a delete integration response.
216 */
217 deleteIntegrationResponse(params: APIGateway.Types.DeleteIntegrationResponseRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
218 /**
219 * Represents a delete integration response.
220 */
221 deleteIntegrationResponse(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
222 /**
223 * Deletes an existing Method resource.
224 */
225 deleteMethod(params: APIGateway.Types.DeleteMethodRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
226 /**
227 * Deletes an existing Method resource.
228 */
229 deleteMethod(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
230 /**
231 * Deletes an existing MethodResponse resource.
232 */
233 deleteMethodResponse(params: APIGateway.Types.DeleteMethodResponseRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
234 /**
235 * Deletes an existing MethodResponse resource.
236 */
237 deleteMethodResponse(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
238 /**
239 * Deletes a model.
240 */
241 deleteModel(params: APIGateway.Types.DeleteModelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
242 /**
243 * Deletes a model.
244 */
245 deleteModel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
246 /**
247 * Deletes a RequestValidator of a given RestApi.
248 */
249 deleteRequestValidator(params: APIGateway.Types.DeleteRequestValidatorRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
250 /**
251 * Deletes a RequestValidator of a given RestApi.
252 */
253 deleteRequestValidator(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
254 /**
255 * Deletes a Resource resource.
256 */
257 deleteResource(params: APIGateway.Types.DeleteResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
258 /**
259 * Deletes a Resource resource.
260 */
261 deleteResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
262 /**
263 * Deletes the specified API.
264 */
265 deleteRestApi(params: APIGateway.Types.DeleteRestApiRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
266 /**
267 * Deletes the specified API.
268 */
269 deleteRestApi(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
270 /**
271 * Deletes a Stage resource.
272 */
273 deleteStage(params: APIGateway.Types.DeleteStageRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
274 /**
275 * Deletes a Stage resource.
276 */
277 deleteStage(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
278 /**
279 * Deletes a usage plan of a given plan Id.
280 */
281 deleteUsagePlan(params: APIGateway.Types.DeleteUsagePlanRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
282 /**
283 * Deletes a usage plan of a given plan Id.
284 */
285 deleteUsagePlan(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
286 /**
287 * Deletes a usage plan key and remove the underlying API key from the associated usage plan.
288 */
289 deleteUsagePlanKey(params: APIGateway.Types.DeleteUsagePlanKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
290 /**
291 * Deletes a usage plan key and remove the underlying API key from the associated usage plan.
292 */
293 deleteUsagePlanKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
294 /**
295 * Deletes an existing VpcLink of a specified identifier.
296 */
297 deleteVpcLink(params: APIGateway.Types.DeleteVpcLinkRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
298 /**
299 * Deletes an existing VpcLink of a specified identifier.
300 */
301 deleteVpcLink(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
302 /**
303 * Flushes all authorizer cache entries on a stage.
304 */
305 flushStageAuthorizersCache(params: APIGateway.Types.FlushStageAuthorizersCacheRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
306 /**
307 * Flushes all authorizer cache entries on a stage.
308 */
309 flushStageAuthorizersCache(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
310 /**
311 * Flushes a stage's cache.
312 */
313 flushStageCache(params: APIGateway.Types.FlushStageCacheRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
314 /**
315 * Flushes a stage's cache.
316 */
317 flushStageCache(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
318 /**
319 * Generates a ClientCertificate resource.
320 */
321 generateClientCertificate(params: APIGateway.Types.GenerateClientCertificateRequest, callback?: (err: AWSError, data: APIGateway.Types.ClientCertificate) => void): Request<APIGateway.Types.ClientCertificate, AWSError>;
322 /**
323 * Generates a ClientCertificate resource.
324 */
325 generateClientCertificate(callback?: (err: AWSError, data: APIGateway.Types.ClientCertificate) => void): Request<APIGateway.Types.ClientCertificate, AWSError>;
326 /**
327 * Gets information about the current Account resource.
328 */
329 getAccount(params: APIGateway.Types.GetAccountRequest, callback?: (err: AWSError, data: APIGateway.Types.Account) => void): Request<APIGateway.Types.Account, AWSError>;
330 /**
331 * Gets information about the current Account resource.
332 */
333 getAccount(callback?: (err: AWSError, data: APIGateway.Types.Account) => void): Request<APIGateway.Types.Account, AWSError>;
334 /**
335 * Gets information about the current ApiKey resource.
336 */
337 getApiKey(params: APIGateway.Types.GetApiKeyRequest, callback?: (err: AWSError, data: APIGateway.Types.ApiKey) => void): Request<APIGateway.Types.ApiKey, AWSError>;
338 /**
339 * Gets information about the current ApiKey resource.
340 */
341 getApiKey(callback?: (err: AWSError, data: APIGateway.Types.ApiKey) => void): Request<APIGateway.Types.ApiKey, AWSError>;
342 /**
343 * Gets information about the current ApiKeys resource.
344 */
345 getApiKeys(params: APIGateway.Types.GetApiKeysRequest, callback?: (err: AWSError, data: APIGateway.Types.ApiKeys) => void): Request<APIGateway.Types.ApiKeys, AWSError>;
346 /**
347 * Gets information about the current ApiKeys resource.
348 */
349 getApiKeys(callback?: (err: AWSError, data: APIGateway.Types.ApiKeys) => void): Request<APIGateway.Types.ApiKeys, AWSError>;
350 /**
351 * Describe an existing Authorizer resource. AWS CLI
352 */
353 getAuthorizer(params: APIGateway.Types.GetAuthorizerRequest, callback?: (err: AWSError, data: APIGateway.Types.Authorizer) => void): Request<APIGateway.Types.Authorizer, AWSError>;
354 /**
355 * Describe an existing Authorizer resource. AWS CLI
356 */
357 getAuthorizer(callback?: (err: AWSError, data: APIGateway.Types.Authorizer) => void): Request<APIGateway.Types.Authorizer, AWSError>;
358 /**
359 * Describe an existing Authorizers resource. AWS CLI
360 */
361 getAuthorizers(params: APIGateway.Types.GetAuthorizersRequest, callback?: (err: AWSError, data: APIGateway.Types.Authorizers) => void): Request<APIGateway.Types.Authorizers, AWSError>;
362 /**
363 * Describe an existing Authorizers resource. AWS CLI
364 */
365 getAuthorizers(callback?: (err: AWSError, data: APIGateway.Types.Authorizers) => void): Request<APIGateway.Types.Authorizers, AWSError>;
366 /**
367 * Describe a BasePathMapping resource.
368 */
369 getBasePathMapping(params: APIGateway.Types.GetBasePathMappingRequest, callback?: (err: AWSError, data: APIGateway.Types.BasePathMapping) => void): Request<APIGateway.Types.BasePathMapping, AWSError>;
370 /**
371 * Describe a BasePathMapping resource.
372 */
373 getBasePathMapping(callback?: (err: AWSError, data: APIGateway.Types.BasePathMapping) => void): Request<APIGateway.Types.BasePathMapping, AWSError>;
374 /**
375 * Represents a collection of BasePathMapping resources.
376 */
377 getBasePathMappings(params: APIGateway.Types.GetBasePathMappingsRequest, callback?: (err: AWSError, data: APIGateway.Types.BasePathMappings) => void): Request<APIGateway.Types.BasePathMappings, AWSError>;
378 /**
379 * Represents a collection of BasePathMapping resources.
380 */
381 getBasePathMappings(callback?: (err: AWSError, data: APIGateway.Types.BasePathMappings) => void): Request<APIGateway.Types.BasePathMappings, AWSError>;
382 /**
383 * Gets information about the current ClientCertificate resource.
384 */
385 getClientCertificate(params: APIGateway.Types.GetClientCertificateRequest, callback?: (err: AWSError, data: APIGateway.Types.ClientCertificate) => void): Request<APIGateway.Types.ClientCertificate, AWSError>;
386 /**
387 * Gets information about the current ClientCertificate resource.
388 */
389 getClientCertificate(callback?: (err: AWSError, data: APIGateway.Types.ClientCertificate) => void): Request<APIGateway.Types.ClientCertificate, AWSError>;
390 /**
391 * Gets a collection of ClientCertificate resources.
392 */
393 getClientCertificates(params: APIGateway.Types.GetClientCertificatesRequest, callback?: (err: AWSError, data: APIGateway.Types.ClientCertificates) => void): Request<APIGateway.Types.ClientCertificates, AWSError>;
394 /**
395 * Gets a collection of ClientCertificate resources.
396 */
397 getClientCertificates(callback?: (err: AWSError, data: APIGateway.Types.ClientCertificates) => void): Request<APIGateway.Types.ClientCertificates, AWSError>;
398 /**
399 * Gets information about a Deployment resource.
400 */
401 getDeployment(params: APIGateway.Types.GetDeploymentRequest, callback?: (err: AWSError, data: APIGateway.Types.Deployment) => void): Request<APIGateway.Types.Deployment, AWSError>;
402 /**
403 * Gets information about a Deployment resource.
404 */
405 getDeployment(callback?: (err: AWSError, data: APIGateway.Types.Deployment) => void): Request<APIGateway.Types.Deployment, AWSError>;
406 /**
407 * Gets information about a Deployments collection.
408 */
409 getDeployments(params: APIGateway.Types.GetDeploymentsRequest, callback?: (err: AWSError, data: APIGateway.Types.Deployments) => void): Request<APIGateway.Types.Deployments, AWSError>;
410 /**
411 * Gets information about a Deployments collection.
412 */
413 getDeployments(callback?: (err: AWSError, data: APIGateway.Types.Deployments) => void): Request<APIGateway.Types.Deployments, AWSError>;
414 /**
415 *
416 */
417 getDocumentationPart(params: APIGateway.Types.GetDocumentationPartRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationPart) => void): Request<APIGateway.Types.DocumentationPart, AWSError>;
418 /**
419 *
420 */
421 getDocumentationPart(callback?: (err: AWSError, data: APIGateway.Types.DocumentationPart) => void): Request<APIGateway.Types.DocumentationPart, AWSError>;
422 /**
423 *
424 */
425 getDocumentationParts(params: APIGateway.Types.GetDocumentationPartsRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationParts) => void): Request<APIGateway.Types.DocumentationParts, AWSError>;
426 /**
427 *
428 */
429 getDocumentationParts(callback?: (err: AWSError, data: APIGateway.Types.DocumentationParts) => void): Request<APIGateway.Types.DocumentationParts, AWSError>;
430 /**
431 *
432 */
433 getDocumentationVersion(params: APIGateway.Types.GetDocumentationVersionRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersion) => void): Request<APIGateway.Types.DocumentationVersion, AWSError>;
434 /**
435 *
436 */
437 getDocumentationVersion(callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersion) => void): Request<APIGateway.Types.DocumentationVersion, AWSError>;
438 /**
439 *
440 */
441 getDocumentationVersions(params: APIGateway.Types.GetDocumentationVersionsRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersions) => void): Request<APIGateway.Types.DocumentationVersions, AWSError>;
442 /**
443 *
444 */
445 getDocumentationVersions(callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersions) => void): Request<APIGateway.Types.DocumentationVersions, AWSError>;
446 /**
447 * Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
448 */
449 getDomainName(params: APIGateway.Types.GetDomainNameRequest, callback?: (err: AWSError, data: APIGateway.Types.DomainName) => void): Request<APIGateway.Types.DomainName, AWSError>;
450 /**
451 * Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
452 */
453 getDomainName(callback?: (err: AWSError, data: APIGateway.Types.DomainName) => void): Request<APIGateway.Types.DomainName, AWSError>;
454 /**
455 * Represents a collection of DomainName resources.
456 */
457 getDomainNames(params: APIGateway.Types.GetDomainNamesRequest, callback?: (err: AWSError, data: APIGateway.Types.DomainNames) => void): Request<APIGateway.Types.DomainNames, AWSError>;
458 /**
459 * Represents a collection of DomainName resources.
460 */
461 getDomainNames(callback?: (err: AWSError, data: APIGateway.Types.DomainNames) => void): Request<APIGateway.Types.DomainNames, AWSError>;
462 /**
463 * Exports a deployed version of a RestApi in a specified format.
464 */
465 getExport(params: APIGateway.Types.GetExportRequest, callback?: (err: AWSError, data: APIGateway.Types.ExportResponse) => void): Request<APIGateway.Types.ExportResponse, AWSError>;
466 /**
467 * Exports a deployed version of a RestApi in a specified format.
468 */
469 getExport(callback?: (err: AWSError, data: APIGateway.Types.ExportResponse) => void): Request<APIGateway.Types.ExportResponse, AWSError>;
470 /**
471 * Gets a GatewayResponse of a specified response type on the given RestApi.
472 */
473 getGatewayResponse(params: APIGateway.Types.GetGatewayResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.GatewayResponse) => void): Request<APIGateway.Types.GatewayResponse, AWSError>;
474 /**
475 * Gets a GatewayResponse of a specified response type on the given RestApi.
476 */
477 getGatewayResponse(callback?: (err: AWSError, data: APIGateway.Types.GatewayResponse) => void): Request<APIGateway.Types.GatewayResponse, AWSError>;
478 /**
479 * Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
480 */
481 getGatewayResponses(params: APIGateway.Types.GetGatewayResponsesRequest, callback?: (err: AWSError, data: APIGateway.Types.GatewayResponses) => void): Request<APIGateway.Types.GatewayResponses, AWSError>;
482 /**
483 * Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
484 */
485 getGatewayResponses(callback?: (err: AWSError, data: APIGateway.Types.GatewayResponses) => void): Request<APIGateway.Types.GatewayResponses, AWSError>;
486 /**
487 * Get the integration settings.
488 */
489 getIntegration(params: APIGateway.Types.GetIntegrationRequest, callback?: (err: AWSError, data: APIGateway.Types.Integration) => void): Request<APIGateway.Types.Integration, AWSError>;
490 /**
491 * Get the integration settings.
492 */
493 getIntegration(callback?: (err: AWSError, data: APIGateway.Types.Integration) => void): Request<APIGateway.Types.Integration, AWSError>;
494 /**
495 * Represents a get integration response.
496 */
497 getIntegrationResponse(params: APIGateway.Types.GetIntegrationResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.IntegrationResponse) => void): Request<APIGateway.Types.IntegrationResponse, AWSError>;
498 /**
499 * Represents a get integration response.
500 */
501 getIntegrationResponse(callback?: (err: AWSError, data: APIGateway.Types.IntegrationResponse) => void): Request<APIGateway.Types.IntegrationResponse, AWSError>;
502 /**
503 * Describe an existing Method resource.
504 */
505 getMethod(params: APIGateway.Types.GetMethodRequest, callback?: (err: AWSError, data: APIGateway.Types.Method) => void): Request<APIGateway.Types.Method, AWSError>;
506 /**
507 * Describe an existing Method resource.
508 */
509 getMethod(callback?: (err: AWSError, data: APIGateway.Types.Method) => void): Request<APIGateway.Types.Method, AWSError>;
510 /**
511 * Describes a MethodResponse resource.
512 */
513 getMethodResponse(params: APIGateway.Types.GetMethodResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.MethodResponse) => void): Request<APIGateway.Types.MethodResponse, AWSError>;
514 /**
515 * Describes a MethodResponse resource.
516 */
517 getMethodResponse(callback?: (err: AWSError, data: APIGateway.Types.MethodResponse) => void): Request<APIGateway.Types.MethodResponse, AWSError>;
518 /**
519 * Describes an existing model defined for a RestApi resource.
520 */
521 getModel(params: APIGateway.Types.GetModelRequest, callback?: (err: AWSError, data: APIGateway.Types.Model) => void): Request<APIGateway.Types.Model, AWSError>;
522 /**
523 * Describes an existing model defined for a RestApi resource.
524 */
525 getModel(callback?: (err: AWSError, data: APIGateway.Types.Model) => void): Request<APIGateway.Types.Model, AWSError>;
526 /**
527 * Generates a sample mapping template that can be used to transform a payload into the structure of a model.
528 */
529 getModelTemplate(params: APIGateway.Types.GetModelTemplateRequest, callback?: (err: AWSError, data: APIGateway.Types.Template) => void): Request<APIGateway.Types.Template, AWSError>;
530 /**
531 * Generates a sample mapping template that can be used to transform a payload into the structure of a model.
532 */
533 getModelTemplate(callback?: (err: AWSError, data: APIGateway.Types.Template) => void): Request<APIGateway.Types.Template, AWSError>;
534 /**
535 * Describes existing Models defined for a RestApi resource.
536 */
537 getModels(params: APIGateway.Types.GetModelsRequest, callback?: (err: AWSError, data: APIGateway.Types.Models) => void): Request<APIGateway.Types.Models, AWSError>;
538 /**
539 * Describes existing Models defined for a RestApi resource.
540 */
541 getModels(callback?: (err: AWSError, data: APIGateway.Types.Models) => void): Request<APIGateway.Types.Models, AWSError>;
542 /**
543 * Gets a RequestValidator of a given RestApi.
544 */
545 getRequestValidator(params: APIGateway.Types.GetRequestValidatorRequest, callback?: (err: AWSError, data: APIGateway.Types.RequestValidator) => void): Request<APIGateway.Types.RequestValidator, AWSError>;
546 /**
547 * Gets a RequestValidator of a given RestApi.
548 */
549 getRequestValidator(callback?: (err: AWSError, data: APIGateway.Types.RequestValidator) => void): Request<APIGateway.Types.RequestValidator, AWSError>;
550 /**
551 * Gets the RequestValidators collection of a given RestApi.
552 */
553 getRequestValidators(params: APIGateway.Types.GetRequestValidatorsRequest, callback?: (err: AWSError, data: APIGateway.Types.RequestValidators) => void): Request<APIGateway.Types.RequestValidators, AWSError>;
554 /**
555 * Gets the RequestValidators collection of a given RestApi.
556 */
557 getRequestValidators(callback?: (err: AWSError, data: APIGateway.Types.RequestValidators) => void): Request<APIGateway.Types.RequestValidators, AWSError>;
558 /**
559 * Lists information about a resource.
560 */
561 getResource(params: APIGateway.Types.GetResourceRequest, callback?: (err: AWSError, data: APIGateway.Types.Resource) => void): Request<APIGateway.Types.Resource, AWSError>;
562 /**
563 * Lists information about a resource.
564 */
565 getResource(callback?: (err: AWSError, data: APIGateway.Types.Resource) => void): Request<APIGateway.Types.Resource, AWSError>;
566 /**
567 * Lists information about a collection of Resource resources.
568 */
569 getResources(params: APIGateway.Types.GetResourcesRequest, callback?: (err: AWSError, data: APIGateway.Types.Resources) => void): Request<APIGateway.Types.Resources, AWSError>;
570 /**
571 * Lists information about a collection of Resource resources.
572 */
573 getResources(callback?: (err: AWSError, data: APIGateway.Types.Resources) => void): Request<APIGateway.Types.Resources, AWSError>;
574 /**
575 * Lists the RestApi resource in the collection.
576 */
577 getRestApi(params: APIGateway.Types.GetRestApiRequest, callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
578 /**
579 * Lists the RestApi resource in the collection.
580 */
581 getRestApi(callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
582 /**
583 * Lists the RestApis resources for your collection.
584 */
585 getRestApis(params: APIGateway.Types.GetRestApisRequest, callback?: (err: AWSError, data: APIGateway.Types.RestApis) => void): Request<APIGateway.Types.RestApis, AWSError>;
586 /**
587 * Lists the RestApis resources for your collection.
588 */
589 getRestApis(callback?: (err: AWSError, data: APIGateway.Types.RestApis) => void): Request<APIGateway.Types.RestApis, AWSError>;
590 /**
591 * Generates a client SDK for a RestApi and Stage.
592 */
593 getSdk(params: APIGateway.Types.GetSdkRequest, callback?: (err: AWSError, data: APIGateway.Types.SdkResponse) => void): Request<APIGateway.Types.SdkResponse, AWSError>;
594 /**
595 * Generates a client SDK for a RestApi and Stage.
596 */
597 getSdk(callback?: (err: AWSError, data: APIGateway.Types.SdkResponse) => void): Request<APIGateway.Types.SdkResponse, AWSError>;
598 /**
599 *
600 */
601 getSdkType(params: APIGateway.Types.GetSdkTypeRequest, callback?: (err: AWSError, data: APIGateway.Types.SdkType) => void): Request<APIGateway.Types.SdkType, AWSError>;
602 /**
603 *
604 */
605 getSdkType(callback?: (err: AWSError, data: APIGateway.Types.SdkType) => void): Request<APIGateway.Types.SdkType, AWSError>;
606 /**
607 *
608 */
609 getSdkTypes(params: APIGateway.Types.GetSdkTypesRequest, callback?: (err: AWSError, data: APIGateway.Types.SdkTypes) => void): Request<APIGateway.Types.SdkTypes, AWSError>;
610 /**
611 *
612 */
613 getSdkTypes(callback?: (err: AWSError, data: APIGateway.Types.SdkTypes) => void): Request<APIGateway.Types.SdkTypes, AWSError>;
614 /**
615 * Gets information about a Stage resource.
616 */
617 getStage(params: APIGateway.Types.GetStageRequest, callback?: (err: AWSError, data: APIGateway.Types.Stage) => void): Request<APIGateway.Types.Stage, AWSError>;
618 /**
619 * Gets information about a Stage resource.
620 */
621 getStage(callback?: (err: AWSError, data: APIGateway.Types.Stage) => void): Request<APIGateway.Types.Stage, AWSError>;
622 /**
623 * Gets information about one or more Stage resources.
624 */
625 getStages(params: APIGateway.Types.GetStagesRequest, callback?: (err: AWSError, data: APIGateway.Types.Stages) => void): Request<APIGateway.Types.Stages, AWSError>;
626 /**
627 * Gets information about one or more Stage resources.
628 */
629 getStages(callback?: (err: AWSError, data: APIGateway.Types.Stages) => void): Request<APIGateway.Types.Stages, AWSError>;
630 /**
631 * Gets the Tags collection for a given resource.
632 */
633 getTags(params: APIGateway.Types.GetTagsRequest, callback?: (err: AWSError, data: APIGateway.Types.Tags) => void): Request<APIGateway.Types.Tags, AWSError>;
634 /**
635 * Gets the Tags collection for a given resource.
636 */
637 getTags(callback?: (err: AWSError, data: APIGateway.Types.Tags) => void): Request<APIGateway.Types.Tags, AWSError>;
638 /**
639 * Gets the usage data of a usage plan in a specified time interval.
640 */
641 getUsage(params: APIGateway.Types.GetUsageRequest, callback?: (err: AWSError, data: APIGateway.Types.Usage) => void): Request<APIGateway.Types.Usage, AWSError>;
642 /**
643 * Gets the usage data of a usage plan in a specified time interval.
644 */
645 getUsage(callback?: (err: AWSError, data: APIGateway.Types.Usage) => void): Request<APIGateway.Types.Usage, AWSError>;
646 /**
647 * Gets a usage plan of a given plan identifier.
648 */
649 getUsagePlan(params: APIGateway.Types.GetUsagePlanRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlan) => void): Request<APIGateway.Types.UsagePlan, AWSError>;
650 /**
651 * Gets a usage plan of a given plan identifier.
652 */
653 getUsagePlan(callback?: (err: AWSError, data: APIGateway.Types.UsagePlan) => void): Request<APIGateway.Types.UsagePlan, AWSError>;
654 /**
655 * Gets a usage plan key of a given key identifier.
656 */
657 getUsagePlanKey(params: APIGateway.Types.GetUsagePlanKeyRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlanKey) => void): Request<APIGateway.Types.UsagePlanKey, AWSError>;
658 /**
659 * Gets a usage plan key of a given key identifier.
660 */
661 getUsagePlanKey(callback?: (err: AWSError, data: APIGateway.Types.UsagePlanKey) => void): Request<APIGateway.Types.UsagePlanKey, AWSError>;
662 /**
663 * Gets all the usage plan keys representing the API keys added to a specified usage plan.
664 */
665 getUsagePlanKeys(params: APIGateway.Types.GetUsagePlanKeysRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlanKeys) => void): Request<APIGateway.Types.UsagePlanKeys, AWSError>;
666 /**
667 * Gets all the usage plan keys representing the API keys added to a specified usage plan.
668 */
669 getUsagePlanKeys(callback?: (err: AWSError, data: APIGateway.Types.UsagePlanKeys) => void): Request<APIGateway.Types.UsagePlanKeys, AWSError>;
670 /**
671 * Gets all the usage plans of the caller's account.
672 */
673 getUsagePlans(params: APIGateway.Types.GetUsagePlansRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlans) => void): Request<APIGateway.Types.UsagePlans, AWSError>;
674 /**
675 * Gets all the usage plans of the caller's account.
676 */
677 getUsagePlans(callback?: (err: AWSError, data: APIGateway.Types.UsagePlans) => void): Request<APIGateway.Types.UsagePlans, AWSError>;
678 /**
679 * Gets a specified VPC link under the caller's account in a region.
680 */
681 getVpcLink(params: APIGateway.Types.GetVpcLinkRequest, callback?: (err: AWSError, data: APIGateway.Types.VpcLink) => void): Request<APIGateway.Types.VpcLink, AWSError>;
682 /**
683 * Gets a specified VPC link under the caller's account in a region.
684 */
685 getVpcLink(callback?: (err: AWSError, data: APIGateway.Types.VpcLink) => void): Request<APIGateway.Types.VpcLink, AWSError>;
686 /**
687 * Gets the VpcLinks collection under the caller's account in a selected region.
688 */
689 getVpcLinks(params: APIGateway.Types.GetVpcLinksRequest, callback?: (err: AWSError, data: APIGateway.Types.VpcLinks) => void): Request<APIGateway.Types.VpcLinks, AWSError>;
690 /**
691 * Gets the VpcLinks collection under the caller's account in a selected region.
692 */
693 getVpcLinks(callback?: (err: AWSError, data: APIGateway.Types.VpcLinks) => void): Request<APIGateway.Types.VpcLinks, AWSError>;
694 /**
695 * Import API keys from an external source, such as a CSV-formatted file.
696 */
697 importApiKeys(params: APIGateway.Types.ImportApiKeysRequest, callback?: (err: AWSError, data: APIGateway.Types.ApiKeyIds) => void): Request<APIGateway.Types.ApiKeyIds, AWSError>;
698 /**
699 * Import API keys from an external source, such as a CSV-formatted file.
700 */
701 importApiKeys(callback?: (err: AWSError, data: APIGateway.Types.ApiKeyIds) => void): Request<APIGateway.Types.ApiKeyIds, AWSError>;
702 /**
703 *
704 */
705 importDocumentationParts(params: APIGateway.Types.ImportDocumentationPartsRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationPartIds) => void): Request<APIGateway.Types.DocumentationPartIds, AWSError>;
706 /**
707 *
708 */
709 importDocumentationParts(callback?: (err: AWSError, data: APIGateway.Types.DocumentationPartIds) => void): Request<APIGateway.Types.DocumentationPartIds, AWSError>;
710 /**
711 * A feature of the API Gateway control service for creating a new API from an external API definition file.
712 */
713 importRestApi(params: APIGateway.Types.ImportRestApiRequest, callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
714 /**
715 * A feature of the API Gateway control service for creating a new API from an external API definition file.
716 */
717 importRestApi(callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
718 /**
719 * Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
720 */
721 putGatewayResponse(params: APIGateway.Types.PutGatewayResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.GatewayResponse) => void): Request<APIGateway.Types.GatewayResponse, AWSError>;
722 /**
723 * Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
724 */
725 putGatewayResponse(callback?: (err: AWSError, data: APIGateway.Types.GatewayResponse) => void): Request<APIGateway.Types.GatewayResponse, AWSError>;
726 /**
727 * Sets up a method's integration.
728 */
729 putIntegration(params: APIGateway.Types.PutIntegrationRequest, callback?: (err: AWSError, data: APIGateway.Types.Integration) => void): Request<APIGateway.Types.Integration, AWSError>;
730 /**
731 * Sets up a method's integration.
732 */
733 putIntegration(callback?: (err: AWSError, data: APIGateway.Types.Integration) => void): Request<APIGateway.Types.Integration, AWSError>;
734 /**
735 * Represents a put integration.
736 */
737 putIntegrationResponse(params: APIGateway.Types.PutIntegrationResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.IntegrationResponse) => void): Request<APIGateway.Types.IntegrationResponse, AWSError>;
738 /**
739 * Represents a put integration.
740 */
741 putIntegrationResponse(callback?: (err: AWSError, data: APIGateway.Types.IntegrationResponse) => void): Request<APIGateway.Types.IntegrationResponse, AWSError>;
742 /**
743 * Add a method to an existing Resource resource.
744 */
745 putMethod(params: APIGateway.Types.PutMethodRequest, callback?: (err: AWSError, data: APIGateway.Types.Method) => void): Request<APIGateway.Types.Method, AWSError>;
746 /**
747 * Add a method to an existing Resource resource.
748 */
749 putMethod(callback?: (err: AWSError, data: APIGateway.Types.Method) => void): Request<APIGateway.Types.Method, AWSError>;
750 /**
751 * Adds a MethodResponse to an existing Method resource.
752 */
753 putMethodResponse(params: APIGateway.Types.PutMethodResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.MethodResponse) => void): Request<APIGateway.Types.MethodResponse, AWSError>;
754 /**
755 * Adds a MethodResponse to an existing Method resource.
756 */
757 putMethodResponse(callback?: (err: AWSError, data: APIGateway.Types.MethodResponse) => void): Request<APIGateway.Types.MethodResponse, AWSError>;
758 /**
759 * A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
760 */
761 putRestApi(params: APIGateway.Types.PutRestApiRequest, callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
762 /**
763 * A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
764 */
765 putRestApi(callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
766 /**
767 * Adds or updates a tag on a given resource.
768 */
769 tagResource(params: APIGateway.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
770 /**
771 * Adds or updates a tag on a given resource.
772 */
773 tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
774 /**
775 * Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body. Use Lambda Function as Authorizer Use Cognito User Pool as Authorizer
776 */
777 testInvokeAuthorizer(params: APIGateway.Types.TestInvokeAuthorizerRequest, callback?: (err: AWSError, data: APIGateway.Types.TestInvokeAuthorizerResponse) => void): Request<APIGateway.Types.TestInvokeAuthorizerResponse, AWSError>;
778 /**
779 * Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body. Use Lambda Function as Authorizer Use Cognito User Pool as Authorizer
780 */
781 testInvokeAuthorizer(callback?: (err: AWSError, data: APIGateway.Types.TestInvokeAuthorizerResponse) => void): Request<APIGateway.Types.TestInvokeAuthorizerResponse, AWSError>;
782 /**
783 * Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
784 */
785 testInvokeMethod(params: APIGateway.Types.TestInvokeMethodRequest, callback?: (err: AWSError, data: APIGateway.Types.TestInvokeMethodResponse) => void): Request<APIGateway.Types.TestInvokeMethodResponse, AWSError>;
786 /**
787 * Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
788 */
789 testInvokeMethod(callback?: (err: AWSError, data: APIGateway.Types.TestInvokeMethodResponse) => void): Request<APIGateway.Types.TestInvokeMethodResponse, AWSError>;
790 /**
791 * Removes a tag from a given resource.
792 */
793 untagResource(params: APIGateway.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
794 /**
795 * Removes a tag from a given resource.
796 */
797 untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
798 /**
799 * Changes information about the current Account resource.
800 */
801 updateAccount(params: APIGateway.Types.UpdateAccountRequest, callback?: (err: AWSError, data: APIGateway.Types.Account) => void): Request<APIGateway.Types.Account, AWSError>;
802 /**
803 * Changes information about the current Account resource.
804 */
805 updateAccount(callback?: (err: AWSError, data: APIGateway.Types.Account) => void): Request<APIGateway.Types.Account, AWSError>;
806 /**
807 * Changes information about an ApiKey resource.
808 */
809 updateApiKey(params: APIGateway.Types.UpdateApiKeyRequest, callback?: (err: AWSError, data: APIGateway.Types.ApiKey) => void): Request<APIGateway.Types.ApiKey, AWSError>;
810 /**
811 * Changes information about an ApiKey resource.
812 */
813 updateApiKey(callback?: (err: AWSError, data: APIGateway.Types.ApiKey) => void): Request<APIGateway.Types.ApiKey, AWSError>;
814 /**
815 * Updates an existing Authorizer resource. AWS CLI
816 */
817 updateAuthorizer(params: APIGateway.Types.UpdateAuthorizerRequest, callback?: (err: AWSError, data: APIGateway.Types.Authorizer) => void): Request<APIGateway.Types.Authorizer, AWSError>;
818 /**
819 * Updates an existing Authorizer resource. AWS CLI
820 */
821 updateAuthorizer(callback?: (err: AWSError, data: APIGateway.Types.Authorizer) => void): Request<APIGateway.Types.Authorizer, AWSError>;
822 /**
823 * Changes information about the BasePathMapping resource.
824 */
825 updateBasePathMapping(params: APIGateway.Types.UpdateBasePathMappingRequest, callback?: (err: AWSError, data: APIGateway.Types.BasePathMapping) => void): Request<APIGateway.Types.BasePathMapping, AWSError>;
826 /**
827 * Changes information about the BasePathMapping resource.
828 */
829 updateBasePathMapping(callback?: (err: AWSError, data: APIGateway.Types.BasePathMapping) => void): Request<APIGateway.Types.BasePathMapping, AWSError>;
830 /**
831 * Changes information about an ClientCertificate resource.
832 */
833 updateClientCertificate(params: APIGateway.Types.UpdateClientCertificateRequest, callback?: (err: AWSError, data: APIGateway.Types.ClientCertificate) => void): Request<APIGateway.Types.ClientCertificate, AWSError>;
834 /**
835 * Changes information about an ClientCertificate resource.
836 */
837 updateClientCertificate(callback?: (err: AWSError, data: APIGateway.Types.ClientCertificate) => void): Request<APIGateway.Types.ClientCertificate, AWSError>;
838 /**
839 * Changes information about a Deployment resource.
840 */
841 updateDeployment(params: APIGateway.Types.UpdateDeploymentRequest, callback?: (err: AWSError, data: APIGateway.Types.Deployment) => void): Request<APIGateway.Types.Deployment, AWSError>;
842 /**
843 * Changes information about a Deployment resource.
844 */
845 updateDeployment(callback?: (err: AWSError, data: APIGateway.Types.Deployment) => void): Request<APIGateway.Types.Deployment, AWSError>;
846 /**
847 *
848 */
849 updateDocumentationPart(params: APIGateway.Types.UpdateDocumentationPartRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationPart) => void): Request<APIGateway.Types.DocumentationPart, AWSError>;
850 /**
851 *
852 */
853 updateDocumentationPart(callback?: (err: AWSError, data: APIGateway.Types.DocumentationPart) => void): Request<APIGateway.Types.DocumentationPart, AWSError>;
854 /**
855 *
856 */
857 updateDocumentationVersion(params: APIGateway.Types.UpdateDocumentationVersionRequest, callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersion) => void): Request<APIGateway.Types.DocumentationVersion, AWSError>;
858 /**
859 *
860 */
861 updateDocumentationVersion(callback?: (err: AWSError, data: APIGateway.Types.DocumentationVersion) => void): Request<APIGateway.Types.DocumentationVersion, AWSError>;
862 /**
863 * Changes information about the DomainName resource.
864 */
865 updateDomainName(params: APIGateway.Types.UpdateDomainNameRequest, callback?: (err: AWSError, data: APIGateway.Types.DomainName) => void): Request<APIGateway.Types.DomainName, AWSError>;
866 /**
867 * Changes information about the DomainName resource.
868 */
869 updateDomainName(callback?: (err: AWSError, data: APIGateway.Types.DomainName) => void): Request<APIGateway.Types.DomainName, AWSError>;
870 /**
871 * Updates a GatewayResponse of a specified response type on the given RestApi.
872 */
873 updateGatewayResponse(params: APIGateway.Types.UpdateGatewayResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.GatewayResponse) => void): Request<APIGateway.Types.GatewayResponse, AWSError>;
874 /**
875 * Updates a GatewayResponse of a specified response type on the given RestApi.
876 */
877 updateGatewayResponse(callback?: (err: AWSError, data: APIGateway.Types.GatewayResponse) => void): Request<APIGateway.Types.GatewayResponse, AWSError>;
878 /**
879 * Represents an update integration.
880 */
881 updateIntegration(params: APIGateway.Types.UpdateIntegrationRequest, callback?: (err: AWSError, data: APIGateway.Types.Integration) => void): Request<APIGateway.Types.Integration, AWSError>;
882 /**
883 * Represents an update integration.
884 */
885 updateIntegration(callback?: (err: AWSError, data: APIGateway.Types.Integration) => void): Request<APIGateway.Types.Integration, AWSError>;
886 /**
887 * Represents an update integration response.
888 */
889 updateIntegrationResponse(params: APIGateway.Types.UpdateIntegrationResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.IntegrationResponse) => void): Request<APIGateway.Types.IntegrationResponse, AWSError>;
890 /**
891 * Represents an update integration response.
892 */
893 updateIntegrationResponse(callback?: (err: AWSError, data: APIGateway.Types.IntegrationResponse) => void): Request<APIGateway.Types.IntegrationResponse, AWSError>;
894 /**
895 * Updates an existing Method resource.
896 */
897 updateMethod(params: APIGateway.Types.UpdateMethodRequest, callback?: (err: AWSError, data: APIGateway.Types.Method) => void): Request<APIGateway.Types.Method, AWSError>;
898 /**
899 * Updates an existing Method resource.
900 */
901 updateMethod(callback?: (err: AWSError, data: APIGateway.Types.Method) => void): Request<APIGateway.Types.Method, AWSError>;
902 /**
903 * Updates an existing MethodResponse resource.
904 */
905 updateMethodResponse(params: APIGateway.Types.UpdateMethodResponseRequest, callback?: (err: AWSError, data: APIGateway.Types.MethodResponse) => void): Request<APIGateway.Types.MethodResponse, AWSError>;
906 /**
907 * Updates an existing MethodResponse resource.
908 */
909 updateMethodResponse(callback?: (err: AWSError, data: APIGateway.Types.MethodResponse) => void): Request<APIGateway.Types.MethodResponse, AWSError>;
910 /**
911 * Changes information about a model.
912 */
913 updateModel(params: APIGateway.Types.UpdateModelRequest, callback?: (err: AWSError, data: APIGateway.Types.Model) => void): Request<APIGateway.Types.Model, AWSError>;
914 /**
915 * Changes information about a model.
916 */
917 updateModel(callback?: (err: AWSError, data: APIGateway.Types.Model) => void): Request<APIGateway.Types.Model, AWSError>;
918 /**
919 * Updates a RequestValidator of a given RestApi.
920 */
921 updateRequestValidator(params: APIGateway.Types.UpdateRequestValidatorRequest, callback?: (err: AWSError, data: APIGateway.Types.RequestValidator) => void): Request<APIGateway.Types.RequestValidator, AWSError>;
922 /**
923 * Updates a RequestValidator of a given RestApi.
924 */
925 updateRequestValidator(callback?: (err: AWSError, data: APIGateway.Types.RequestValidator) => void): Request<APIGateway.Types.RequestValidator, AWSError>;
926 /**
927 * Changes information about a Resource resource.
928 */
929 updateResource(params: APIGateway.Types.UpdateResourceRequest, callback?: (err: AWSError, data: APIGateway.Types.Resource) => void): Request<APIGateway.Types.Resource, AWSError>;
930 /**
931 * Changes information about a Resource resource.
932 */
933 updateResource(callback?: (err: AWSError, data: APIGateway.Types.Resource) => void): Request<APIGateway.Types.Resource, AWSError>;
934 /**
935 * Changes information about the specified API.
936 */
937 updateRestApi(params: APIGateway.Types.UpdateRestApiRequest, callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
938 /**
939 * Changes information about the specified API.
940 */
941 updateRestApi(callback?: (err: AWSError, data: APIGateway.Types.RestApi) => void): Request<APIGateway.Types.RestApi, AWSError>;
942 /**
943 * Changes information about a Stage resource.
944 */
945 updateStage(params: APIGateway.Types.UpdateStageRequest, callback?: (err: AWSError, data: APIGateway.Types.Stage) => void): Request<APIGateway.Types.Stage, AWSError>;
946 /**
947 * Changes information about a Stage resource.
948 */
949 updateStage(callback?: (err: AWSError, data: APIGateway.Types.Stage) => void): Request<APIGateway.Types.Stage, AWSError>;
950 /**
951 * Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
952 */
953 updateUsage(params: APIGateway.Types.UpdateUsageRequest, callback?: (err: AWSError, data: APIGateway.Types.Usage) => void): Request<APIGateway.Types.Usage, AWSError>;
954 /**
955 * Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
956 */
957 updateUsage(callback?: (err: AWSError, data: APIGateway.Types.Usage) => void): Request<APIGateway.Types.Usage, AWSError>;
958 /**
959 * Updates a usage plan of a given plan Id.
960 */
961 updateUsagePlan(params: APIGateway.Types.UpdateUsagePlanRequest, callback?: (err: AWSError, data: APIGateway.Types.UsagePlan) => void): Request<APIGateway.Types.UsagePlan, AWSError>;
962 /**
963 * Updates a usage plan of a given plan Id.
964 */
965 updateUsagePlan(callback?: (err: AWSError, data: APIGateway.Types.UsagePlan) => void): Request<APIGateway.Types.UsagePlan, AWSError>;
966 /**
967 * Updates an existing VpcLink of a specified identifier.
968 */
969 updateVpcLink(params: APIGateway.Types.UpdateVpcLinkRequest, callback?: (err: AWSError, data: APIGateway.Types.VpcLink) => void): Request<APIGateway.Types.VpcLink, AWSError>;
970 /**
971 * Updates an existing VpcLink of a specified identifier.
972 */
973 updateVpcLink(callback?: (err: AWSError, data: APIGateway.Types.VpcLink) => void): Request<APIGateway.Types.VpcLink, AWSError>;
974}
975declare namespace APIGateway {
976 export interface AccessLogSettings {
977 /**
978 * A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
979 */
980 format?: String;
981 /**
982 * The ARN of the CloudWatch Logs log group to receive access logs.
983 */
984 destinationArn?: String;
985 }
986 export interface Account {
987 /**
988 * The ARN of an Amazon CloudWatch role for the current Account.
989 */
990 cloudwatchRoleArn?: String;
991 /**
992 * Specifies the API request limits configured for the current Account.
993 */
994 throttleSettings?: ThrottleSettings;
995 /**
996 * A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans".
997 */
998 features?: ListOfString;
999 /**
1000 * The version of the API keys used for the account.
1001 */
1002 apiKeyVersion?: String;
1003 }
1004 export interface ApiKey {
1005 /**
1006 * The identifier of the API Key.
1007 */
1008 id?: String;
1009 /**
1010 * The value of the API Key.
1011 */
1012 value?: String;
1013 /**
1014 * The name of the API Key.
1015 */
1016 name?: String;
1017 /**
1018 * An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
1019 */
1020 customerId?: String;
1021 /**
1022 * The description of the API Key.
1023 */
1024 description?: String;
1025 /**
1026 * Specifies whether the API Key can be used by callers.
1027 */
1028 enabled?: Boolean;
1029 /**
1030 * The timestamp when the API Key was created.
1031 */
1032 createdDate?: Timestamp;
1033 /**
1034 * The timestamp when the API Key was last updated.
1035 */
1036 lastUpdatedDate?: Timestamp;
1037 /**
1038 * A list of Stage resources that are associated with the ApiKey resource.
1039 */
1040 stageKeys?: ListOfString;
1041 /**
1042 * The collection of tags. Each tag element is associated with a given resource.
1043 */
1044 tags?: MapOfStringToString;
1045 }
1046 export interface ApiKeyIds {
1047 /**
1048 * A list of all the ApiKey identifiers.
1049 */
1050 ids?: ListOfString;
1051 /**
1052 * A list of warning messages.
1053 */
1054 warnings?: ListOfString;
1055 }
1056 export type ApiKeySourceType = "HEADER"|"AUTHORIZER"|string;
1057 export interface ApiKeys {
1058 /**
1059 * A list of warning messages logged during the import of API keys when the failOnWarnings option is set to true.
1060 */
1061 warnings?: ListOfString;
1062 position?: String;
1063 /**
1064 * The current page of elements from this collection.
1065 */
1066 items?: ListOfApiKey;
1067 }
1068 export type ApiKeysFormat = "csv"|string;
1069 export interface ApiStage {
1070 /**
1071 * API Id of the associated API stage in a usage plan.
1072 */
1073 apiId?: String;
1074 /**
1075 * API stage name of the associated API stage in a usage plan.
1076 */
1077 stage?: String;
1078 /**
1079 * Map containing method level throttling information for API stage in a usage plan.
1080 */
1081 throttle?: MapOfApiStageThrottleSettings;
1082 }
1083 export interface Authorizer {
1084 /**
1085 * The identifier for the authorizer resource.
1086 */
1087 id?: String;
1088 /**
1089 * [Required] The name of the authorizer.
1090 */
1091 name?: String;
1092 /**
1093 * The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
1094 */
1095 type?: AuthorizerType;
1096 /**
1097 * A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
1098 */
1099 providerARNs?: ListOfARNs;
1100 /**
1101 * Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
1102 */
1103 authType?: String;
1104 /**
1105 * Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
1106 */
1107 authorizerUri?: String;
1108 /**
1109 * Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
1110 */
1111 authorizerCredentials?: String;
1112 /**
1113 * The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
1114 */
1115 identitySource?: String;
1116 /**
1117 * A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
1118 */
1119 identityValidationExpression?: String;
1120 /**
1121 * The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
1122 */
1123 authorizerResultTtlInSeconds?: NullableInteger;
1124 }
1125 export type AuthorizerType = "TOKEN"|"REQUEST"|"COGNITO_USER_POOLS"|string;
1126 export interface Authorizers {
1127 position?: String;
1128 /**
1129 * The current page of elements from this collection.
1130 */
1131 items?: ListOfAuthorizer;
1132 }
1133 export interface BasePathMapping {
1134 /**
1135 * The base path name that callers of the API must provide as part of the URL after the domain name.
1136 */
1137 basePath?: String;
1138 /**
1139 * The string identifier of the associated RestApi.
1140 */
1141 restApiId?: String;
1142 /**
1143 * The name of the associated stage.
1144 */
1145 stage?: String;
1146 }
1147 export interface BasePathMappings {
1148 position?: String;
1149 /**
1150 * The current page of elements from this collection.
1151 */
1152 items?: ListOfBasePathMapping;
1153 }
1154 export type _Blob = Buffer|Uint8Array|Blob|string;
1155 export type Boolean = boolean;
1156 export type CacheClusterSize = "0.5"|"1.6"|"6.1"|"13.5"|"28.4"|"58.2"|"118"|"237"|string;
1157 export type CacheClusterStatus = "CREATE_IN_PROGRESS"|"AVAILABLE"|"DELETE_IN_PROGRESS"|"NOT_AVAILABLE"|"FLUSH_IN_PROGRESS"|string;
1158 export interface CanarySettings {
1159 /**
1160 * The percent (0-100) of traffic diverted to a canary deployment.
1161 */
1162 percentTraffic?: Double;
1163 /**
1164 * The ID of the canary deployment.
1165 */
1166 deploymentId?: String;
1167 /**
1168 * Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
1169 */
1170 stageVariableOverrides?: MapOfStringToString;
1171 /**
1172 * A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
1173 */
1174 useStageCache?: Boolean;
1175 }
1176 export interface ClientCertificate {
1177 /**
1178 * The identifier of the client certificate.
1179 */
1180 clientCertificateId?: String;
1181 /**
1182 * The description of the client certificate.
1183 */
1184 description?: String;
1185 /**
1186 * The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
1187 */
1188 pemEncodedCertificate?: String;
1189 /**
1190 * The timestamp when the client certificate was created.
1191 */
1192 createdDate?: Timestamp;
1193 /**
1194 * The timestamp when the client certificate will expire.
1195 */
1196 expirationDate?: Timestamp;
1197 /**
1198 * The collection of tags. Each tag element is associated with a given resource.
1199 */
1200 tags?: MapOfStringToString;
1201 }
1202 export interface ClientCertificates {
1203 position?: String;
1204 /**
1205 * The current page of elements from this collection.
1206 */
1207 items?: ListOfClientCertificate;
1208 }
1209 export type ConnectionType = "INTERNET"|"VPC_LINK"|string;
1210 export type ContentHandlingStrategy = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT"|string;
1211 export interface CreateApiKeyRequest {
1212 /**
1213 * The name of the ApiKey.
1214 */
1215 name?: String;
1216 /**
1217 * The description of the ApiKey.
1218 */
1219 description?: String;
1220 /**
1221 * Specifies whether the ApiKey can be used by callers.
1222 */
1223 enabled?: Boolean;
1224 /**
1225 * Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.
1226 */
1227 generateDistinctId?: Boolean;
1228 /**
1229 * Specifies a value of the API key.
1230 */
1231 value?: String;
1232 /**
1233 * DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
1234 */
1235 stageKeys?: ListOfStageKeys;
1236 /**
1237 * An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
1238 */
1239 customerId?: String;
1240 /**
1241 * The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
1242 */
1243 tags?: MapOfStringToString;
1244 }
1245 export interface CreateAuthorizerRequest {
1246 /**
1247 * [Required] The string identifier of the associated RestApi.
1248 */
1249 restApiId: String;
1250 /**
1251 * [Required] The name of the authorizer.
1252 */
1253 name: String;
1254 /**
1255 * [Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
1256 */
1257 type: AuthorizerType;
1258 /**
1259 * A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
1260 */
1261 providerARNs?: ListOfARNs;
1262 /**
1263 * Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
1264 */
1265 authType?: String;
1266 /**
1267 * Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
1268 */
1269 authorizerUri?: String;
1270 /**
1271 * Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
1272 */
1273 authorizerCredentials?: String;
1274 /**
1275 * The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
1276 */
1277 identitySource?: String;
1278 /**
1279 * A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
1280 */
1281 identityValidationExpression?: String;
1282 /**
1283 * The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
1284 */
1285 authorizerResultTtlInSeconds?: NullableInteger;
1286 }
1287 export interface CreateBasePathMappingRequest {
1288 /**
1289 * [Required] The domain name of the BasePathMapping resource to create.
1290 */
1291 domainName: String;
1292 /**
1293 * The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.
1294 */
1295 basePath?: String;
1296 /**
1297 * [Required] The string identifier of the associated RestApi.
1298 */
1299 restApiId: String;
1300 /**
1301 * The name of the API's stage that you want to use for this mapping. Specify '(none)' if you do not want callers to explicitly specify the stage name after any base path name.
1302 */
1303 stage?: String;
1304 }
1305 export interface CreateDeploymentRequest {
1306 /**
1307 * [Required] The string identifier of the associated RestApi.
1308 */
1309 restApiId: String;
1310 /**
1311 * The name of the Stage resource for the Deployment resource to create.
1312 */
1313 stageName?: String;
1314 /**
1315 * The description of the Stage resource for the Deployment resource to create.
1316 */
1317 stageDescription?: String;
1318 /**
1319 * The description for the Deployment resource to create.
1320 */
1321 description?: String;
1322 /**
1323 * Enables a cache cluster for the Stage resource specified in the input.
1324 */
1325 cacheClusterEnabled?: NullableBoolean;
1326 /**
1327 * Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
1328 */
1329 cacheClusterSize?: CacheClusterSize;
1330 /**
1331 * A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&amp;=,]+.
1332 */
1333 variables?: MapOfStringToString;
1334 /**
1335 * The input configuration for the canary deployment when the deployment is a canary release deployment.
1336 */
1337 canarySettings?: DeploymentCanarySettings;
1338 /**
1339 * Specifies whether active tracing with X-ray is enabled for the Stage.
1340 */
1341 tracingEnabled?: NullableBoolean;
1342 }
1343 export interface CreateDocumentationPartRequest {
1344 /**
1345 * [Required] The string identifier of the associated RestApi.
1346 */
1347 restApiId: String;
1348 /**
1349 * [Required] The location of the targeted API entity of the to-be-created documentation part.
1350 */
1351 location: DocumentationPartLocation;
1352 /**
1353 * [Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
1354 */
1355 properties: String;
1356 }
1357 export interface CreateDocumentationVersionRequest {
1358 /**
1359 * [Required] The string identifier of the associated RestApi.
1360 */
1361 restApiId: String;
1362 /**
1363 * [Required] The version identifier of the new snapshot.
1364 */
1365 documentationVersion: String;
1366 /**
1367 * The stage name to be associated with the new documentation snapshot.
1368 */
1369 stageName?: String;
1370 /**
1371 * A description about the new documentation snapshot.
1372 */
1373 description?: String;
1374 }
1375 export interface CreateDomainNameRequest {
1376 /**
1377 * [Required] The name of the DomainName resource.
1378 */
1379 domainName: String;
1380 /**
1381 * The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.
1382 */
1383 certificateName?: String;
1384 /**
1385 * [Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.
1386 */
1387 certificateBody?: String;
1388 /**
1389 * [Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
1390 */
1391 certificatePrivateKey?: String;
1392 /**
1393 * [Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.
1394 */
1395 certificateChain?: String;
1396 /**
1397 * The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
1398 */
1399 certificateArn?: String;
1400 /**
1401 * The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
1402 */
1403 regionalCertificateName?: String;
1404 /**
1405 * The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.
1406 */
1407 regionalCertificateArn?: String;
1408 /**
1409 * The endpoint configuration of this DomainName showing the endpoint types of the domain name.
1410 */
1411 endpointConfiguration?: EndpointConfiguration;
1412 /**
1413 * The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
1414 */
1415 tags?: MapOfStringToString;
1416 /**
1417 * The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
1418 */
1419 securityPolicy?: SecurityPolicy;
1420 }
1421 export interface CreateModelRequest {
1422 /**
1423 * [Required] The RestApi identifier under which the Model will be created.
1424 */
1425 restApiId: String;
1426 /**
1427 * [Required] The name of the model. Must be alphanumeric.
1428 */
1429 name: String;
1430 /**
1431 * The description of the model.
1432 */
1433 description?: String;
1434 /**
1435 * The schema for the model. For application/json models, this should be JSON schema draft 4 model.
1436 */
1437 schema?: String;
1438 /**
1439 * [Required] The content-type for the model.
1440 */
1441 contentType: String;
1442 }
1443 export interface CreateRequestValidatorRequest {
1444 /**
1445 * [Required] The string identifier of the associated RestApi.
1446 */
1447 restApiId: String;
1448 /**
1449 * The name of the to-be-created RequestValidator.
1450 */
1451 name?: String;
1452 /**
1453 * A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false).
1454 */
1455 validateRequestBody?: Boolean;
1456 /**
1457 * A Boolean flag to indicate whether to validate request parameters, true, or not false.
1458 */
1459 validateRequestParameters?: Boolean;
1460 }
1461 export interface CreateResourceRequest {
1462 /**
1463 * [Required] The string identifier of the associated RestApi.
1464 */
1465 restApiId: String;
1466 /**
1467 * [Required] The parent resource's identifier.
1468 */
1469 parentId: String;
1470 /**
1471 * The last path segment for this resource.
1472 */
1473 pathPart: String;
1474 }
1475 export interface CreateRestApiRequest {
1476 /**
1477 * [Required] The name of the RestApi.
1478 */
1479 name: String;
1480 /**
1481 * The description of the RestApi.
1482 */
1483 description?: String;
1484 /**
1485 * A version identifier for the API.
1486 */
1487 version?: String;
1488 /**
1489 * The ID of the RestApi that you want to clone from.
1490 */
1491 cloneFrom?: String;
1492 /**
1493 * The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
1494 */
1495 binaryMediaTypes?: ListOfString;
1496 /**
1497 * A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
1498 */
1499 minimumCompressionSize?: NullableInteger;
1500 /**
1501 * The source of the API key for metering requests according to a usage plan. Valid values are: HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
1502 */
1503 apiKeySource?: ApiKeySourceType;
1504 /**
1505 * The endpoint configuration of this RestApi showing the endpoint types of the API.
1506 */
1507 endpointConfiguration?: EndpointConfiguration;
1508 /**
1509 * A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
1510 */
1511 policy?: String;
1512 /**
1513 * The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
1514 */
1515 tags?: MapOfStringToString;
1516 }
1517 export interface CreateStageRequest {
1518 /**
1519 * [Required] The string identifier of the associated RestApi.
1520 */
1521 restApiId: String;
1522 /**
1523 * [Required] The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
1524 */
1525 stageName: String;
1526 /**
1527 * [Required] The identifier of the Deployment resource for the Stage resource.
1528 */
1529 deploymentId: String;
1530 /**
1531 * The description of the Stage resource.
1532 */
1533 description?: String;
1534 /**
1535 * Whether cache clustering is enabled for the stage.
1536 */
1537 cacheClusterEnabled?: Boolean;
1538 /**
1539 * The stage's cache cluster size.
1540 */
1541 cacheClusterSize?: CacheClusterSize;
1542 /**
1543 * A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&amp;=,]+.
1544 */
1545 variables?: MapOfStringToString;
1546 /**
1547 * The version of the associated API documentation.
1548 */
1549 documentationVersion?: String;
1550 /**
1551 * The canary deployment settings of this stage.
1552 */
1553 canarySettings?: CanarySettings;
1554 /**
1555 * Specifies whether active tracing with X-ray is enabled for the Stage.
1556 */
1557 tracingEnabled?: Boolean;
1558 /**
1559 * The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
1560 */
1561 tags?: MapOfStringToString;
1562 }
1563 export interface CreateUsagePlanKeyRequest {
1564 /**
1565 * [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.
1566 */
1567 usagePlanId: String;
1568 /**
1569 * [Required] The identifier of a UsagePlanKey resource for a plan customer.
1570 */
1571 keyId: String;
1572 /**
1573 * [Required] The type of a UsagePlanKey resource for a plan customer.
1574 */
1575 keyType: String;
1576 }
1577 export interface CreateUsagePlanRequest {
1578 /**
1579 * [Required] The name of the usage plan.
1580 */
1581 name: String;
1582 /**
1583 * The description of the usage plan.
1584 */
1585 description?: String;
1586 /**
1587 * The associated API stages of the usage plan.
1588 */
1589 apiStages?: ListOfApiStage;
1590 /**
1591 * The throttling limits of the usage plan.
1592 */
1593 throttle?: ThrottleSettings;
1594 /**
1595 * The quota of the usage plan.
1596 */
1597 quota?: QuotaSettings;
1598 /**
1599 * The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
1600 */
1601 tags?: MapOfStringToString;
1602 }
1603 export interface CreateVpcLinkRequest {
1604 /**
1605 * [Required] The name used to label and identify the VPC link.
1606 */
1607 name: String;
1608 /**
1609 * The description of the VPC link.
1610 */
1611 description?: String;
1612 /**
1613 * [Required] The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.
1614 */
1615 targetArns: ListOfString;
1616 /**
1617 * The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
1618 */
1619 tags?: MapOfStringToString;
1620 }
1621 export interface DeleteApiKeyRequest {
1622 /**
1623 * [Required] The identifier of the ApiKey resource to be deleted.
1624 */
1625 apiKey: String;
1626 }
1627 export interface DeleteAuthorizerRequest {
1628 /**
1629 * [Required] The string identifier of the associated RestApi.
1630 */
1631 restApiId: String;
1632 /**
1633 * [Required] The identifier of the Authorizer resource.
1634 */
1635 authorizerId: String;
1636 }
1637 export interface DeleteBasePathMappingRequest {
1638 /**
1639 * [Required] The domain name of the BasePathMapping resource to delete.
1640 */
1641 domainName: String;
1642 /**
1643 * [Required] The base path name of the BasePathMapping resource to delete. To specify an empty base path, set this parameter to '(none)'.
1644 */
1645 basePath: String;
1646 }
1647 export interface DeleteClientCertificateRequest {
1648 /**
1649 * [Required] The identifier of the ClientCertificate resource to be deleted.
1650 */
1651 clientCertificateId: String;
1652 }
1653 export interface DeleteDeploymentRequest {
1654 /**
1655 * [Required] The string identifier of the associated RestApi.
1656 */
1657 restApiId: String;
1658 /**
1659 * [Required] The identifier of the Deployment resource to delete.
1660 */
1661 deploymentId: String;
1662 }
1663 export interface DeleteDocumentationPartRequest {
1664 /**
1665 * [Required] The string identifier of the associated RestApi.
1666 */
1667 restApiId: String;
1668 /**
1669 * [Required] The identifier of the to-be-deleted documentation part.
1670 */
1671 documentationPartId: String;
1672 }
1673 export interface DeleteDocumentationVersionRequest {
1674 /**
1675 * [Required] The string identifier of the associated RestApi.
1676 */
1677 restApiId: String;
1678 /**
1679 * [Required] The version identifier of a to-be-deleted documentation snapshot.
1680 */
1681 documentationVersion: String;
1682 }
1683 export interface DeleteDomainNameRequest {
1684 /**
1685 * [Required] The name of the DomainName resource to be deleted.
1686 */
1687 domainName: String;
1688 }
1689 export interface DeleteGatewayResponseRequest {
1690 /**
1691 * [Required] The string identifier of the associated RestApi.
1692 */
1693 restApiId: String;
1694 /**
1695 * [Required] The response type of the associated GatewayResponse. Valid values are ACCESS_DENIEDAPI_CONFIGURATION_ERRORAUTHORIZER_FAILURE AUTHORIZER_CONFIGURATION_ERRORBAD_REQUEST_PARAMETERSBAD_REQUEST_BODYDEFAULT_4XXDEFAULT_5XXEXPIRED_TOKENINVALID_SIGNATUREINTEGRATION_FAILUREINTEGRATION_TIMEOUTINVALID_API_KEYMISSING_AUTHENTICATION_TOKEN QUOTA_EXCEEDEDREQUEST_TOO_LARGERESOURCE_NOT_FOUNDTHROTTLEDUNAUTHORIZEDUNSUPPORTED_MEDIA_TYPE
1696 */
1697 responseType: GatewayResponseType;
1698 }
1699 export interface DeleteIntegrationRequest {
1700 /**
1701 * [Required] The string identifier of the associated RestApi.
1702 */
1703 restApiId: String;
1704 /**
1705 * [Required] Specifies a delete integration request's resource identifier.
1706 */
1707 resourceId: String;
1708 /**
1709 * [Required] Specifies a delete integration request's HTTP method.
1710 */
1711 httpMethod: String;
1712 }
1713 export interface DeleteIntegrationResponseRequest {
1714 /**
1715 * [Required] The string identifier of the associated RestApi.
1716 */
1717 restApiId: String;
1718 /**
1719 * [Required] Specifies a delete integration response request's resource identifier.
1720 */
1721 resourceId: String;
1722 /**
1723 * [Required] Specifies a delete integration response request's HTTP method.
1724 */
1725 httpMethod: String;
1726 /**
1727 * [Required] Specifies a delete integration response request's status code.
1728 */
1729 statusCode: StatusCode;
1730 }
1731 export interface DeleteMethodRequest {
1732 /**
1733 * [Required] The string identifier of the associated RestApi.
1734 */
1735 restApiId: String;
1736 /**
1737 * [Required] The Resource identifier for the Method resource.
1738 */
1739 resourceId: String;
1740 /**
1741 * [Required] The HTTP verb of the Method resource.
1742 */
1743 httpMethod: String;
1744 }
1745 export interface DeleteMethodResponseRequest {
1746 /**
1747 * [Required] The string identifier of the associated RestApi.
1748 */
1749 restApiId: String;
1750 /**
1751 * [Required] The Resource identifier for the MethodResponse resource.
1752 */
1753 resourceId: String;
1754 /**
1755 * [Required] The HTTP verb of the Method resource.
1756 */
1757 httpMethod: String;
1758 /**
1759 * [Required] The status code identifier for the MethodResponse resource.
1760 */
1761 statusCode: StatusCode;
1762 }
1763 export interface DeleteModelRequest {
1764 /**
1765 * [Required] The string identifier of the associated RestApi.
1766 */
1767 restApiId: String;
1768 /**
1769 * [Required] The name of the model to delete.
1770 */
1771 modelName: String;
1772 }
1773 export interface DeleteRequestValidatorRequest {
1774 /**
1775 * [Required] The string identifier of the associated RestApi.
1776 */
1777 restApiId: String;
1778 /**
1779 * [Required] The identifier of the RequestValidator to be deleted.
1780 */
1781 requestValidatorId: String;
1782 }
1783 export interface DeleteResourceRequest {
1784 /**
1785 * [Required] The string identifier of the associated RestApi.
1786 */
1787 restApiId: String;
1788 /**
1789 * [Required] The identifier of the Resource resource.
1790 */
1791 resourceId: String;
1792 }
1793 export interface DeleteRestApiRequest {
1794 /**
1795 * [Required] The string identifier of the associated RestApi.
1796 */
1797 restApiId: String;
1798 }
1799 export interface DeleteStageRequest {
1800 /**
1801 * [Required] The string identifier of the associated RestApi.
1802 */
1803 restApiId: String;
1804 /**
1805 * [Required] The name of the Stage resource to delete.
1806 */
1807 stageName: String;
1808 }
1809 export interface DeleteUsagePlanKeyRequest {
1810 /**
1811 * [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.
1812 */
1813 usagePlanId: String;
1814 /**
1815 * [Required] The Id of the UsagePlanKey resource to be deleted.
1816 */
1817 keyId: String;
1818 }
1819 export interface DeleteUsagePlanRequest {
1820 /**
1821 * [Required] The Id of the to-be-deleted usage plan.
1822 */
1823 usagePlanId: String;
1824 }
1825 export interface DeleteVpcLinkRequest {
1826 /**
1827 * [Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
1828 */
1829 vpcLinkId: String;
1830 }
1831 export interface Deployment {
1832 /**
1833 * The identifier for the deployment resource.
1834 */
1835 id?: String;
1836 /**
1837 * The description for the deployment resource.
1838 */
1839 description?: String;
1840 /**
1841 * The date and time that the deployment resource was created.
1842 */
1843 createdDate?: Timestamp;
1844 /**
1845 * A summary of the RestApi at the date and time that the deployment resource was created.
1846 */
1847 apiSummary?: PathToMapOfMethodSnapshot;
1848 }
1849 export interface DeploymentCanarySettings {
1850 /**
1851 * The percentage (0.0-100.0) of traffic routed to the canary deployment.
1852 */
1853 percentTraffic?: Double;
1854 /**
1855 * A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.
1856 */
1857 stageVariableOverrides?: MapOfStringToString;
1858 /**
1859 * A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
1860 */
1861 useStageCache?: Boolean;
1862 }
1863 export interface Deployments {
1864 position?: String;
1865 /**
1866 * The current page of elements from this collection.
1867 */
1868 items?: ListOfDeployment;
1869 }
1870 export interface DocumentationPart {
1871 /**
1872 * The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
1873 */
1874 id?: String;
1875 /**
1876 * The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
1877 */
1878 location?: DocumentationPartLocation;
1879 /**
1880 * A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.
1881 */
1882 properties?: String;
1883 }
1884 export interface DocumentationPartIds {
1885 /**
1886 * A list of the returned documentation part identifiers.
1887 */
1888 ids?: ListOfString;
1889 /**
1890 * A list of warning messages reported during import of documentation parts.
1891 */
1892 warnings?: ListOfString;
1893 }
1894 export interface DocumentationPartLocation {
1895 /**
1896 * [Required] The type of API entity to which the documentation content applies. Valid values are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Content inheritance does not apply to any entity of the API, AUTHORIZER, METHOD, MODEL, REQUEST_BODY, or RESOURCE type.
1897 */
1898 type: DocumentationPartType;
1899 /**
1900 * The URL path of the target. It is a valid field for the API entity types of RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix.
1901 */
1902 path?: String;
1903 /**
1904 * The HTTP verb of a method. It is a valid field for the API entity types of METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly.
1905 */
1906 method?: String;
1907 /**
1908 * The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly.
1909 */
1910 statusCode?: DocumentationPartLocationStatusCode;
1911 /**
1912 * The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field for any other entity type.
1913 */
1914 name?: String;
1915 }
1916 export type DocumentationPartLocationStatusCode = string;
1917 export type DocumentationPartType = "API"|"AUTHORIZER"|"MODEL"|"RESOURCE"|"METHOD"|"PATH_PARAMETER"|"QUERY_PARAMETER"|"REQUEST_HEADER"|"REQUEST_BODY"|"RESPONSE"|"RESPONSE_HEADER"|"RESPONSE_BODY"|string;
1918 export interface DocumentationParts {
1919 position?: String;
1920 /**
1921 * The current page of elements from this collection.
1922 */
1923 items?: ListOfDocumentationPart;
1924 }
1925 export interface DocumentationVersion {
1926 /**
1927 * The version identifier of the API documentation snapshot.
1928 */
1929 version?: String;
1930 /**
1931 * The date when the API documentation snapshot is created.
1932 */
1933 createdDate?: Timestamp;
1934 /**
1935 * The description of the API documentation snapshot.
1936 */
1937 description?: String;
1938 }
1939 export interface DocumentationVersions {
1940 position?: String;
1941 /**
1942 * The current page of elements from this collection.
1943 */
1944 items?: ListOfDocumentationVersion;
1945 }
1946 export interface DomainName {
1947 /**
1948 * The custom domain name as an API host name, for example, my-api.example.com.
1949 */
1950 domainName?: String;
1951 /**
1952 * The name of the certificate that will be used by edge-optimized endpoint for this domain name.
1953 */
1954 certificateName?: String;
1955 /**
1956 * The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
1957 */
1958 certificateArn?: String;
1959 /**
1960 * The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
1961 */
1962 certificateUploadDate?: Timestamp;
1963 /**
1964 * The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
1965 */
1966 regionalDomainName?: String;
1967 /**
1968 * The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
1969 */
1970 regionalHostedZoneId?: String;
1971 /**
1972 * The name of the certificate that will be used for validating the regional domain name.
1973 */
1974 regionalCertificateName?: String;
1975 /**
1976 * The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
1977 */
1978 regionalCertificateArn?: String;
1979 /**
1980 * The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
1981 */
1982 distributionDomainName?: String;
1983 /**
1984 * The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
1985 */
1986 distributionHostedZoneId?: String;
1987 /**
1988 * The endpoint configuration of this DomainName showing the endpoint types of the domain name.
1989 */
1990 endpointConfiguration?: EndpointConfiguration;
1991 /**
1992 * The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
1993 */
1994 domainNameStatus?: DomainNameStatus;
1995 /**
1996 * An optional text message containing detailed information about status of the DomainName migration.
1997 */
1998 domainNameStatusMessage?: String;
1999 /**
2000 * The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
2001 */
2002 securityPolicy?: SecurityPolicy;
2003 /**
2004 * The collection of tags. Each tag element is associated with a given resource.
2005 */
2006 tags?: MapOfStringToString;
2007 }
2008 export type DomainNameStatus = "AVAILABLE"|"UPDATING"|"PENDING"|string;
2009 export interface DomainNames {
2010 position?: String;
2011 /**
2012 * The current page of elements from this collection.
2013 */
2014 items?: ListOfDomainName;
2015 }
2016 export type Double = number;
2017 export interface EndpointConfiguration {
2018 /**
2019 * A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.
2020 */
2021 types?: ListOfEndpointType;
2022 /**
2023 * A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.
2024 */
2025 vpcEndpointIds?: ListOfString;
2026 }
2027 export type EndpointType = "REGIONAL"|"EDGE"|"PRIVATE"|string;
2028 export interface ExportResponse {
2029 /**
2030 * The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.
2031 */
2032 contentType?: String;
2033 /**
2034 * The content-disposition header value in the HTTP response.
2035 */
2036 contentDisposition?: String;
2037 /**
2038 * The binary blob response to GetExport, which contains the export.
2039 */
2040 body?: _Blob;
2041 }
2042 export interface FlushStageAuthorizersCacheRequest {
2043 /**
2044 * The string identifier of the associated RestApi.
2045 */
2046 restApiId: String;
2047 /**
2048 * The name of the stage to flush.
2049 */
2050 stageName: String;
2051 }
2052 export interface FlushStageCacheRequest {
2053 /**
2054 * [Required] The string identifier of the associated RestApi.
2055 */
2056 restApiId: String;
2057 /**
2058 * [Required] The name of the stage to flush its cache.
2059 */
2060 stageName: String;
2061 }
2062 export interface GatewayResponse {
2063 /**
2064 * The response type of the associated GatewayResponse. Valid values are ACCESS_DENIEDAPI_CONFIGURATION_ERRORAUTHORIZER_FAILURE AUTHORIZER_CONFIGURATION_ERRORBAD_REQUEST_PARAMETERSBAD_REQUEST_BODYDEFAULT_4XXDEFAULT_5XXEXPIRED_TOKENINVALID_SIGNATUREINTEGRATION_FAILUREINTEGRATION_TIMEOUTINVALID_API_KEYMISSING_AUTHENTICATION_TOKEN QUOTA_EXCEEDEDREQUEST_TOO_LARGERESOURCE_NOT_FOUNDTHROTTLEDUNAUTHORIZEDUNSUPPORTED_MEDIA_TYPE
2065 */
2066 responseType?: GatewayResponseType;
2067 /**
2068 * The HTTP status code for this GatewayResponse.
2069 */
2070 statusCode?: StatusCode;
2071 /**
2072 * Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
2073 */
2074 responseParameters?: MapOfStringToString;
2075 /**
2076 * Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
2077 */
2078 responseTemplates?: MapOfStringToString;
2079 /**
2080 * A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.
2081 */
2082 defaultResponse?: Boolean;
2083 }
2084 export type GatewayResponseType = "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"|string;
2085 export interface GatewayResponses {
2086 position?: String;
2087 /**
2088 * Returns the entire collection, because of no pagination support.
2089 */
2090 items?: ListOfGatewayResponse;
2091 }
2092 export interface GenerateClientCertificateRequest {
2093 /**
2094 * The description of the ClientCertificate.
2095 */
2096 description?: String;
2097 /**
2098 * The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
2099 */
2100 tags?: MapOfStringToString;
2101 }
2102 export interface GetAccountRequest {
2103 }
2104 export interface GetApiKeyRequest {
2105 /**
2106 * [Required] The identifier of the ApiKey resource.
2107 */
2108 apiKey: String;
2109 /**
2110 * A boolean flag to specify whether (true) or not (false) the result contains the key value.
2111 */
2112 includeValue?: NullableBoolean;
2113 }
2114 export interface GetApiKeysRequest {
2115 /**
2116 * The current pagination position in the paged result set.
2117 */
2118 position?: String;
2119 /**
2120 * The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2121 */
2122 limit?: NullableInteger;
2123 /**
2124 * The name of queried API keys.
2125 */
2126 nameQuery?: String;
2127 /**
2128 * The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.
2129 */
2130 customerId?: String;
2131 /**
2132 * A boolean flag to specify whether (true) or not (false) the result contains key values.
2133 */
2134 includeValues?: NullableBoolean;
2135 }
2136 export interface GetAuthorizerRequest {
2137 /**
2138 * [Required] The string identifier of the associated RestApi.
2139 */
2140 restApiId: String;
2141 /**
2142 * [Required] The identifier of the Authorizer resource.
2143 */
2144 authorizerId: String;
2145 }
2146 export interface GetAuthorizersRequest {
2147 /**
2148 * [Required] The string identifier of the associated RestApi.
2149 */
2150 restApiId: String;
2151 /**
2152 * The current pagination position in the paged result set.
2153 */
2154 position?: String;
2155 /**
2156 * The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2157 */
2158 limit?: NullableInteger;
2159 }
2160 export interface GetBasePathMappingRequest {
2161 /**
2162 * [Required] The domain name of the BasePathMapping resource to be described.
2163 */
2164 domainName: String;
2165 /**
2166 * [Required] The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.
2167 */
2168 basePath: String;
2169 }
2170 export interface GetBasePathMappingsRequest {
2171 /**
2172 * [Required] The domain name of a BasePathMapping resource.
2173 */
2174 domainName: String;
2175 /**
2176 * The current pagination position in the paged result set.
2177 */
2178 position?: String;
2179 /**
2180 * The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2181 */
2182 limit?: NullableInteger;
2183 }
2184 export interface GetClientCertificateRequest {
2185 /**
2186 * [Required] The identifier of the ClientCertificate resource to be described.
2187 */
2188 clientCertificateId: String;
2189 }
2190 export interface GetClientCertificatesRequest {
2191 /**
2192 * The current pagination position in the paged result set.
2193 */
2194 position?: String;
2195 /**
2196 * The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2197 */
2198 limit?: NullableInteger;
2199 }
2200 export interface GetDeploymentRequest {
2201 /**
2202 * [Required] The string identifier of the associated RestApi.
2203 */
2204 restApiId: String;
2205 /**
2206 * [Required] The identifier of the Deployment resource to get information about.
2207 */
2208 deploymentId: String;
2209 /**
2210 * A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.
2211 */
2212 embed?: ListOfString;
2213 }
2214 export interface GetDeploymentsRequest {
2215 /**
2216 * [Required] The string identifier of the associated RestApi.
2217 */
2218 restApiId: String;
2219 /**
2220 * The current pagination position in the paged result set.
2221 */
2222 position?: String;
2223 /**
2224 * The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2225 */
2226 limit?: NullableInteger;
2227 }
2228 export interface GetDocumentationPartRequest {
2229 /**
2230 * [Required] The string identifier of the associated RestApi.
2231 */
2232 restApiId: String;
2233 /**
2234 * [Required] The string identifier of the associated RestApi.
2235 */
2236 documentationPartId: String;
2237 }
2238 export interface GetDocumentationPartsRequest {
2239 /**
2240 * [Required] The string identifier of the associated RestApi.
2241 */
2242 restApiId: String;
2243 /**
2244 * The type of API entities of the to-be-retrieved documentation parts.
2245 */
2246 type?: DocumentationPartType;
2247 /**
2248 * The name of API entities of the to-be-retrieved documentation parts.
2249 */
2250 nameQuery?: String;
2251 /**
2252 * The path of API entities of the to-be-retrieved documentation parts.
2253 */
2254 path?: String;
2255 /**
2256 * The current pagination position in the paged result set.
2257 */
2258 position?: String;
2259 /**
2260 * The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2261 */
2262 limit?: NullableInteger;
2263 /**
2264 * The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
2265 */
2266 locationStatus?: LocationStatusType;
2267 }
2268 export interface GetDocumentationVersionRequest {
2269 /**
2270 * [Required] The string identifier of the associated RestApi.
2271 */
2272 restApiId: String;
2273 /**
2274 * [Required] The version identifier of the to-be-retrieved documentation snapshot.
2275 */
2276 documentationVersion: String;
2277 }
2278 export interface GetDocumentationVersionsRequest {
2279 /**
2280 * [Required] The string identifier of the associated RestApi.
2281 */
2282 restApiId: String;
2283 /**
2284 * The current pagination position in the paged result set.
2285 */
2286 position?: String;
2287 /**
2288 * The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2289 */
2290 limit?: NullableInteger;
2291 }
2292 export interface GetDomainNameRequest {
2293 /**
2294 * [Required] The name of the DomainName resource.
2295 */
2296 domainName: String;
2297 }
2298 export interface GetDomainNamesRequest {
2299 /**
2300 * The current pagination position in the paged result set.
2301 */
2302 position?: String;
2303 /**
2304 * The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2305 */
2306 limit?: NullableInteger;
2307 }
2308 export interface GetExportRequest {
2309 /**
2310 * [Required] The string identifier of the associated RestApi.
2311 */
2312 restApiId: String;
2313 /**
2314 * [Required] The name of the Stage that will be exported.
2315 */
2316 stageName: String;
2317 /**
2318 * [Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
2319 */
2320 exportType: String;
2321 /**
2322 * A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool
2323 */
2324 parameters?: MapOfStringToString;
2325 /**
2326 * The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.
2327 */
2328 accepts?: String;
2329 }
2330 export interface GetGatewayResponseRequest {
2331 /**
2332 * [Required] The string identifier of the associated RestApi.
2333 */
2334 restApiId: String;
2335 /**
2336 * [Required] The response type of the associated GatewayResponse. Valid values are ACCESS_DENIEDAPI_CONFIGURATION_ERRORAUTHORIZER_FAILURE AUTHORIZER_CONFIGURATION_ERRORBAD_REQUEST_PARAMETERSBAD_REQUEST_BODYDEFAULT_4XXDEFAULT_5XXEXPIRED_TOKENINVALID_SIGNATUREINTEGRATION_FAILUREINTEGRATION_TIMEOUTINVALID_API_KEYMISSING_AUTHENTICATION_TOKEN QUOTA_EXCEEDEDREQUEST_TOO_LARGERESOURCE_NOT_FOUNDTHROTTLEDUNAUTHORIZEDUNSUPPORTED_MEDIA_TYPE
2337 */
2338 responseType: GatewayResponseType;
2339 }
2340 export interface GetGatewayResponsesRequest {
2341 /**
2342 * [Required] The string identifier of the associated RestApi.
2343 */
2344 restApiId: String;
2345 /**
2346 * The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.
2347 */
2348 position?: String;
2349 /**
2350 * The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.
2351 */
2352 limit?: NullableInteger;
2353 }
2354 export interface GetIntegrationRequest {
2355 /**
2356 * [Required] The string identifier of the associated RestApi.
2357 */
2358 restApiId: String;
2359 /**
2360 * [Required] Specifies a get integration request's resource identifier
2361 */
2362 resourceId: String;
2363 /**
2364 * [Required] Specifies a get integration request's HTTP method.
2365 */
2366 httpMethod: String;
2367 }
2368 export interface GetIntegrationResponseRequest {
2369 /**
2370 * [Required] The string identifier of the associated RestApi.
2371 */
2372 restApiId: String;
2373 /**
2374 * [Required] Specifies a get integration response request's resource identifier.
2375 */
2376 resourceId: String;
2377 /**
2378 * [Required] Specifies a get integration response request's HTTP method.
2379 */
2380 httpMethod: String;
2381 /**
2382 * [Required] Specifies a get integration response request's status code.
2383 */
2384 statusCode: StatusCode;
2385 }
2386 export interface GetMethodRequest {
2387 /**
2388 * [Required] The string identifier of the associated RestApi.
2389 */
2390 restApiId: String;
2391 /**
2392 * [Required] The Resource identifier for the Method resource.
2393 */
2394 resourceId: String;
2395 /**
2396 * [Required] Specifies the method request's HTTP method type.
2397 */
2398 httpMethod: String;
2399 }
2400 export interface GetMethodResponseRequest {
2401 /**
2402 * [Required] The string identifier of the associated RestApi.
2403 */
2404 restApiId: String;
2405 /**
2406 * [Required] The Resource identifier for the MethodResponse resource.
2407 */
2408 resourceId: String;
2409 /**
2410 * [Required] The HTTP verb of the Method resource.
2411 */
2412 httpMethod: String;
2413 /**
2414 * [Required] The status code for the MethodResponse resource.
2415 */
2416 statusCode: StatusCode;
2417 }
2418 export interface GetModelRequest {
2419 /**
2420 * [Required] The RestApi identifier under which the Model exists.
2421 */
2422 restApiId: String;
2423 /**
2424 * [Required] The name of the model as an identifier.
2425 */
2426 modelName: String;
2427 /**
2428 * A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false.
2429 */
2430 flatten?: Boolean;
2431 }
2432 export interface GetModelTemplateRequest {
2433 /**
2434 * [Required] The string identifier of the associated RestApi.
2435 */
2436 restApiId: String;
2437 /**
2438 * [Required] The name of the model for which to generate a template.
2439 */
2440 modelName: String;
2441 }
2442 export interface GetModelsRequest {
2443 /**
2444 * [Required] The string identifier of the associated RestApi.
2445 */
2446 restApiId: String;
2447 /**
2448 * The current pagination position in the paged result set.
2449 */
2450 position?: String;
2451 /**
2452 * The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2453 */
2454 limit?: NullableInteger;
2455 }
2456 export interface GetRequestValidatorRequest {
2457 /**
2458 * [Required] The string identifier of the associated RestApi.
2459 */
2460 restApiId: String;
2461 /**
2462 * [Required] The identifier of the RequestValidator to be retrieved.
2463 */
2464 requestValidatorId: String;
2465 }
2466 export interface GetRequestValidatorsRequest {
2467 /**
2468 * [Required] The string identifier of the associated RestApi.
2469 */
2470 restApiId: String;
2471 /**
2472 * The current pagination position in the paged result set.
2473 */
2474 position?: String;
2475 /**
2476 * The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2477 */
2478 limit?: NullableInteger;
2479 }
2480 export interface GetResourceRequest {
2481 /**
2482 * [Required] The string identifier of the associated RestApi.
2483 */
2484 restApiId: String;
2485 /**
2486 * [Required] The identifier for the Resource resource.
2487 */
2488 resourceId: String;
2489 /**
2490 * A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods.
2491 */
2492 embed?: ListOfString;
2493 }
2494 export interface GetResourcesRequest {
2495 /**
2496 * [Required] The string identifier of the associated RestApi.
2497 */
2498 restApiId: String;
2499 /**
2500 * The current pagination position in the paged result set.
2501 */
2502 position?: String;
2503 /**
2504 * The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2505 */
2506 limit?: NullableInteger;
2507 /**
2508 * A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.
2509 */
2510 embed?: ListOfString;
2511 }
2512 export interface GetRestApiRequest {
2513 /**
2514 * [Required] The string identifier of the associated RestApi.
2515 */
2516 restApiId: String;
2517 }
2518 export interface GetRestApisRequest {
2519 /**
2520 * The current pagination position in the paged result set.
2521 */
2522 position?: String;
2523 /**
2524 * The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2525 */
2526 limit?: NullableInteger;
2527 }
2528 export interface GetSdkRequest {
2529 /**
2530 * [Required] The string identifier of the associated RestApi.
2531 */
2532 restApiId: String;
2533 /**
2534 * [Required] The name of the Stage that the SDK will use.
2535 */
2536 stageName: String;
2537 /**
2538 * [Required] The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.
2539 */
2540 sdkType: String;
2541 /**
2542 * A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For sdkType of java, parameters named serviceName and javaPackageName are required.
2543 */
2544 parameters?: MapOfStringToString;
2545 }
2546 export interface GetSdkTypeRequest {
2547 /**
2548 * [Required] The identifier of the queried SdkType instance.
2549 */
2550 id: String;
2551 }
2552 export interface GetSdkTypesRequest {
2553 /**
2554 * The current pagination position in the paged result set.
2555 */
2556 position?: String;
2557 /**
2558 * The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2559 */
2560 limit?: NullableInteger;
2561 }
2562 export interface GetStageRequest {
2563 /**
2564 * [Required] The string identifier of the associated RestApi.
2565 */
2566 restApiId: String;
2567 /**
2568 * [Required] The name of the Stage resource to get information about.
2569 */
2570 stageName: String;
2571 }
2572 export interface GetStagesRequest {
2573 /**
2574 * [Required] The string identifier of the associated RestApi.
2575 */
2576 restApiId: String;
2577 /**
2578 * The stages' deployment identifiers.
2579 */
2580 deploymentId?: String;
2581 }
2582 export interface GetTagsRequest {
2583 /**
2584 * [Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.
2585 */
2586 resourceArn: String;
2587 /**
2588 * (Not currently supported) The current pagination position in the paged result set.
2589 */
2590 position?: String;
2591 /**
2592 * (Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2593 */
2594 limit?: NullableInteger;
2595 }
2596 export interface GetUsagePlanKeyRequest {
2597 /**
2598 * [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
2599 */
2600 usagePlanId: String;
2601 /**
2602 * [Required] The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.
2603 */
2604 keyId: String;
2605 }
2606 export interface GetUsagePlanKeysRequest {
2607 /**
2608 * [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
2609 */
2610 usagePlanId: String;
2611 /**
2612 * The current pagination position in the paged result set.
2613 */
2614 position?: String;
2615 /**
2616 * The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2617 */
2618 limit?: NullableInteger;
2619 /**
2620 * A query parameter specifying the name of the to-be-returned usage plan keys.
2621 */
2622 nameQuery?: String;
2623 }
2624 export interface GetUsagePlanRequest {
2625 /**
2626 * [Required] The identifier of the UsagePlan resource to be retrieved.
2627 */
2628 usagePlanId: String;
2629 }
2630 export interface GetUsagePlansRequest {
2631 /**
2632 * The current pagination position in the paged result set.
2633 */
2634 position?: String;
2635 /**
2636 * The identifier of the API key associated with the usage plans.
2637 */
2638 keyId?: String;
2639 /**
2640 * The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2641 */
2642 limit?: NullableInteger;
2643 }
2644 export interface GetUsageRequest {
2645 /**
2646 * [Required] The Id of the usage plan associated with the usage data.
2647 */
2648 usagePlanId: String;
2649 /**
2650 * The Id of the API key associated with the resultant usage data.
2651 */
2652 keyId?: String;
2653 /**
2654 * [Required] The starting date (e.g., 2016-01-01) of the usage data.
2655 */
2656 startDate: String;
2657 /**
2658 * [Required] The ending date (e.g., 2016-12-31) of the usage data.
2659 */
2660 endDate: String;
2661 /**
2662 * The current pagination position in the paged result set.
2663 */
2664 position?: String;
2665 /**
2666 * The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2667 */
2668 limit?: NullableInteger;
2669 }
2670 export interface GetVpcLinkRequest {
2671 /**
2672 * [Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
2673 */
2674 vpcLinkId: String;
2675 }
2676 export interface GetVpcLinksRequest {
2677 /**
2678 * The current pagination position in the paged result set.
2679 */
2680 position?: String;
2681 /**
2682 * The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
2683 */
2684 limit?: NullableInteger;
2685 }
2686 export interface ImportApiKeysRequest {
2687 /**
2688 * The payload of the POST request to import API keys. For the payload format, see API Key File Format.
2689 */
2690 body: _Blob;
2691 /**
2692 * A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.
2693 */
2694 format: ApiKeysFormat;
2695 /**
2696 * A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.
2697 */
2698 failOnWarnings?: Boolean;
2699 }
2700 export interface ImportDocumentationPartsRequest {
2701 /**
2702 * [Required] The string identifier of the associated RestApi.
2703 */
2704 restApiId: String;
2705 /**
2706 * A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.
2707 */
2708 mode?: PutMode;
2709 /**
2710 * A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.
2711 */
2712 failOnWarnings?: Boolean;
2713 /**
2714 * [Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
2715 */
2716 body: _Blob;
2717 }
2718 export interface ImportRestApiRequest {
2719 /**
2720 * A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.
2721 */
2722 failOnWarnings?: Boolean;
2723 /**
2724 * A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values. To exclude DocumentationParts from the import, set parameters as ignore=documentation. To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE. To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split. For example, the AWS CLI command to exclude documentation from the imported API is: aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' The AWS CLI command to set the regional endpoint on the imported API is: aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'
2725 */
2726 parameters?: MapOfStringToString;
2727 /**
2728 * [Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.
2729 */
2730 body: _Blob;
2731 }
2732 export type Integer = number;
2733 export interface Integration {
2734 /**
2735 * Specifies an API method integration type. The valid value is one of the following: AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration. HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration. HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration. MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend. For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
2736 */
2737 type?: IntegrationType;
2738 /**
2739 * Specifies the integration's HTTP method type.
2740 */
2741 httpMethod?: String;
2742 /**
2743 * Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&amp;{p1}={v1}&amp;p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&amp;Bucket={bucket}&amp;Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
2744 */
2745 uri?: String;
2746 /**
2747 * The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
2748 */
2749 connectionType?: ConnectionType;
2750 /**
2751 * The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
2752 */
2753 connectionId?: String;
2754 /**
2755 * Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.
2756 */
2757 credentials?: String;
2758 /**
2759 * A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.
2760 */
2761 requestParameters?: MapOfStringToString;
2762 /**
2763 * Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
2764 */
2765 requestTemplates?: MapOfStringToString;
2766 /**
2767 * Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following: WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
2768 */
2769 passthroughBehavior?: String;
2770 /**
2771 * Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.
2772 */
2773 contentHandling?: ContentHandlingStrategy;
2774 /**
2775 * Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
2776 */
2777 timeoutInMillis?: Integer;
2778 /**
2779 * An API-specific tag group of related cached parameters. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
2780 */
2781 cacheNamespace?: String;
2782 /**
2783 * A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
2784 */
2785 cacheKeyParameters?: ListOfString;
2786 /**
2787 * Specifies the integration's responses. Example: Get integration responses of a method Request GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response The successful response returns 200 OK status and a payload as follows: { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" } Creating an API
2788 */
2789 integrationResponses?: MapOfIntegrationResponse;
2790 }
2791 export interface IntegrationResponse {
2792 /**
2793 * Specifies the status code that is used to map the integration response to an existing MethodResponse.
2794 */
2795 statusCode?: StatusCode;
2796 /**
2797 * Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
2798 */
2799 selectionPattern?: String;
2800 /**
2801 * A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
2802 */
2803 responseParameters?: MapOfStringToString;
2804 /**
2805 * Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
2806 */
2807 responseTemplates?: MapOfStringToString;
2808 /**
2809 * Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
2810 */
2811 contentHandling?: ContentHandlingStrategy;
2812 }
2813 export type IntegrationType = "HTTP"|"AWS"|"MOCK"|"HTTP_PROXY"|"AWS_PROXY"|string;
2814 export type ListOfARNs = ProviderARN[];
2815 export type ListOfApiKey = ApiKey[];
2816 export type ListOfApiStage = ApiStage[];
2817 export type ListOfAuthorizer = Authorizer[];
2818 export type ListOfBasePathMapping = BasePathMapping[];
2819 export type ListOfClientCertificate = ClientCertificate[];
2820 export type ListOfDeployment = Deployment[];
2821 export type ListOfDocumentationPart = DocumentationPart[];
2822 export type ListOfDocumentationVersion = DocumentationVersion[];
2823 export type ListOfDomainName = DomainName[];
2824 export type ListOfEndpointType = EndpointType[];
2825 export type ListOfGatewayResponse = GatewayResponse[];
2826 export type ListOfLong = Long[];
2827 export type ListOfModel = Model[];
2828 export type ListOfPatchOperation = PatchOperation[];
2829 export type ListOfRequestValidator = RequestValidator[];
2830 export type ListOfResource = Resource[];
2831 export type ListOfRestApi = RestApi[];
2832 export type ListOfSdkConfigurationProperty = SdkConfigurationProperty[];
2833 export type ListOfSdkType = SdkType[];
2834 export type ListOfStage = Stage[];
2835 export type ListOfStageKeys = StageKey[];
2836 export type ListOfString = String[];
2837 export type ListOfUsage = ListOfLong[];
2838 export type ListOfUsagePlan = UsagePlan[];
2839 export type ListOfUsagePlanKey = UsagePlanKey[];
2840 export type ListOfVpcLink = VpcLink[];
2841 export type LocationStatusType = "DOCUMENTED"|"UNDOCUMENTED"|string;
2842 export type Long = number;
2843 export type MapOfApiStageThrottleSettings = {[key: string]: ThrottleSettings};
2844 export type MapOfIntegrationResponse = {[key: string]: IntegrationResponse};
2845 export type MapOfKeyUsages = {[key: string]: ListOfUsage};
2846 export type MapOfMethod = {[key: string]: Method};
2847 export type MapOfMethodResponse = {[key: string]: MethodResponse};
2848 export type MapOfMethodSettings = {[key: string]: MethodSetting};
2849 export type MapOfMethodSnapshot = {[key: string]: MethodSnapshot};
2850 export type MapOfStringToBoolean = {[key: string]: NullableBoolean};
2851 export type MapOfStringToList = {[key: string]: ListOfString};
2852 export type MapOfStringToString = {[key: string]: String};
2853 export interface Method {
2854 /**
2855 * The method's HTTP verb.
2856 */
2857 httpMethod?: String;
2858 /**
2859 * The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.
2860 */
2861 authorizationType?: String;
2862 /**
2863 * The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.
2864 */
2865 authorizerId?: String;
2866 /**
2867 * A boolean flag specifying whether a valid ApiKey is required to invoke this method.
2868 */
2869 apiKeyRequired?: NullableBoolean;
2870 /**
2871 * The identifier of a RequestValidator for request validation.
2872 */
2873 requestValidatorId?: String;
2874 /**
2875 * A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.
2876 */
2877 operationName?: String;
2878 /**
2879 * A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
2880 */
2881 requestParameters?: MapOfStringToBoolean;
2882 /**
2883 * A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
2884 */
2885 requestModels?: MapOfStringToString;
2886 /**
2887 * Gets a method response associated with a given HTTP status code. The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response. Example: Get a 200 OK response of a GET method Request GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response The successful response returns a 200 OK status code and a payload similar to the following: { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false }, "statusCode": "200" } AWS CLI
2888 */
2889 methodResponses?: MapOfMethodResponse;
2890 /**
2891 * Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end. Example: Request GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response The successful response returns a 200 OK status code and a payload similar to the following: { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true } ], "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } } } AWS CLI
2892 */
2893 methodIntegration?: Integration;
2894 /**
2895 * A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
2896 */
2897 authorizationScopes?: ListOfString;
2898 }
2899 export interface MethodResponse {
2900 /**
2901 * The method response's status code.
2902 */
2903 statusCode?: StatusCode;
2904 /**
2905 * A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)
2906 */
2907 responseParameters?: MapOfStringToBoolean;
2908 /**
2909 * Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
2910 */
2911 responseModels?: MapOfStringToString;
2912 }
2913 export interface MethodSetting {
2914 /**
2915 * Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean.
2916 */
2917 metricsEnabled?: Boolean;
2918 /**
2919 * Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO.
2920 */
2921 loggingLevel?: String;
2922 /**
2923 * Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.
2924 */
2925 dataTraceEnabled?: Boolean;
2926 /**
2927 * Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.
2928 */
2929 throttlingBurstLimit?: Integer;
2930 /**
2931 * Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.
2932 */
2933 throttlingRateLimit?: Double;
2934 /**
2935 * Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.
2936 */
2937 cachingEnabled?: Boolean;
2938 /**
2939 * Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer.
2940 */
2941 cacheTtlInSeconds?: Integer;
2942 /**
2943 * Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean.
2944 */
2945 cacheDataEncrypted?: Boolean;
2946 /**
2947 * Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean.
2948 */
2949 requireAuthorizationForCacheControl?: Boolean;
2950 /**
2951 * Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.
2952 */
2953 unauthorizedCacheControlHeaderStrategy?: UnauthorizedCacheControlHeaderStrategy;
2954 }
2955 export interface MethodSnapshot {
2956 /**
2957 * The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.
2958 */
2959 authorizationType?: String;
2960 /**
2961 * Specifies whether the method requires a valid ApiKey.
2962 */
2963 apiKeyRequired?: Boolean;
2964 }
2965 export interface Model {
2966 /**
2967 * The identifier for the model resource.
2968 */
2969 id?: String;
2970 /**
2971 * The name of the model. Must be an alphanumeric string.
2972 */
2973 name?: String;
2974 /**
2975 * The description of the model.
2976 */
2977 description?: String;
2978 /**
2979 * The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*" characters in the description of any properties because such "\*" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
2980 */
2981 schema?: String;
2982 /**
2983 * The content-type for the model.
2984 */
2985 contentType?: String;
2986 }
2987 export interface Models {
2988 position?: String;
2989 /**
2990 * The current page of elements from this collection.
2991 */
2992 items?: ListOfModel;
2993 }
2994 export type NullableBoolean = boolean;
2995 export type NullableInteger = number;
2996 export type Op = "add"|"remove"|"replace"|"move"|"copy"|"test"|string;
2997 export interface PatchOperation {
2998 /**
2999 * An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.
3000 */
3001 op?: Op;
3002 /**
3003 * The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {"name":"value"}, the path for this property is /name. If the name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}}), the path for the child/name property will be /name/child~1name. Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Each op operation can have only one path associated with it.
3004 */
3005 path?: String;
3006 /**
3007 * The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{"a": ...}'. In a Windows shell, see Using JSON for Parameters.
3008 */
3009 value?: String;
3010 /**
3011 * The copy update operation's source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with "op":"copy", "from":"/canarySettings/deploymentId" and "path":"/deploymentId".
3012 */
3013 from?: String;
3014 }
3015 export type PathToMapOfMethodSnapshot = {[key: string]: MapOfMethodSnapshot};
3016 export type ProviderARN = string;
3017 export interface PutGatewayResponseRequest {
3018 /**
3019 * [Required] The string identifier of the associated RestApi.
3020 */
3021 restApiId: String;
3022 /**
3023 * [Required] The response type of the associated GatewayResponse. Valid values are ACCESS_DENIEDAPI_CONFIGURATION_ERRORAUTHORIZER_FAILURE AUTHORIZER_CONFIGURATION_ERRORBAD_REQUEST_PARAMETERSBAD_REQUEST_BODYDEFAULT_4XXDEFAULT_5XXEXPIRED_TOKENINVALID_SIGNATUREINTEGRATION_FAILUREINTEGRATION_TIMEOUTINVALID_API_KEYMISSING_AUTHENTICATION_TOKEN QUOTA_EXCEEDEDREQUEST_TOO_LARGERESOURCE_NOT_FOUNDTHROTTLEDUNAUTHORIZEDUNSUPPORTED_MEDIA_TYPE
3024 */
3025 responseType: GatewayResponseType;
3026 /**
3027 * The HTTP status code of the GatewayResponse.
3028 */
3029 statusCode?: StatusCode;
3030 /**
3031 * Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
3032 */
3033 responseParameters?: MapOfStringToString;
3034 /**
3035 * Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
3036 */
3037 responseTemplates?: MapOfStringToString;
3038 }
3039 export interface PutIntegrationRequest {
3040 /**
3041 * [Required] The string identifier of the associated RestApi.
3042 */
3043 restApiId: String;
3044 /**
3045 * [Required] Specifies a put integration request's resource ID.
3046 */
3047 resourceId: String;
3048 /**
3049 * [Required] Specifies a put integration request's HTTP method.
3050 */
3051 httpMethod: String;
3052 /**
3053 * [Required] Specifies a put integration input's type.
3054 */
3055 type: IntegrationType;
3056 /**
3057 * Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
3058 */
3059 integrationHttpMethod?: String;
3060 /**
3061 * Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&amp;{p1}={v1}&amp;p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&amp;Bucket={bucket}&amp;Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
3062 */
3063 uri?: String;
3064 /**
3065 * The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
3066 */
3067 connectionType?: ConnectionType;
3068 /**
3069 * The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
3070 */
3071 connectionId?: String;
3072 /**
3073 * Specifies whether credentials are required for a put integration.
3074 */
3075 credentials?: String;
3076 /**
3077 * A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.
3078 */
3079 requestParameters?: MapOfStringToString;
3080 /**
3081 * Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
3082 */
3083 requestTemplates?: MapOfStringToString;
3084 /**
3085 * Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation. NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response. WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.
3086 */
3087 passthroughBehavior?: String;
3088 /**
3089 * A list of request parameters whose values are to be cached.
3090 */
3091 cacheNamespace?: String;
3092 /**
3093 * An API-specific tag group of related cached parameters.
3094 */
3095 cacheKeyParameters?: ListOfString;
3096 /**
3097 * Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.
3098 */
3099 contentHandling?: ContentHandlingStrategy;
3100 /**
3101 * Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
3102 */
3103 timeoutInMillis?: NullableInteger;
3104 }
3105 export interface PutIntegrationResponseRequest {
3106 /**
3107 * [Required] The string identifier of the associated RestApi.
3108 */
3109 restApiId: String;
3110 /**
3111 * [Required] Specifies a put integration response request's resource identifier.
3112 */
3113 resourceId: String;
3114 /**
3115 * [Required] Specifies a put integration response request's HTTP method.
3116 */
3117 httpMethod: String;
3118 /**
3119 * [Required] Specifies the status code that is used to map the integration response to an existing MethodResponse.
3120 */
3121 statusCode: StatusCode;
3122 /**
3123 * Specifies the selection pattern of a put integration response.
3124 */
3125 selectionPattern?: String;
3126 /**
3127 * A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.
3128 */
3129 responseParameters?: MapOfStringToString;
3130 /**
3131 * Specifies a put integration response's templates.
3132 */
3133 responseTemplates?: MapOfStringToString;
3134 /**
3135 * Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
3136 */
3137 contentHandling?: ContentHandlingStrategy;
3138 }
3139 export interface PutMethodRequest {
3140 /**
3141 * [Required] The string identifier of the associated RestApi.
3142 */
3143 restApiId: String;
3144 /**
3145 * [Required] The Resource identifier for the new Method resource.
3146 */
3147 resourceId: String;
3148 /**
3149 * [Required] Specifies the method request's HTTP method type.
3150 */
3151 httpMethod: String;
3152 /**
3153 * [Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.
3154 */
3155 authorizationType: String;
3156 /**
3157 * Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.
3158 */
3159 authorizerId?: String;
3160 /**
3161 * Specifies whether the method required a valid ApiKey.
3162 */
3163 apiKeyRequired?: Boolean;
3164 /**
3165 * A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.
3166 */
3167 operationName?: String;
3168 /**
3169 * A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.
3170 */
3171 requestParameters?: MapOfStringToBoolean;
3172 /**
3173 * Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
3174 */
3175 requestModels?: MapOfStringToString;
3176 /**
3177 * The identifier of a RequestValidator for validating the method request.
3178 */
3179 requestValidatorId?: String;
3180 /**
3181 * A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
3182 */
3183 authorizationScopes?: ListOfString;
3184 }
3185 export interface PutMethodResponseRequest {
3186 /**
3187 * [Required] The string identifier of the associated RestApi.
3188 */
3189 restApiId: String;
3190 /**
3191 * [Required] The Resource identifier for the Method resource.
3192 */
3193 resourceId: String;
3194 /**
3195 * [Required] The HTTP verb of the Method resource.
3196 */
3197 httpMethod: String;
3198 /**
3199 * [Required] The method response's status code.
3200 */
3201 statusCode: StatusCode;
3202 /**
3203 * A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)
3204 */
3205 responseParameters?: MapOfStringToBoolean;
3206 /**
3207 * Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.
3208 */
3209 responseModels?: MapOfStringToString;
3210 }
3211 export type PutMode = "merge"|"overwrite"|string;
3212 export interface PutRestApiRequest {
3213 /**
3214 * [Required] The string identifier of the associated RestApi.
3215 */
3216 restApiId: String;
3217 /**
3218 * The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
3219 */
3220 mode?: PutMode;
3221 /**
3222 * A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.
3223 */
3224 failOnWarnings?: Boolean;
3225 /**
3226 * Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.
3227 */
3228 parameters?: MapOfStringToString;
3229 /**
3230 * [Required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.
3231 */
3232 body: _Blob;
3233 }
3234 export type QuotaPeriodType = "DAY"|"WEEK"|"MONTH"|string;
3235 export interface QuotaSettings {
3236 /**
3237 * The maximum number of requests that can be made in a given time period.
3238 */
3239 limit?: Integer;
3240 /**
3241 * The number of requests subtracted from the given limit in the initial time period.
3242 */
3243 offset?: Integer;
3244 /**
3245 * The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
3246 */
3247 period?: QuotaPeriodType;
3248 }
3249 export interface RequestValidator {
3250 /**
3251 * The identifier of this RequestValidator.
3252 */
3253 id?: String;
3254 /**
3255 * The name of this RequestValidator
3256 */
3257 name?: String;
3258 /**
3259 * A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
3260 */
3261 validateRequestBody?: Boolean;
3262 /**
3263 * A Boolean flag to indicate whether to validate request parameters (true) or not (false).
3264 */
3265 validateRequestParameters?: Boolean;
3266 }
3267 export interface RequestValidators {
3268 position?: String;
3269 /**
3270 * The current page of elements from this collection.
3271 */
3272 items?: ListOfRequestValidator;
3273 }
3274 export interface Resource {
3275 /**
3276 * The resource's identifier.
3277 */
3278 id?: String;
3279 /**
3280 * The parent resource's identifier.
3281 */
3282 parentId?: String;
3283 /**
3284 * The last path segment for this resource.
3285 */
3286 pathPart?: String;
3287 /**
3288 * The full path for this resource.
3289 */
3290 path?: String;
3291 /**
3292 * Gets an API resource's method of a given HTTP verb. The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request. Example: Get the GET method of an API resource Request GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}", "templated": true } }, "apiKeyRequired": false, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{\n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } } If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.
3293 */
3294 resourceMethods?: MapOfMethod;
3295 }
3296 export interface Resources {
3297 position?: String;
3298 /**
3299 * The current page of elements from this collection.
3300 */
3301 items?: ListOfResource;
3302 }
3303 export interface RestApi {
3304 /**
3305 * The API's identifier. This identifier is unique across all of your APIs in API Gateway.
3306 */
3307 id?: String;
3308 /**
3309 * The API's name.
3310 */
3311 name?: String;
3312 /**
3313 * The API's description.
3314 */
3315 description?: String;
3316 /**
3317 * The timestamp when the API was created.
3318 */
3319 createdDate?: Timestamp;
3320 /**
3321 * A version identifier for the API.
3322 */
3323 version?: String;
3324 /**
3325 * The warning messages reported when failonwarnings is turned on during API import.
3326 */
3327 warnings?: ListOfString;
3328 /**
3329 * The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
3330 */
3331 binaryMediaTypes?: ListOfString;
3332 /**
3333 * A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
3334 */
3335 minimumCompressionSize?: NullableInteger;
3336 /**
3337 * The source of the API key for metering requests according to a usage plan. Valid values are: HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
3338 */
3339 apiKeySource?: ApiKeySourceType;
3340 /**
3341 * The endpoint configuration of this RestApi showing the endpoint types of the API.
3342 */
3343 endpointConfiguration?: EndpointConfiguration;
3344 /**
3345 * A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
3346 */
3347 policy?: String;
3348 /**
3349 * The collection of tags. Each tag element is associated with a given resource.
3350 */
3351 tags?: MapOfStringToString;
3352 }
3353 export interface RestApis {
3354 position?: String;
3355 /**
3356 * The current page of elements from this collection.
3357 */
3358 items?: ListOfRestApi;
3359 }
3360 export interface SdkConfigurationProperty {
3361 /**
3362 * The name of a an SdkType configuration property.
3363 */
3364 name?: String;
3365 /**
3366 * The user-friendly name of an SdkType configuration property.
3367 */
3368 friendlyName?: String;
3369 /**
3370 * The description of an SdkType configuration property.
3371 */
3372 description?: String;
3373 /**
3374 * A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false).
3375 */
3376 required?: Boolean;
3377 /**
3378 * The default value of an SdkType configuration property.
3379 */
3380 defaultValue?: String;
3381 }
3382 export interface SdkResponse {
3383 /**
3384 * The content-type header value in the HTTP response.
3385 */
3386 contentType?: String;
3387 /**
3388 * The content-disposition header value in the HTTP response.
3389 */
3390 contentDisposition?: String;
3391 /**
3392 * The binary blob response to GetSdk, which contains the generated SDK.
3393 */
3394 body?: _Blob;
3395 }
3396 export interface SdkType {
3397 /**
3398 * The identifier of an SdkType instance.
3399 */
3400 id?: String;
3401 /**
3402 * The user-friendly name of an SdkType instance.
3403 */
3404 friendlyName?: String;
3405 /**
3406 * The description of an SdkType.
3407 */
3408 description?: String;
3409 /**
3410 * A list of configuration properties of an SdkType.
3411 */
3412 configurationProperties?: ListOfSdkConfigurationProperty;
3413 }
3414 export interface SdkTypes {
3415 position?: String;
3416 /**
3417 * The current page of elements from this collection.
3418 */
3419 items?: ListOfSdkType;
3420 }
3421 export type SecurityPolicy = "TLS_1_0"|"TLS_1_2"|string;
3422 export interface Stage {
3423 /**
3424 * The identifier of the Deployment that the stage points to.
3425 */
3426 deploymentId?: String;
3427 /**
3428 * The identifier of a client certificate for an API stage.
3429 */
3430 clientCertificateId?: String;
3431 /**
3432 * The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
3433 */
3434 stageName?: String;
3435 /**
3436 * The stage's description.
3437 */
3438 description?: String;
3439 /**
3440 * Specifies whether a cache cluster is enabled for the stage.
3441 */
3442 cacheClusterEnabled?: Boolean;
3443 /**
3444 * The size of the cache cluster for the stage, if enabled.
3445 */
3446 cacheClusterSize?: CacheClusterSize;
3447 /**
3448 * The status of the cache cluster for the stage, if enabled.
3449 */
3450 cacheClusterStatus?: CacheClusterStatus;
3451 /**
3452 * A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*\* for overriding all methods in the stage.
3453 */
3454 methodSettings?: MapOfMethodSettings;
3455 /**
3456 * A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&amp;=,]+.
3457 */
3458 variables?: MapOfStringToString;
3459 /**
3460 * The version of the associated API documentation.
3461 */
3462 documentationVersion?: String;
3463 /**
3464 * Settings for logging access in this stage.
3465 */
3466 accessLogSettings?: AccessLogSettings;
3467 /**
3468 * Settings for the canary deployment in this stage.
3469 */
3470 canarySettings?: CanarySettings;
3471 /**
3472 * Specifies whether active tracing with X-ray is enabled for the Stage.
3473 */
3474 tracingEnabled?: Boolean;
3475 /**
3476 * The ARN of the WebAcl associated with the Stage.
3477 */
3478 webAclArn?: String;
3479 /**
3480 * The collection of tags. Each tag element is associated with a given resource.
3481 */
3482 tags?: MapOfStringToString;
3483 /**
3484 * The timestamp when the stage was created.
3485 */
3486 createdDate?: Timestamp;
3487 /**
3488 * The timestamp when the stage last updated.
3489 */
3490 lastUpdatedDate?: Timestamp;
3491 }
3492 export interface StageKey {
3493 /**
3494 * The string identifier of the associated RestApi.
3495 */
3496 restApiId?: String;
3497 /**
3498 * The stage name associated with the stage key.
3499 */
3500 stageName?: String;
3501 }
3502 export interface Stages {
3503 /**
3504 * The current page of elements from this collection.
3505 */
3506 item?: ListOfStage;
3507 }
3508 export type StatusCode = string;
3509 export type String = string;
3510 export interface TagResourceRequest {
3511 /**
3512 * [Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.
3513 */
3514 resourceArn: String;
3515 /**
3516 * [Required] The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
3517 */
3518 tags: MapOfStringToString;
3519 }
3520 export interface Tags {
3521 /**
3522 * The collection of tags. Each tag element is associated with a given resource.
3523 */
3524 tags?: MapOfStringToString;
3525 }
3526 export interface Template {
3527 /**
3528 * The Apache Velocity Template Language (VTL) template content used for the template resource.
3529 */
3530 value?: String;
3531 }
3532 export interface TestInvokeAuthorizerRequest {
3533 /**
3534 * [Required] The string identifier of the associated RestApi.
3535 */
3536 restApiId: String;
3537 /**
3538 * [Required] Specifies a test invoke authorizer request's Authorizer ID.
3539 */
3540 authorizerId: String;
3541 /**
3542 * [Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.
3543 */
3544 headers?: MapOfStringToString;
3545 /**
3546 * [Optional] The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.
3547 */
3548 multiValueHeaders?: MapOfStringToList;
3549 /**
3550 * [Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
3551 */
3552 pathWithQueryString?: String;
3553 /**
3554 * [Optional] The simulated request body of an incoming invocation request.
3555 */
3556 body?: String;
3557 /**
3558 * A key-value map of stage variables to simulate an invocation on a deployed Stage.
3559 */
3560 stageVariables?: MapOfStringToString;
3561 /**
3562 * [Optional] A key-value map of additional context variables.
3563 */
3564 additionalContext?: MapOfStringToString;
3565 }
3566 export interface TestInvokeAuthorizerResponse {
3567 /**
3568 * The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.
3569 */
3570 clientStatus?: Integer;
3571 /**
3572 * The API Gateway execution log for the test authorizer request.
3573 */
3574 log?: String;
3575 /**
3576 * The execution latency of the test authorizer request.
3577 */
3578 latency?: Long;
3579 /**
3580 * The principal identity returned by the Authorizer
3581 */
3582 principalId?: String;
3583 /**
3584 * The JSON policy document returned by the Authorizer
3585 */
3586 policy?: String;
3587 authorization?: MapOfStringToList;
3588 /**
3589 * The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
3590 */
3591 claims?: MapOfStringToString;
3592 }
3593 export interface TestInvokeMethodRequest {
3594 /**
3595 * [Required] The string identifier of the associated RestApi.
3596 */
3597 restApiId: String;
3598 /**
3599 * [Required] Specifies a test invoke method request's resource ID.
3600 */
3601 resourceId: String;
3602 /**
3603 * [Required] Specifies a test invoke method request's HTTP method.
3604 */
3605 httpMethod: String;
3606 /**
3607 * The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
3608 */
3609 pathWithQueryString?: String;
3610 /**
3611 * The simulated request body of an incoming invocation request.
3612 */
3613 body?: String;
3614 /**
3615 * A key-value map of headers to simulate an incoming invocation request.
3616 */
3617 headers?: MapOfStringToString;
3618 /**
3619 * The headers as a map from string to list of values to simulate an incoming invocation request.
3620 */
3621 multiValueHeaders?: MapOfStringToList;
3622 /**
3623 * A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
3624 */
3625 clientCertificateId?: String;
3626 /**
3627 * A key-value map of stage variables to simulate an invocation on a deployed Stage.
3628 */
3629 stageVariables?: MapOfStringToString;
3630 }
3631 export interface TestInvokeMethodResponse {
3632 /**
3633 * The HTTP status code.
3634 */
3635 status?: Integer;
3636 /**
3637 * The body of the HTTP response.
3638 */
3639 body?: String;
3640 /**
3641 * The headers of the HTTP response.
3642 */
3643 headers?: MapOfStringToString;
3644 /**
3645 * The headers of the HTTP response as a map from string to list of values.
3646 */
3647 multiValueHeaders?: MapOfStringToList;
3648 /**
3649 * The API Gateway execution log for the test invoke request.
3650 */
3651 log?: String;
3652 /**
3653 * The execution latency of the test invoke request.
3654 */
3655 latency?: Long;
3656 }
3657 export interface ThrottleSettings {
3658 /**
3659 * The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
3660 */
3661 burstLimit?: Integer;
3662 /**
3663 * The API request steady-state rate limit.
3664 */
3665 rateLimit?: Double;
3666 }
3667 export type Timestamp = Date;
3668 export type UnauthorizedCacheControlHeaderStrategy = "FAIL_WITH_403"|"SUCCEED_WITH_RESPONSE_HEADER"|"SUCCEED_WITHOUT_RESPONSE_HEADER"|string;
3669 export interface UntagResourceRequest {
3670 /**
3671 * [Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.
3672 */
3673 resourceArn: String;
3674 /**
3675 * [Required] The Tag keys to delete.
3676 */
3677 tagKeys: ListOfString;
3678 }
3679 export interface UpdateAccountRequest {
3680 /**
3681 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3682 */
3683 patchOperations?: ListOfPatchOperation;
3684 }
3685 export interface UpdateApiKeyRequest {
3686 /**
3687 * [Required] The identifier of the ApiKey resource to be updated.
3688 */
3689 apiKey: String;
3690 /**
3691 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3692 */
3693 patchOperations?: ListOfPatchOperation;
3694 }
3695 export interface UpdateAuthorizerRequest {
3696 /**
3697 * [Required] The string identifier of the associated RestApi.
3698 */
3699 restApiId: String;
3700 /**
3701 * [Required] The identifier of the Authorizer resource.
3702 */
3703 authorizerId: String;
3704 /**
3705 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3706 */
3707 patchOperations?: ListOfPatchOperation;
3708 }
3709 export interface UpdateBasePathMappingRequest {
3710 /**
3711 * [Required] The domain name of the BasePathMapping resource to change.
3712 */
3713 domainName: String;
3714 /**
3715 * [Required] The base path of the BasePathMapping resource to change. To specify an empty base path, set this parameter to '(none)'.
3716 */
3717 basePath: String;
3718 /**
3719 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3720 */
3721 patchOperations?: ListOfPatchOperation;
3722 }
3723 export interface UpdateClientCertificateRequest {
3724 /**
3725 * [Required] The identifier of the ClientCertificate resource to be updated.
3726 */
3727 clientCertificateId: String;
3728 /**
3729 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3730 */
3731 patchOperations?: ListOfPatchOperation;
3732 }
3733 export interface UpdateDeploymentRequest {
3734 /**
3735 * [Required] The string identifier of the associated RestApi.
3736 */
3737 restApiId: String;
3738 /**
3739 * The replacement identifier for the Deployment resource to change information about.
3740 */
3741 deploymentId: String;
3742 /**
3743 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3744 */
3745 patchOperations?: ListOfPatchOperation;
3746 }
3747 export interface UpdateDocumentationPartRequest {
3748 /**
3749 * [Required] The string identifier of the associated RestApi.
3750 */
3751 restApiId: String;
3752 /**
3753 * [Required] The identifier of the to-be-updated documentation part.
3754 */
3755 documentationPartId: String;
3756 /**
3757 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3758 */
3759 patchOperations?: ListOfPatchOperation;
3760 }
3761 export interface UpdateDocumentationVersionRequest {
3762 /**
3763 * [Required] The string identifier of the associated RestApi..
3764 */
3765 restApiId: String;
3766 /**
3767 * [Required] The version identifier of the to-be-updated documentation version.
3768 */
3769 documentationVersion: String;
3770 /**
3771 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3772 */
3773 patchOperations?: ListOfPatchOperation;
3774 }
3775 export interface UpdateDomainNameRequest {
3776 /**
3777 * [Required] The name of the DomainName resource to be changed.
3778 */
3779 domainName: String;
3780 /**
3781 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3782 */
3783 patchOperations?: ListOfPatchOperation;
3784 }
3785 export interface UpdateGatewayResponseRequest {
3786 /**
3787 * [Required] The string identifier of the associated RestApi.
3788 */
3789 restApiId: String;
3790 /**
3791 * [Required] The response type of the associated GatewayResponse. Valid values are ACCESS_DENIEDAPI_CONFIGURATION_ERRORAUTHORIZER_FAILURE AUTHORIZER_CONFIGURATION_ERRORBAD_REQUEST_PARAMETERSBAD_REQUEST_BODYDEFAULT_4XXDEFAULT_5XXEXPIRED_TOKENINVALID_SIGNATUREINTEGRATION_FAILUREINTEGRATION_TIMEOUTINVALID_API_KEYMISSING_AUTHENTICATION_TOKEN QUOTA_EXCEEDEDREQUEST_TOO_LARGERESOURCE_NOT_FOUNDTHROTTLEDUNAUTHORIZEDUNSUPPORTED_MEDIA_TYPE
3792 */
3793 responseType: GatewayResponseType;
3794 /**
3795 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3796 */
3797 patchOperations?: ListOfPatchOperation;
3798 }
3799 export interface UpdateIntegrationRequest {
3800 /**
3801 * [Required] The string identifier of the associated RestApi.
3802 */
3803 restApiId: String;
3804 /**
3805 * [Required] Represents an update integration request's resource identifier.
3806 */
3807 resourceId: String;
3808 /**
3809 * [Required] Represents an update integration request's HTTP method.
3810 */
3811 httpMethod: String;
3812 /**
3813 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3814 */
3815 patchOperations?: ListOfPatchOperation;
3816 }
3817 export interface UpdateIntegrationResponseRequest {
3818 /**
3819 * [Required] The string identifier of the associated RestApi.
3820 */
3821 restApiId: String;
3822 /**
3823 * [Required] Specifies an update integration response request's resource identifier.
3824 */
3825 resourceId: String;
3826 /**
3827 * [Required] Specifies an update integration response request's HTTP method.
3828 */
3829 httpMethod: String;
3830 /**
3831 * [Required] Specifies an update integration response request's status code.
3832 */
3833 statusCode: StatusCode;
3834 /**
3835 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3836 */
3837 patchOperations?: ListOfPatchOperation;
3838 }
3839 export interface UpdateMethodRequest {
3840 /**
3841 * [Required] The string identifier of the associated RestApi.
3842 */
3843 restApiId: String;
3844 /**
3845 * [Required] The Resource identifier for the Method resource.
3846 */
3847 resourceId: String;
3848 /**
3849 * [Required] The HTTP verb of the Method resource.
3850 */
3851 httpMethod: String;
3852 /**
3853 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3854 */
3855 patchOperations?: ListOfPatchOperation;
3856 }
3857 export interface UpdateMethodResponseRequest {
3858 /**
3859 * [Required] The string identifier of the associated RestApi.
3860 */
3861 restApiId: String;
3862 /**
3863 * [Required] The Resource identifier for the MethodResponse resource.
3864 */
3865 resourceId: String;
3866 /**
3867 * [Required] The HTTP verb of the Method resource.
3868 */
3869 httpMethod: String;
3870 /**
3871 * [Required] The status code for the MethodResponse resource.
3872 */
3873 statusCode: StatusCode;
3874 /**
3875 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3876 */
3877 patchOperations?: ListOfPatchOperation;
3878 }
3879 export interface UpdateModelRequest {
3880 /**
3881 * [Required] The string identifier of the associated RestApi.
3882 */
3883 restApiId: String;
3884 /**
3885 * [Required] The name of the model to update.
3886 */
3887 modelName: String;
3888 /**
3889 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3890 */
3891 patchOperations?: ListOfPatchOperation;
3892 }
3893 export interface UpdateRequestValidatorRequest {
3894 /**
3895 * [Required] The string identifier of the associated RestApi.
3896 */
3897 restApiId: String;
3898 /**
3899 * [Required] The identifier of RequestValidator to be updated.
3900 */
3901 requestValidatorId: String;
3902 /**
3903 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3904 */
3905 patchOperations?: ListOfPatchOperation;
3906 }
3907 export interface UpdateResourceRequest {
3908 /**
3909 * [Required] The string identifier of the associated RestApi.
3910 */
3911 restApiId: String;
3912 /**
3913 * [Required] The identifier of the Resource resource.
3914 */
3915 resourceId: String;
3916 /**
3917 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3918 */
3919 patchOperations?: ListOfPatchOperation;
3920 }
3921 export interface UpdateRestApiRequest {
3922 /**
3923 * [Required] The string identifier of the associated RestApi.
3924 */
3925 restApiId: String;
3926 /**
3927 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3928 */
3929 patchOperations?: ListOfPatchOperation;
3930 }
3931 export interface UpdateStageRequest {
3932 /**
3933 * [Required] The string identifier of the associated RestApi.
3934 */
3935 restApiId: String;
3936 /**
3937 * [Required] The name of the Stage resource to change information about.
3938 */
3939 stageName: String;
3940 /**
3941 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3942 */
3943 patchOperations?: ListOfPatchOperation;
3944 }
3945 export interface UpdateUsagePlanRequest {
3946 /**
3947 * [Required] The Id of the to-be-updated usage plan.
3948 */
3949 usagePlanId: String;
3950 /**
3951 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3952 */
3953 patchOperations?: ListOfPatchOperation;
3954 }
3955 export interface UpdateUsageRequest {
3956 /**
3957 * [Required] The Id of the usage plan associated with the usage data.
3958 */
3959 usagePlanId: String;
3960 /**
3961 * [Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.
3962 */
3963 keyId: String;
3964 /**
3965 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3966 */
3967 patchOperations?: ListOfPatchOperation;
3968 }
3969 export interface UpdateVpcLinkRequest {
3970 /**
3971 * [Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
3972 */
3973 vpcLinkId: String;
3974 /**
3975 * A list of update operations to be applied to the specified resource and in the order specified in this list.
3976 */
3977 patchOperations?: ListOfPatchOperation;
3978 }
3979 export interface Usage {
3980 /**
3981 * The plan Id associated with this usage data.
3982 */
3983 usagePlanId?: String;
3984 /**
3985 * The starting date of the usage data.
3986 */
3987 startDate?: String;
3988 /**
3989 * The ending date of the usage data.
3990 */
3991 endDate?: String;
3992 position?: String;
3993 /**
3994 * The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].
3995 */
3996 items?: MapOfKeyUsages;
3997 }
3998 export interface UsagePlan {
3999 /**
4000 * The identifier of a UsagePlan resource.
4001 */
4002 id?: String;
4003 /**
4004 * The name of a usage plan.
4005 */
4006 name?: String;
4007 /**
4008 * The description of a usage plan.
4009 */
4010 description?: String;
4011 /**
4012 * The associated API stages of a usage plan.
4013 */
4014 apiStages?: ListOfApiStage;
4015 /**
4016 * The request throttle limits of a usage plan.
4017 */
4018 throttle?: ThrottleSettings;
4019 /**
4020 * The maximum number of permitted requests per a given unit time interval.
4021 */
4022 quota?: QuotaSettings;
4023 /**
4024 * The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
4025 */
4026 productCode?: String;
4027 /**
4028 * The collection of tags. Each tag element is associated with a given resource.
4029 */
4030 tags?: MapOfStringToString;
4031 }
4032 export interface UsagePlanKey {
4033 /**
4034 * The Id of a usage plan key.
4035 */
4036 id?: String;
4037 /**
4038 * The type of a usage plan key. Currently, the valid key type is API_KEY.
4039 */
4040 type?: String;
4041 /**
4042 * The value of a usage plan key.
4043 */
4044 value?: String;
4045 /**
4046 * The name of a usage plan key.
4047 */
4048 name?: String;
4049 }
4050 export interface UsagePlanKeys {
4051 position?: String;
4052 /**
4053 * The current page of elements from this collection.
4054 */
4055 items?: ListOfUsagePlanKey;
4056 }
4057 export interface UsagePlans {
4058 position?: String;
4059 /**
4060 * The current page of elements from this collection.
4061 */
4062 items?: ListOfUsagePlan;
4063 }
4064 export interface VpcLink {
4065 /**
4066 * The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
4067 */
4068 id?: String;
4069 /**
4070 * The name used to label and identify the VPC link.
4071 */
4072 name?: String;
4073 /**
4074 * The description of the VPC link.
4075 */
4076 description?: String;
4077 /**
4078 * The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.
4079 */
4080 targetArns?: ListOfString;
4081 /**
4082 * The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.
4083 */
4084 status?: VpcLinkStatus;
4085 /**
4086 * A description about the VPC link status.
4087 */
4088 statusMessage?: String;
4089 /**
4090 * The collection of tags. Each tag element is associated with a given resource.
4091 */
4092 tags?: MapOfStringToString;
4093 }
4094 export type VpcLinkStatus = "AVAILABLE"|"PENDING"|"DELETING"|"FAILED"|string;
4095 export interface VpcLinks {
4096 position?: String;
4097 /**
4098 * The current page of elements from this collection.
4099 */
4100 items?: ListOfVpcLink;
4101 }
4102 /**
4103 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
4104 */
4105 export type apiVersion = "2015-07-09"|"latest"|string;
4106 export interface ClientApiVersions {
4107 /**
4108 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
4109 */
4110 apiVersion?: apiVersion;
4111 }
4112 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
4113 /**
4114 * Contains interfaces for use with the APIGateway client.
4115 */
4116 export import Types = APIGateway;
4117}
4118export = APIGateway;