@aws-sdk/client-apigatewayv2 3.296.0 → 3.297.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/ApiGatewayV2.d.ts +75 -0
- package/dist-types/ApiGatewayV2Client.d.ts +24 -4
- package/dist-types/commands/CreateApiCommand.d.ts +16 -0
- package/dist-types/commands/CreateApiMappingCommand.d.ts +16 -0
- package/dist-types/commands/CreateAuthorizerCommand.d.ts +16 -0
- package/dist-types/commands/CreateDeploymentCommand.d.ts +16 -0
- package/dist-types/commands/CreateDomainNameCommand.d.ts +16 -0
- package/dist-types/commands/CreateIntegrationCommand.d.ts +16 -0
- package/dist-types/commands/CreateIntegrationResponseCommand.d.ts +16 -0
- package/dist-types/commands/CreateModelCommand.d.ts +16 -0
- package/dist-types/commands/CreateRouteCommand.d.ts +16 -0
- package/dist-types/commands/CreateRouteResponseCommand.d.ts +16 -0
- package/dist-types/commands/CreateStageCommand.d.ts +16 -0
- package/dist-types/commands/CreateVpcLinkCommand.d.ts +16 -0
- package/dist-types/commands/DeleteAccessLogSettingsCommand.d.ts +16 -0
- package/dist-types/commands/DeleteApiCommand.d.ts +16 -0
- package/dist-types/commands/DeleteApiMappingCommand.d.ts +16 -0
- package/dist-types/commands/DeleteAuthorizerCommand.d.ts +16 -0
- package/dist-types/commands/DeleteCorsConfigurationCommand.d.ts +16 -0
- package/dist-types/commands/DeleteDeploymentCommand.d.ts +16 -0
- package/dist-types/commands/DeleteDomainNameCommand.d.ts +16 -0
- package/dist-types/commands/DeleteIntegrationCommand.d.ts +16 -0
- package/dist-types/commands/DeleteIntegrationResponseCommand.d.ts +16 -0
- package/dist-types/commands/DeleteModelCommand.d.ts +16 -0
- package/dist-types/commands/DeleteRouteCommand.d.ts +16 -0
- package/dist-types/commands/DeleteRouteRequestParameterCommand.d.ts +16 -0
- package/dist-types/commands/DeleteRouteResponseCommand.d.ts +16 -0
- package/dist-types/commands/DeleteRouteSettingsCommand.d.ts +16 -0
- package/dist-types/commands/DeleteStageCommand.d.ts +16 -0
- package/dist-types/commands/DeleteVpcLinkCommand.d.ts +16 -0
- package/dist-types/commands/ExportApiCommand.d.ts +13 -0
- package/dist-types/commands/GetApiCommand.d.ts +16 -0
- package/dist-types/commands/GetApiMappingCommand.d.ts +16 -0
- package/dist-types/commands/GetApiMappingsCommand.d.ts +16 -0
- package/dist-types/commands/GetApisCommand.d.ts +16 -0
- package/dist-types/commands/GetAuthorizerCommand.d.ts +16 -0
- package/dist-types/commands/GetAuthorizersCommand.d.ts +16 -0
- package/dist-types/commands/GetDeploymentCommand.d.ts +16 -0
- package/dist-types/commands/GetDeploymentsCommand.d.ts +16 -0
- package/dist-types/commands/GetDomainNameCommand.d.ts +16 -0
- package/dist-types/commands/GetDomainNamesCommand.d.ts +16 -0
- package/dist-types/commands/GetIntegrationCommand.d.ts +16 -0
- package/dist-types/commands/GetIntegrationResponseCommand.d.ts +16 -0
- package/dist-types/commands/GetIntegrationResponsesCommand.d.ts +16 -0
- package/dist-types/commands/GetIntegrationsCommand.d.ts +16 -0
- package/dist-types/commands/GetModelCommand.d.ts +16 -0
- package/dist-types/commands/GetModelTemplateCommand.d.ts +16 -0
- package/dist-types/commands/GetModelsCommand.d.ts +16 -0
- package/dist-types/commands/GetRouteCommand.d.ts +16 -0
- package/dist-types/commands/GetRouteResponseCommand.d.ts +16 -0
- package/dist-types/commands/GetRouteResponsesCommand.d.ts +16 -0
- package/dist-types/commands/GetRoutesCommand.d.ts +16 -0
- package/dist-types/commands/GetStageCommand.d.ts +16 -0
- package/dist-types/commands/GetStagesCommand.d.ts +16 -0
- package/dist-types/commands/GetTagsCommand.d.ts +16 -0
- package/dist-types/commands/GetVpcLinkCommand.d.ts +16 -0
- package/dist-types/commands/GetVpcLinksCommand.d.ts +16 -0
- package/dist-types/commands/ImportApiCommand.d.ts +16 -0
- package/dist-types/commands/ReimportApiCommand.d.ts +16 -0
- package/dist-types/commands/ResetAuthorizersCacheCommand.d.ts +16 -0
- package/dist-types/commands/TagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateApiCommand.d.ts +16 -0
- package/dist-types/commands/UpdateApiMappingCommand.d.ts +16 -0
- package/dist-types/commands/UpdateAuthorizerCommand.d.ts +16 -0
- package/dist-types/commands/UpdateDeploymentCommand.d.ts +16 -0
- package/dist-types/commands/UpdateDomainNameCommand.d.ts +16 -0
- package/dist-types/commands/UpdateIntegrationCommand.d.ts +16 -0
- package/dist-types/commands/UpdateIntegrationResponseCommand.d.ts +16 -0
- package/dist-types/commands/UpdateModelCommand.d.ts +16 -0
- package/dist-types/commands/UpdateRouteCommand.d.ts +16 -0
- package/dist-types/commands/UpdateRouteResponseCommand.d.ts +16 -0
- package/dist-types/commands/UpdateStageCommand.d.ts +16 -0
- package/dist-types/commands/UpdateVpcLinkCommand.d.ts +16 -0
- package/dist-types/models/ApiGatewayV2ServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +465 -63
- package/package.json +3 -3
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { ApiGatewayV2ServiceException as __BaseException } from "./ApiGatewayV2ServiceException";
|
|
3
3
|
/**
|
|
4
|
+
* @public
|
|
4
5
|
* <p>Represents a CORS configuration. Supported only for HTTP APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html">Configuring CORS</a> for more information.</p>
|
|
5
6
|
*/
|
|
6
7
|
export interface Cors {
|
|
@@ -29,16 +30,20 @@ export interface Cors {
|
|
|
29
30
|
*/
|
|
30
31
|
MaxAge?: number;
|
|
31
32
|
}
|
|
33
|
+
/**
|
|
34
|
+
* @public
|
|
35
|
+
*/
|
|
32
36
|
export declare enum ProtocolType {
|
|
33
37
|
HTTP = "HTTP",
|
|
34
38
|
WEBSOCKET = "WEBSOCKET"
|
|
35
39
|
}
|
|
36
40
|
/**
|
|
41
|
+
* @public
|
|
37
42
|
* <p>Represents an API.</p>
|
|
38
43
|
*/
|
|
39
44
|
export interface Api {
|
|
40
45
|
/**
|
|
41
|
-
* <p>The URI of the API, of the form {api-id}.execute-api
|
|
46
|
+
* <p>The URI of the API, of the form \{api-id\}.execute-api.\{region\}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>
|
|
42
47
|
*/
|
|
43
48
|
ApiEndpoint?: string;
|
|
44
49
|
/**
|
|
@@ -70,7 +75,7 @@ export interface Api {
|
|
|
70
75
|
*/
|
|
71
76
|
DisableSchemaValidation?: boolean;
|
|
72
77
|
/**
|
|
73
|
-
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https
|
|
78
|
+
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://\{api_id\}.execute-api.\{region\}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
|
|
74
79
|
*/
|
|
75
80
|
DisableExecuteApiEndpoint?: boolean;
|
|
76
81
|
/**
|
|
@@ -86,7 +91,7 @@ export interface Api {
|
|
|
86
91
|
*/
|
|
87
92
|
ProtocolType: ProtocolType | string | undefined;
|
|
88
93
|
/**
|
|
89
|
-
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be
|
|
94
|
+
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
90
95
|
*/
|
|
91
96
|
RouteSelectionExpression: string | undefined;
|
|
92
97
|
/**
|
|
@@ -103,6 +108,7 @@ export interface Api {
|
|
|
103
108
|
Warnings?: string[];
|
|
104
109
|
}
|
|
105
110
|
/**
|
|
111
|
+
* @public
|
|
106
112
|
* <p>Represents an API mapping.</p>
|
|
107
113
|
*/
|
|
108
114
|
export interface ApiMapping {
|
|
@@ -123,11 +129,15 @@ export interface ApiMapping {
|
|
|
123
129
|
*/
|
|
124
130
|
Stage: string | undefined;
|
|
125
131
|
}
|
|
132
|
+
/**
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
126
135
|
export declare enum AuthorizerType {
|
|
127
136
|
JWT = "JWT",
|
|
128
137
|
REQUEST = "REQUEST"
|
|
129
138
|
}
|
|
130
139
|
/**
|
|
140
|
+
* @public
|
|
131
141
|
* <p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>
|
|
132
142
|
*/
|
|
133
143
|
export interface JWTConfiguration {
|
|
@@ -136,12 +146,13 @@ export interface JWTConfiguration {
|
|
|
136
146
|
*/
|
|
137
147
|
Audience?: string[];
|
|
138
148
|
/**
|
|
139
|
-
* <p>The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.<replaceable
|
|
149
|
+
* <p>The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.<replaceable>\{region\}</replaceable>.amazonaws.com/<replaceable>\{userPoolId\}</replaceable>
|
|
140
150
|
* . Required for the JWT authorizer type. Supported only for HTTP APIs.</p>
|
|
141
151
|
*/
|
|
142
152
|
Issuer?: string;
|
|
143
153
|
}
|
|
144
154
|
/**
|
|
155
|
+
* @public
|
|
145
156
|
* <p>Represents an authorizer.</p>
|
|
146
157
|
*/
|
|
147
158
|
export interface Authorizer {
|
|
@@ -166,8 +177,8 @@ export interface Authorizer {
|
|
|
166
177
|
*/
|
|
167
178
|
AuthorizerType?: AuthorizerType | string;
|
|
168
179
|
/**
|
|
169
|
-
* <p>The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable
|
|
170
|
-
* , where <replaceable></replaceable
|
|
180
|
+
* <p>The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable>\{account_id\}</replaceable>:function:<replaceable>\{lambda_function_name\}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>\{region\}</replaceable>:lambda:path/<replaceable>\{service_api\}</replaceable>
|
|
181
|
+
* , where <replaceable></replaceable>\{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. Supported only for REQUEST authorizers.</p>
|
|
171
182
|
*/
|
|
172
183
|
AuthorizerUri?: string;
|
|
173
184
|
/**
|
|
@@ -191,12 +202,16 @@ export interface Authorizer {
|
|
|
191
202
|
*/
|
|
192
203
|
Name: string | undefined;
|
|
193
204
|
}
|
|
205
|
+
/**
|
|
206
|
+
* @public
|
|
207
|
+
*/
|
|
194
208
|
export declare enum DeploymentStatus {
|
|
195
209
|
DEPLOYED = "DEPLOYED",
|
|
196
210
|
FAILED = "FAILED",
|
|
197
211
|
PENDING = "PENDING"
|
|
198
212
|
}
|
|
199
213
|
/**
|
|
214
|
+
* @public
|
|
200
215
|
* <p>An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.</p>
|
|
201
216
|
*/
|
|
202
217
|
export interface Deployment {
|
|
@@ -225,21 +240,31 @@ export interface Deployment {
|
|
|
225
240
|
*/
|
|
226
241
|
Description?: string;
|
|
227
242
|
}
|
|
243
|
+
/**
|
|
244
|
+
* @public
|
|
245
|
+
*/
|
|
228
246
|
export declare enum DomainNameStatus {
|
|
229
247
|
AVAILABLE = "AVAILABLE",
|
|
230
248
|
PENDING_CERTIFICATE_REIMPORT = "PENDING_CERTIFICATE_REIMPORT",
|
|
231
249
|
PENDING_OWNERSHIP_VERIFICATION = "PENDING_OWNERSHIP_VERIFICATION",
|
|
232
250
|
UPDATING = "UPDATING"
|
|
233
251
|
}
|
|
252
|
+
/**
|
|
253
|
+
* @public
|
|
254
|
+
*/
|
|
234
255
|
export declare enum EndpointType {
|
|
235
256
|
EDGE = "EDGE",
|
|
236
257
|
REGIONAL = "REGIONAL"
|
|
237
258
|
}
|
|
259
|
+
/**
|
|
260
|
+
* @public
|
|
261
|
+
*/
|
|
238
262
|
export declare enum SecurityPolicy {
|
|
239
263
|
TLS_1_0 = "TLS_1_0",
|
|
240
264
|
TLS_1_2 = "TLS_1_2"
|
|
241
265
|
}
|
|
242
266
|
/**
|
|
267
|
+
* @public
|
|
243
268
|
* <p>The domain name configuration.</p>
|
|
244
269
|
*/
|
|
245
270
|
export interface DomainNameConfiguration {
|
|
@@ -284,6 +309,9 @@ export interface DomainNameConfiguration {
|
|
|
284
309
|
*/
|
|
285
310
|
OwnershipVerificationCertificateArn?: string;
|
|
286
311
|
}
|
|
312
|
+
/**
|
|
313
|
+
* @public
|
|
314
|
+
*/
|
|
287
315
|
export interface MutualTlsAuthentication {
|
|
288
316
|
/**
|
|
289
317
|
* <p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>bucket-name</replaceable>/<replaceable>key-name</replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</p>
|
|
@@ -299,6 +327,7 @@ export interface MutualTlsAuthentication {
|
|
|
299
327
|
TruststoreWarnings?: string[];
|
|
300
328
|
}
|
|
301
329
|
/**
|
|
330
|
+
* @public
|
|
302
331
|
* <p>Represents a domain name.</p>
|
|
303
332
|
*/
|
|
304
333
|
export interface DomainName {
|
|
@@ -323,14 +352,23 @@ export interface DomainName {
|
|
|
323
352
|
*/
|
|
324
353
|
Tags?: Record<string, string>;
|
|
325
354
|
}
|
|
355
|
+
/**
|
|
356
|
+
* @public
|
|
357
|
+
*/
|
|
326
358
|
export declare enum ConnectionType {
|
|
327
359
|
INTERNET = "INTERNET",
|
|
328
360
|
VPC_LINK = "VPC_LINK"
|
|
329
361
|
}
|
|
362
|
+
/**
|
|
363
|
+
* @public
|
|
364
|
+
*/
|
|
330
365
|
export declare enum ContentHandlingStrategy {
|
|
331
366
|
CONVERT_TO_BINARY = "CONVERT_TO_BINARY",
|
|
332
367
|
CONVERT_TO_TEXT = "CONVERT_TO_TEXT"
|
|
333
368
|
}
|
|
369
|
+
/**
|
|
370
|
+
* @public
|
|
371
|
+
*/
|
|
334
372
|
export declare enum IntegrationType {
|
|
335
373
|
AWS = "AWS",
|
|
336
374
|
AWS_PROXY = "AWS_PROXY",
|
|
@@ -338,12 +376,16 @@ export declare enum IntegrationType {
|
|
|
338
376
|
HTTP_PROXY = "HTTP_PROXY",
|
|
339
377
|
MOCK = "MOCK"
|
|
340
378
|
}
|
|
379
|
+
/**
|
|
380
|
+
* @public
|
|
381
|
+
*/
|
|
341
382
|
export declare enum PassthroughBehavior {
|
|
342
383
|
NEVER = "NEVER",
|
|
343
384
|
WHEN_NO_MATCH = "WHEN_NO_MATCH",
|
|
344
385
|
WHEN_NO_TEMPLATES = "WHEN_NO_TEMPLATES"
|
|
345
386
|
}
|
|
346
387
|
/**
|
|
388
|
+
* @public
|
|
347
389
|
* <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
|
|
348
390
|
*/
|
|
349
391
|
export interface TlsConfig {
|
|
@@ -353,6 +395,7 @@ export interface TlsConfig {
|
|
|
353
395
|
ServerNameToVerify?: string;
|
|
354
396
|
}
|
|
355
397
|
/**
|
|
398
|
+
* @public
|
|
356
399
|
* <p>Represents an integration.</p>
|
|
357
400
|
*/
|
|
358
401
|
export interface Integration {
|
|
@@ -413,11 +456,11 @@ export interface Integration {
|
|
|
413
456
|
*/
|
|
414
457
|
PayloadFormatVersion?: string;
|
|
415
458
|
/**
|
|
416
|
-
* <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable
|
|
459
|
+
* <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>\{location\}</replaceable>.<replaceable>\{name\}</replaceable>
|
|
417
460
|
* , where
|
|
418
|
-
* <replaceable
|
|
461
|
+
* <replaceable>\{location\}</replaceable>
|
|
419
462
|
* is querystring, path, or header; and
|
|
420
|
-
* <replaceable
|
|
463
|
+
* <replaceable>\{name\}</replaceable>
|
|
421
464
|
* must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
|
|
422
465
|
*/
|
|
423
466
|
RequestParameters?: Record<string, string>;
|
|
@@ -443,6 +486,7 @@ export interface Integration {
|
|
|
443
486
|
TlsConfig?: TlsConfig;
|
|
444
487
|
}
|
|
445
488
|
/**
|
|
489
|
+
* @public
|
|
446
490
|
* <p>Represents an integration response.</p>
|
|
447
491
|
*/
|
|
448
492
|
export interface IntegrationResponse {
|
|
@@ -459,7 +503,7 @@ export interface IntegrationResponse {
|
|
|
459
503
|
*/
|
|
460
504
|
IntegrationResponseKey: string | undefined;
|
|
461
505
|
/**
|
|
462
|
-
* <p>A key-value map specifying response parameters that are passed to the method response from the backend. 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
|
|
506
|
+
* <p>A key-value map specifying response parameters that are passed to the method response from the backend. 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.</p>
|
|
463
507
|
*/
|
|
464
508
|
ResponseParameters?: Record<string, string>;
|
|
465
509
|
/**
|
|
@@ -472,6 +516,7 @@ export interface IntegrationResponse {
|
|
|
472
516
|
TemplateSelectionExpression?: string;
|
|
473
517
|
}
|
|
474
518
|
/**
|
|
519
|
+
* @public
|
|
475
520
|
* <p>Represents a data model for an API. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html">Create Models and Mapping Templates for Request and Response Mappings</a>.</p>
|
|
476
521
|
*/
|
|
477
522
|
export interface Model {
|
|
@@ -496,6 +541,9 @@ export interface Model {
|
|
|
496
541
|
*/
|
|
497
542
|
Schema?: string;
|
|
498
543
|
}
|
|
544
|
+
/**
|
|
545
|
+
* @public
|
|
546
|
+
*/
|
|
499
547
|
export declare enum AuthorizationType {
|
|
500
548
|
AWS_IAM = "AWS_IAM",
|
|
501
549
|
CUSTOM = "CUSTOM",
|
|
@@ -503,6 +551,7 @@ export declare enum AuthorizationType {
|
|
|
503
551
|
NONE = "NONE"
|
|
504
552
|
}
|
|
505
553
|
/**
|
|
554
|
+
* @public
|
|
506
555
|
* <p>Validation constraints imposed on parameters of a request (path, query string, headers).</p>
|
|
507
556
|
*/
|
|
508
557
|
export interface ParameterConstraints {
|
|
@@ -512,6 +561,7 @@ export interface ParameterConstraints {
|
|
|
512
561
|
Required?: boolean;
|
|
513
562
|
}
|
|
514
563
|
/**
|
|
564
|
+
* @public
|
|
515
565
|
* <p>Represents a route.</p>
|
|
516
566
|
*/
|
|
517
567
|
export interface Route {
|
|
@@ -569,6 +619,7 @@ export interface Route {
|
|
|
569
619
|
Target?: string;
|
|
570
620
|
}
|
|
571
621
|
/**
|
|
622
|
+
* @public
|
|
572
623
|
* <p>Represents a route response.</p>
|
|
573
624
|
*/
|
|
574
625
|
export interface RouteResponse {
|
|
@@ -594,6 +645,7 @@ export interface RouteResponse {
|
|
|
594
645
|
RouteResponseKey: string | undefined;
|
|
595
646
|
}
|
|
596
647
|
/**
|
|
648
|
+
* @public
|
|
597
649
|
* <p>Settings for logging access in a stage.</p>
|
|
598
650
|
*/
|
|
599
651
|
export interface AccessLogSettings {
|
|
@@ -606,12 +658,16 @@ export interface AccessLogSettings {
|
|
|
606
658
|
*/
|
|
607
659
|
Format?: string;
|
|
608
660
|
}
|
|
661
|
+
/**
|
|
662
|
+
* @public
|
|
663
|
+
*/
|
|
609
664
|
export declare enum LoggingLevel {
|
|
610
665
|
ERROR = "ERROR",
|
|
611
666
|
INFO = "INFO",
|
|
612
667
|
OFF = "OFF"
|
|
613
668
|
}
|
|
614
669
|
/**
|
|
670
|
+
* @public
|
|
615
671
|
* <p>Represents a collection of route settings.</p>
|
|
616
672
|
*/
|
|
617
673
|
export interface RouteSettings {
|
|
@@ -637,6 +693,7 @@ export interface RouteSettings {
|
|
|
637
693
|
ThrottlingRateLimit?: number;
|
|
638
694
|
}
|
|
639
695
|
/**
|
|
696
|
+
* @public
|
|
640
697
|
* <p>Represents an API stage.</p>
|
|
641
698
|
*/
|
|
642
699
|
export interface Stage {
|
|
@@ -697,6 +754,9 @@ export interface Stage {
|
|
|
697
754
|
*/
|
|
698
755
|
Tags?: Record<string, string>;
|
|
699
756
|
}
|
|
757
|
+
/**
|
|
758
|
+
* @public
|
|
759
|
+
*/
|
|
700
760
|
export declare enum VpcLinkStatus {
|
|
701
761
|
AVAILABLE = "AVAILABLE",
|
|
702
762
|
DELETING = "DELETING",
|
|
@@ -704,10 +764,14 @@ export declare enum VpcLinkStatus {
|
|
|
704
764
|
INACTIVE = "INACTIVE",
|
|
705
765
|
PENDING = "PENDING"
|
|
706
766
|
}
|
|
767
|
+
/**
|
|
768
|
+
* @public
|
|
769
|
+
*/
|
|
707
770
|
export declare enum VpcLinkVersion {
|
|
708
771
|
V2 = "V2"
|
|
709
772
|
}
|
|
710
773
|
/**
|
|
774
|
+
* @public
|
|
711
775
|
* <p>Represents a VPC link.</p>
|
|
712
776
|
*/
|
|
713
777
|
export interface VpcLink {
|
|
@@ -748,6 +812,9 @@ export interface VpcLink {
|
|
|
748
812
|
*/
|
|
749
813
|
VpcLinkVersion?: VpcLinkVersion | string;
|
|
750
814
|
}
|
|
815
|
+
/**
|
|
816
|
+
* @public
|
|
817
|
+
*/
|
|
751
818
|
export declare class AccessDeniedException extends __BaseException {
|
|
752
819
|
readonly name: "AccessDeniedException";
|
|
753
820
|
readonly $fault: "client";
|
|
@@ -758,6 +825,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
758
825
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
759
826
|
}
|
|
760
827
|
/**
|
|
828
|
+
* @public
|
|
761
829
|
* <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
|
|
762
830
|
*/
|
|
763
831
|
export declare class BadRequestException extends __BaseException {
|
|
@@ -773,6 +841,7 @@ export declare class BadRequestException extends __BaseException {
|
|
|
773
841
|
constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
|
|
774
842
|
}
|
|
775
843
|
/**
|
|
844
|
+
* @public
|
|
776
845
|
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
|
|
777
846
|
*/
|
|
778
847
|
export declare class ConflictException extends __BaseException {
|
|
@@ -788,6 +857,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
788
857
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
789
858
|
}
|
|
790
859
|
/**
|
|
860
|
+
* @public
|
|
791
861
|
* <p>Creates a new Api resource to represent an API.</p>
|
|
792
862
|
*/
|
|
793
863
|
export interface CreateApiRequest {
|
|
@@ -812,7 +882,7 @@ export interface CreateApiRequest {
|
|
|
812
882
|
*/
|
|
813
883
|
DisableSchemaValidation?: boolean;
|
|
814
884
|
/**
|
|
815
|
-
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https
|
|
885
|
+
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://\{api_id\}.execute-api.\{region\}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
|
|
816
886
|
*/
|
|
817
887
|
DisableExecuteApiEndpoint?: boolean;
|
|
818
888
|
/**
|
|
@@ -828,7 +898,7 @@ export interface CreateApiRequest {
|
|
|
828
898
|
*/
|
|
829
899
|
RouteKey?: string;
|
|
830
900
|
/**
|
|
831
|
-
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be
|
|
901
|
+
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
832
902
|
*/
|
|
833
903
|
RouteSelectionExpression?: string;
|
|
834
904
|
/**
|
|
@@ -844,9 +914,12 @@ export interface CreateApiRequest {
|
|
|
844
914
|
*/
|
|
845
915
|
Version?: string;
|
|
846
916
|
}
|
|
917
|
+
/**
|
|
918
|
+
* @public
|
|
919
|
+
*/
|
|
847
920
|
export interface CreateApiResponse {
|
|
848
921
|
/**
|
|
849
|
-
* <p>The URI of the API, of the form {api-id}.execute-api
|
|
922
|
+
* <p>The URI of the API, of the form \{api-id\}.execute-api.\{region\}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>
|
|
850
923
|
*/
|
|
851
924
|
ApiEndpoint?: string;
|
|
852
925
|
/**
|
|
@@ -878,7 +951,7 @@ export interface CreateApiResponse {
|
|
|
878
951
|
*/
|
|
879
952
|
DisableSchemaValidation?: boolean;
|
|
880
953
|
/**
|
|
881
|
-
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https
|
|
954
|
+
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://\{api_id\}.execute-api.\{region\}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
|
|
882
955
|
*/
|
|
883
956
|
DisableExecuteApiEndpoint?: boolean;
|
|
884
957
|
/**
|
|
@@ -894,7 +967,7 @@ export interface CreateApiResponse {
|
|
|
894
967
|
*/
|
|
895
968
|
ProtocolType?: ProtocolType | string;
|
|
896
969
|
/**
|
|
897
|
-
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be
|
|
970
|
+
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
898
971
|
*/
|
|
899
972
|
RouteSelectionExpression?: string;
|
|
900
973
|
/**
|
|
@@ -911,6 +984,7 @@ export interface CreateApiResponse {
|
|
|
911
984
|
Warnings?: string[];
|
|
912
985
|
}
|
|
913
986
|
/**
|
|
987
|
+
* @public
|
|
914
988
|
* <p>The resource specified in the request was not found. See the message field for more information.</p>
|
|
915
989
|
*/
|
|
916
990
|
export declare class NotFoundException extends __BaseException {
|
|
@@ -930,6 +1004,7 @@ export declare class NotFoundException extends __BaseException {
|
|
|
930
1004
|
constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
|
|
931
1005
|
}
|
|
932
1006
|
/**
|
|
1007
|
+
* @public
|
|
933
1008
|
* <p>A limit has been exceeded. See the accompanying error message for details.</p>
|
|
934
1009
|
*/
|
|
935
1010
|
export declare class TooManyRequestsException extends __BaseException {
|
|
@@ -949,6 +1024,7 @@ export declare class TooManyRequestsException extends __BaseException {
|
|
|
949
1024
|
constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
|
|
950
1025
|
}
|
|
951
1026
|
/**
|
|
1027
|
+
* @public
|
|
952
1028
|
* <p>Creates a new ApiMapping resource to represent an API mapping.</p>
|
|
953
1029
|
*/
|
|
954
1030
|
export interface CreateApiMappingRequest {
|
|
@@ -969,6 +1045,9 @@ export interface CreateApiMappingRequest {
|
|
|
969
1045
|
*/
|
|
970
1046
|
Stage: string | undefined;
|
|
971
1047
|
}
|
|
1048
|
+
/**
|
|
1049
|
+
* @public
|
|
1050
|
+
*/
|
|
972
1051
|
export interface CreateApiMappingResponse {
|
|
973
1052
|
/**
|
|
974
1053
|
* <p>The API identifier.</p>
|
|
@@ -988,6 +1067,7 @@ export interface CreateApiMappingResponse {
|
|
|
988
1067
|
Stage?: string;
|
|
989
1068
|
}
|
|
990
1069
|
/**
|
|
1070
|
+
* @public
|
|
991
1071
|
* <p>Creates a new Authorizer resource to represent an authorizer.</p>
|
|
992
1072
|
*/
|
|
993
1073
|
export interface CreateAuthorizerRequest {
|
|
@@ -1012,8 +1092,8 @@ export interface CreateAuthorizerRequest {
|
|
|
1012
1092
|
*/
|
|
1013
1093
|
AuthorizerType: AuthorizerType | string | undefined;
|
|
1014
1094
|
/**
|
|
1015
|
-
* <p>The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable
|
|
1016
|
-
* , where <replaceable></replaceable
|
|
1095
|
+
* <p>The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable>\{account_id\}</replaceable>:function:<replaceable>\{lambda_function_name\}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>\{region\}</replaceable>:lambda:path/<replaceable>\{service_api\}</replaceable>
|
|
1096
|
+
* , where <replaceable></replaceable>\{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. Supported only for REQUEST authorizers.</p>
|
|
1017
1097
|
*/
|
|
1018
1098
|
AuthorizerUri?: string;
|
|
1019
1099
|
/**
|
|
@@ -1037,6 +1117,9 @@ export interface CreateAuthorizerRequest {
|
|
|
1037
1117
|
*/
|
|
1038
1118
|
Name: string | undefined;
|
|
1039
1119
|
}
|
|
1120
|
+
/**
|
|
1121
|
+
* @public
|
|
1122
|
+
*/
|
|
1040
1123
|
export interface CreateAuthorizerResponse {
|
|
1041
1124
|
/**
|
|
1042
1125
|
* <p>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, don't specify this parameter. Supported only for REQUEST authorizers.</p>
|
|
@@ -1059,8 +1142,8 @@ export interface CreateAuthorizerResponse {
|
|
|
1059
1142
|
*/
|
|
1060
1143
|
AuthorizerType?: AuthorizerType | string;
|
|
1061
1144
|
/**
|
|
1062
|
-
* <p>The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable
|
|
1063
|
-
* , where <replaceable></replaceable
|
|
1145
|
+
* <p>The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable>\{account_id\}</replaceable>:function:<replaceable>\{lambda_function_name\}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>\{region\}</replaceable>:lambda:path/<replaceable>\{service_api\}</replaceable>
|
|
1146
|
+
* , where <replaceable></replaceable>\{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. Supported only for REQUEST authorizers.</p>
|
|
1064
1147
|
*/
|
|
1065
1148
|
AuthorizerUri?: string;
|
|
1066
1149
|
/**
|
|
@@ -1085,6 +1168,7 @@ export interface CreateAuthorizerResponse {
|
|
|
1085
1168
|
Name?: string;
|
|
1086
1169
|
}
|
|
1087
1170
|
/**
|
|
1171
|
+
* @public
|
|
1088
1172
|
* <p>Creates a new Deployment resource to represent a deployment.</p>
|
|
1089
1173
|
*/
|
|
1090
1174
|
export interface CreateDeploymentRequest {
|
|
@@ -1101,6 +1185,9 @@ export interface CreateDeploymentRequest {
|
|
|
1101
1185
|
*/
|
|
1102
1186
|
StageName?: string;
|
|
1103
1187
|
}
|
|
1188
|
+
/**
|
|
1189
|
+
* @public
|
|
1190
|
+
*/
|
|
1104
1191
|
export interface CreateDeploymentResponse {
|
|
1105
1192
|
/**
|
|
1106
1193
|
* <p>Specifies whether a deployment was automatically released.</p>
|
|
@@ -1127,6 +1214,9 @@ export interface CreateDeploymentResponse {
|
|
|
1127
1214
|
*/
|
|
1128
1215
|
Description?: string;
|
|
1129
1216
|
}
|
|
1217
|
+
/**
|
|
1218
|
+
* @public
|
|
1219
|
+
*/
|
|
1130
1220
|
export interface MutualTlsAuthenticationInput {
|
|
1131
1221
|
/**
|
|
1132
1222
|
* <p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>bucket-name</replaceable>/<replaceable>key-name</replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</p>
|
|
@@ -1138,6 +1228,7 @@ export interface MutualTlsAuthenticationInput {
|
|
|
1138
1228
|
TruststoreVersion?: string;
|
|
1139
1229
|
}
|
|
1140
1230
|
/**
|
|
1231
|
+
* @public
|
|
1141
1232
|
* <p>Creates a new DomainName resource to represent a domain name.</p>
|
|
1142
1233
|
*/
|
|
1143
1234
|
export interface CreateDomainNameRequest {
|
|
@@ -1158,6 +1249,9 @@ export interface CreateDomainNameRequest {
|
|
|
1158
1249
|
*/
|
|
1159
1250
|
Tags?: Record<string, string>;
|
|
1160
1251
|
}
|
|
1252
|
+
/**
|
|
1253
|
+
* @public
|
|
1254
|
+
*/
|
|
1161
1255
|
export interface CreateDomainNameResponse {
|
|
1162
1256
|
/**
|
|
1163
1257
|
* <p>The API mapping selection expression.</p>
|
|
@@ -1181,6 +1275,7 @@ export interface CreateDomainNameResponse {
|
|
|
1181
1275
|
Tags?: Record<string, string>;
|
|
1182
1276
|
}
|
|
1183
1277
|
/**
|
|
1278
|
+
* @public
|
|
1184
1279
|
* <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
|
|
1185
1280
|
*/
|
|
1186
1281
|
export interface TlsConfigInput {
|
|
@@ -1190,6 +1285,7 @@ export interface TlsConfigInput {
|
|
|
1190
1285
|
ServerNameToVerify?: string;
|
|
1191
1286
|
}
|
|
1192
1287
|
/**
|
|
1288
|
+
* @public
|
|
1193
1289
|
* <p>Creates a new Integration resource to represent an integration.</p>
|
|
1194
1290
|
*/
|
|
1195
1291
|
export interface CreateIntegrationRequest {
|
|
@@ -1242,11 +1338,11 @@ export interface CreateIntegrationRequest {
|
|
|
1242
1338
|
*/
|
|
1243
1339
|
PayloadFormatVersion?: string;
|
|
1244
1340
|
/**
|
|
1245
|
-
* <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable
|
|
1341
|
+
* <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>\{location\}</replaceable>.<replaceable>\{name\}</replaceable>
|
|
1246
1342
|
* , where
|
|
1247
|
-
* <replaceable
|
|
1343
|
+
* <replaceable>\{location\}</replaceable>
|
|
1248
1344
|
* is querystring, path, or header; and
|
|
1249
|
-
* <replaceable
|
|
1345
|
+
* <replaceable>\{name\}</replaceable>
|
|
1250
1346
|
* must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
|
|
1251
1347
|
*/
|
|
1252
1348
|
RequestParameters?: Record<string, string>;
|
|
@@ -1271,6 +1367,9 @@ export interface CreateIntegrationRequest {
|
|
|
1271
1367
|
*/
|
|
1272
1368
|
TlsConfig?: TlsConfigInput;
|
|
1273
1369
|
}
|
|
1370
|
+
/**
|
|
1371
|
+
* @public
|
|
1372
|
+
*/
|
|
1274
1373
|
export interface CreateIntegrationResult {
|
|
1275
1374
|
/**
|
|
1276
1375
|
* <p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>
|
|
@@ -1329,11 +1428,11 @@ export interface CreateIntegrationResult {
|
|
|
1329
1428
|
*/
|
|
1330
1429
|
PayloadFormatVersion?: string;
|
|
1331
1430
|
/**
|
|
1332
|
-
* <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable
|
|
1431
|
+
* <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>\{location\}</replaceable>.<replaceable>\{name\}</replaceable>
|
|
1333
1432
|
* , where
|
|
1334
|
-
* <replaceable
|
|
1433
|
+
* <replaceable>\{location\}</replaceable>
|
|
1335
1434
|
* is querystring, path, or header; and
|
|
1336
|
-
* <replaceable
|
|
1435
|
+
* <replaceable>\{name\}</replaceable>
|
|
1337
1436
|
* must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
|
|
1338
1437
|
*/
|
|
1339
1438
|
RequestParameters?: Record<string, string>;
|
|
@@ -1359,6 +1458,7 @@ export interface CreateIntegrationResult {
|
|
|
1359
1458
|
TlsConfig?: TlsConfig;
|
|
1360
1459
|
}
|
|
1361
1460
|
/**
|
|
1461
|
+
* @public
|
|
1362
1462
|
* <p>Creates a new IntegrationResponse resource to represent an integration response.</p>
|
|
1363
1463
|
*/
|
|
1364
1464
|
export interface CreateIntegrationResponseRequest {
|
|
@@ -1379,7 +1479,7 @@ export interface CreateIntegrationResponseRequest {
|
|
|
1379
1479
|
*/
|
|
1380
1480
|
IntegrationResponseKey: string | undefined;
|
|
1381
1481
|
/**
|
|
1382
|
-
* <p>A key-value map specifying response parameters that are passed to the method response from the backend. 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
|
|
1482
|
+
* <p>A key-value map specifying response parameters that are passed to the method response from the backend. 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.</p>
|
|
1383
1483
|
*/
|
|
1384
1484
|
ResponseParameters?: Record<string, string>;
|
|
1385
1485
|
/**
|
|
@@ -1391,6 +1491,9 @@ export interface CreateIntegrationResponseRequest {
|
|
|
1391
1491
|
*/
|
|
1392
1492
|
TemplateSelectionExpression?: string;
|
|
1393
1493
|
}
|
|
1494
|
+
/**
|
|
1495
|
+
* @public
|
|
1496
|
+
*/
|
|
1394
1497
|
export interface CreateIntegrationResponseResponse {
|
|
1395
1498
|
/**
|
|
1396
1499
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
@@ -1405,7 +1508,7 @@ export interface CreateIntegrationResponseResponse {
|
|
|
1405
1508
|
*/
|
|
1406
1509
|
IntegrationResponseKey?: string;
|
|
1407
1510
|
/**
|
|
1408
|
-
* <p>A key-value map specifying response parameters that are passed to the method response from the backend. 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
|
|
1511
|
+
* <p>A key-value map specifying response parameters that are passed to the method response from the backend. 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.</p>
|
|
1409
1512
|
*/
|
|
1410
1513
|
ResponseParameters?: Record<string, string>;
|
|
1411
1514
|
/**
|
|
@@ -1418,6 +1521,7 @@ export interface CreateIntegrationResponseResponse {
|
|
|
1418
1521
|
TemplateSelectionExpression?: string;
|
|
1419
1522
|
}
|
|
1420
1523
|
/**
|
|
1524
|
+
* @public
|
|
1421
1525
|
* <p>Creates a new Model.</p>
|
|
1422
1526
|
*/
|
|
1423
1527
|
export interface CreateModelRequest {
|
|
@@ -1442,6 +1546,9 @@ export interface CreateModelRequest {
|
|
|
1442
1546
|
*/
|
|
1443
1547
|
Schema: string | undefined;
|
|
1444
1548
|
}
|
|
1549
|
+
/**
|
|
1550
|
+
* @public
|
|
1551
|
+
*/
|
|
1445
1552
|
export interface CreateModelResponse {
|
|
1446
1553
|
/**
|
|
1447
1554
|
* <p>The content-type for the model, for example, "application/json".</p>
|
|
@@ -1465,6 +1572,7 @@ export interface CreateModelResponse {
|
|
|
1465
1572
|
Schema?: string;
|
|
1466
1573
|
}
|
|
1467
1574
|
/**
|
|
1575
|
+
* @public
|
|
1468
1576
|
* <p>Creates a new Route resource to represent a route.</p>
|
|
1469
1577
|
*/
|
|
1470
1578
|
export interface CreateRouteRequest {
|
|
@@ -1517,6 +1625,9 @@ export interface CreateRouteRequest {
|
|
|
1517
1625
|
*/
|
|
1518
1626
|
Target?: string;
|
|
1519
1627
|
}
|
|
1628
|
+
/**
|
|
1629
|
+
* @public
|
|
1630
|
+
*/
|
|
1520
1631
|
export interface CreateRouteResult {
|
|
1521
1632
|
/**
|
|
1522
1633
|
* <p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>
|
|
@@ -1572,6 +1683,7 @@ export interface CreateRouteResult {
|
|
|
1572
1683
|
Target?: string;
|
|
1573
1684
|
}
|
|
1574
1685
|
/**
|
|
1686
|
+
* @public
|
|
1575
1687
|
* <p>Creates a new RouteResponse resource to represent a route response.</p>
|
|
1576
1688
|
*/
|
|
1577
1689
|
export interface CreateRouteResponseRequest {
|
|
@@ -1600,6 +1712,9 @@ export interface CreateRouteResponseRequest {
|
|
|
1600
1712
|
*/
|
|
1601
1713
|
RouteResponseKey: string | undefined;
|
|
1602
1714
|
}
|
|
1715
|
+
/**
|
|
1716
|
+
* @public
|
|
1717
|
+
*/
|
|
1603
1718
|
export interface CreateRouteResponseResponse {
|
|
1604
1719
|
/**
|
|
1605
1720
|
* <p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>
|
|
@@ -1623,6 +1738,7 @@ export interface CreateRouteResponseResponse {
|
|
|
1623
1738
|
RouteResponseKey?: string;
|
|
1624
1739
|
}
|
|
1625
1740
|
/**
|
|
1741
|
+
* @public
|
|
1626
1742
|
* <p>Creates a new Stage resource to represent a stage.</p>
|
|
1627
1743
|
*/
|
|
1628
1744
|
export interface CreateStageRequest {
|
|
@@ -1671,6 +1787,9 @@ export interface CreateStageRequest {
|
|
|
1671
1787
|
*/
|
|
1672
1788
|
Tags?: Record<string, string>;
|
|
1673
1789
|
}
|
|
1790
|
+
/**
|
|
1791
|
+
* @public
|
|
1792
|
+
*/
|
|
1674
1793
|
export interface CreateStageResponse {
|
|
1675
1794
|
/**
|
|
1676
1795
|
* <p>Settings for logging access in this stage.</p>
|
|
@@ -1730,6 +1849,7 @@ export interface CreateStageResponse {
|
|
|
1730
1849
|
Tags?: Record<string, string>;
|
|
1731
1850
|
}
|
|
1732
1851
|
/**
|
|
1852
|
+
* @public
|
|
1733
1853
|
* <p>Creates a VPC link</p>
|
|
1734
1854
|
*/
|
|
1735
1855
|
export interface CreateVpcLinkRequest {
|
|
@@ -1750,6 +1870,9 @@ export interface CreateVpcLinkRequest {
|
|
|
1750
1870
|
*/
|
|
1751
1871
|
Tags?: Record<string, string>;
|
|
1752
1872
|
}
|
|
1873
|
+
/**
|
|
1874
|
+
* @public
|
|
1875
|
+
*/
|
|
1753
1876
|
export interface CreateVpcLinkResponse {
|
|
1754
1877
|
/**
|
|
1755
1878
|
* <p>The timestamp when the VPC link was created.</p>
|
|
@@ -1788,6 +1911,9 @@ export interface CreateVpcLinkResponse {
|
|
|
1788
1911
|
*/
|
|
1789
1912
|
VpcLinkVersion?: VpcLinkVersion | string;
|
|
1790
1913
|
}
|
|
1914
|
+
/**
|
|
1915
|
+
* @public
|
|
1916
|
+
*/
|
|
1791
1917
|
export interface DeleteAccessLogSettingsRequest {
|
|
1792
1918
|
/**
|
|
1793
1919
|
* <p>The API identifier.</p>
|
|
@@ -1798,12 +1924,18 @@ export interface DeleteAccessLogSettingsRequest {
|
|
|
1798
1924
|
*/
|
|
1799
1925
|
StageName: string | undefined;
|
|
1800
1926
|
}
|
|
1927
|
+
/**
|
|
1928
|
+
* @public
|
|
1929
|
+
*/
|
|
1801
1930
|
export interface DeleteApiRequest {
|
|
1802
1931
|
/**
|
|
1803
1932
|
* <p>The API identifier.</p>
|
|
1804
1933
|
*/
|
|
1805
1934
|
ApiId: string | undefined;
|
|
1806
1935
|
}
|
|
1936
|
+
/**
|
|
1937
|
+
* @public
|
|
1938
|
+
*/
|
|
1807
1939
|
export interface DeleteApiMappingRequest {
|
|
1808
1940
|
/**
|
|
1809
1941
|
* <p>The API mapping identifier.</p>
|
|
@@ -1814,6 +1946,9 @@ export interface DeleteApiMappingRequest {
|
|
|
1814
1946
|
*/
|
|
1815
1947
|
DomainName: string | undefined;
|
|
1816
1948
|
}
|
|
1949
|
+
/**
|
|
1950
|
+
* @public
|
|
1951
|
+
*/
|
|
1817
1952
|
export interface DeleteAuthorizerRequest {
|
|
1818
1953
|
/**
|
|
1819
1954
|
* <p>The API identifier.</p>
|
|
@@ -1824,12 +1959,18 @@ export interface DeleteAuthorizerRequest {
|
|
|
1824
1959
|
*/
|
|
1825
1960
|
AuthorizerId: string | undefined;
|
|
1826
1961
|
}
|
|
1962
|
+
/**
|
|
1963
|
+
* @public
|
|
1964
|
+
*/
|
|
1827
1965
|
export interface DeleteCorsConfigurationRequest {
|
|
1828
1966
|
/**
|
|
1829
1967
|
* <p>The API identifier.</p>
|
|
1830
1968
|
*/
|
|
1831
1969
|
ApiId: string | undefined;
|
|
1832
1970
|
}
|
|
1971
|
+
/**
|
|
1972
|
+
* @public
|
|
1973
|
+
*/
|
|
1833
1974
|
export interface DeleteDeploymentRequest {
|
|
1834
1975
|
/**
|
|
1835
1976
|
* <p>The API identifier.</p>
|
|
@@ -1840,12 +1981,18 @@ export interface DeleteDeploymentRequest {
|
|
|
1840
1981
|
*/
|
|
1841
1982
|
DeploymentId: string | undefined;
|
|
1842
1983
|
}
|
|
1984
|
+
/**
|
|
1985
|
+
* @public
|
|
1986
|
+
*/
|
|
1843
1987
|
export interface DeleteDomainNameRequest {
|
|
1844
1988
|
/**
|
|
1845
1989
|
* <p>The domain name.</p>
|
|
1846
1990
|
*/
|
|
1847
1991
|
DomainName: string | undefined;
|
|
1848
1992
|
}
|
|
1993
|
+
/**
|
|
1994
|
+
* @public
|
|
1995
|
+
*/
|
|
1849
1996
|
export interface DeleteIntegrationRequest {
|
|
1850
1997
|
/**
|
|
1851
1998
|
* <p>The API identifier.</p>
|
|
@@ -1856,6 +2003,9 @@ export interface DeleteIntegrationRequest {
|
|
|
1856
2003
|
*/
|
|
1857
2004
|
IntegrationId: string | undefined;
|
|
1858
2005
|
}
|
|
2006
|
+
/**
|
|
2007
|
+
* @public
|
|
2008
|
+
*/
|
|
1859
2009
|
export interface DeleteIntegrationResponseRequest {
|
|
1860
2010
|
/**
|
|
1861
2011
|
* <p>The API identifier.</p>
|
|
@@ -1870,6 +2020,9 @@ export interface DeleteIntegrationResponseRequest {
|
|
|
1870
2020
|
*/
|
|
1871
2021
|
IntegrationResponseId: string | undefined;
|
|
1872
2022
|
}
|
|
2023
|
+
/**
|
|
2024
|
+
* @public
|
|
2025
|
+
*/
|
|
1873
2026
|
export interface DeleteModelRequest {
|
|
1874
2027
|
/**
|
|
1875
2028
|
* <p>The API identifier.</p>
|
|
@@ -1880,6 +2033,9 @@ export interface DeleteModelRequest {
|
|
|
1880
2033
|
*/
|
|
1881
2034
|
ModelId: string | undefined;
|
|
1882
2035
|
}
|
|
2036
|
+
/**
|
|
2037
|
+
* @public
|
|
2038
|
+
*/
|
|
1883
2039
|
export interface DeleteRouteRequest {
|
|
1884
2040
|
/**
|
|
1885
2041
|
* <p>The API identifier.</p>
|
|
@@ -1890,6 +2046,9 @@ export interface DeleteRouteRequest {
|
|
|
1890
2046
|
*/
|
|
1891
2047
|
RouteId: string | undefined;
|
|
1892
2048
|
}
|
|
2049
|
+
/**
|
|
2050
|
+
* @public
|
|
2051
|
+
*/
|
|
1893
2052
|
export interface DeleteRouteRequestParameterRequest {
|
|
1894
2053
|
/**
|
|
1895
2054
|
* <p>The API identifier.</p>
|
|
@@ -1904,6 +2063,9 @@ export interface DeleteRouteRequestParameterRequest {
|
|
|
1904
2063
|
*/
|
|
1905
2064
|
RouteId: string | undefined;
|
|
1906
2065
|
}
|
|
2066
|
+
/**
|
|
2067
|
+
* @public
|
|
2068
|
+
*/
|
|
1907
2069
|
export interface DeleteRouteResponseRequest {
|
|
1908
2070
|
/**
|
|
1909
2071
|
* <p>The API identifier.</p>
|
|
@@ -1918,6 +2080,9 @@ export interface DeleteRouteResponseRequest {
|
|
|
1918
2080
|
*/
|
|
1919
2081
|
RouteResponseId: string | undefined;
|
|
1920
2082
|
}
|
|
2083
|
+
/**
|
|
2084
|
+
* @public
|
|
2085
|
+
*/
|
|
1921
2086
|
export interface DeleteRouteSettingsRequest {
|
|
1922
2087
|
/**
|
|
1923
2088
|
* <p>The API identifier.</p>
|
|
@@ -1932,6 +2097,9 @@ export interface DeleteRouteSettingsRequest {
|
|
|
1932
2097
|
*/
|
|
1933
2098
|
StageName: string | undefined;
|
|
1934
2099
|
}
|
|
2100
|
+
/**
|
|
2101
|
+
* @public
|
|
2102
|
+
*/
|
|
1935
2103
|
export interface DeleteStageRequest {
|
|
1936
2104
|
/**
|
|
1937
2105
|
* <p>The API identifier.</p>
|
|
@@ -1942,14 +2110,23 @@ export interface DeleteStageRequest {
|
|
|
1942
2110
|
*/
|
|
1943
2111
|
StageName: string | undefined;
|
|
1944
2112
|
}
|
|
2113
|
+
/**
|
|
2114
|
+
* @public
|
|
2115
|
+
*/
|
|
1945
2116
|
export interface DeleteVpcLinkRequest {
|
|
1946
2117
|
/**
|
|
1947
2118
|
* <p>The ID of the VPC link.</p>
|
|
1948
2119
|
*/
|
|
1949
2120
|
VpcLinkId: string | undefined;
|
|
1950
2121
|
}
|
|
2122
|
+
/**
|
|
2123
|
+
* @public
|
|
2124
|
+
*/
|
|
1951
2125
|
export interface DeleteVpcLinkResponse {
|
|
1952
2126
|
}
|
|
2127
|
+
/**
|
|
2128
|
+
* @public
|
|
2129
|
+
*/
|
|
1953
2130
|
export interface ExportApiRequest {
|
|
1954
2131
|
/**
|
|
1955
2132
|
* <p>The API identifier.</p>
|
|
@@ -1976,21 +2153,30 @@ export interface ExportApiRequest {
|
|
|
1976
2153
|
*/
|
|
1977
2154
|
StageName?: string;
|
|
1978
2155
|
}
|
|
2156
|
+
/**
|
|
2157
|
+
* @public
|
|
2158
|
+
*/
|
|
1979
2159
|
export interface ExportApiResponse {
|
|
1980
2160
|
/**
|
|
1981
2161
|
* <p>Represents an exported definition of an API in a particular output format, for example, YAML. The API is serialized to the requested specification, for example, OpenAPI 3.0.</p>
|
|
1982
2162
|
*/
|
|
1983
2163
|
body?: Uint8Array;
|
|
1984
2164
|
}
|
|
2165
|
+
/**
|
|
2166
|
+
* @public
|
|
2167
|
+
*/
|
|
1985
2168
|
export interface GetApiRequest {
|
|
1986
2169
|
/**
|
|
1987
2170
|
* <p>The API identifier.</p>
|
|
1988
2171
|
*/
|
|
1989
2172
|
ApiId: string | undefined;
|
|
1990
2173
|
}
|
|
2174
|
+
/**
|
|
2175
|
+
* @public
|
|
2176
|
+
*/
|
|
1991
2177
|
export interface GetApiResponse {
|
|
1992
2178
|
/**
|
|
1993
|
-
* <p>The URI of the API, of the form {api-id}.execute-api
|
|
2179
|
+
* <p>The URI of the API, of the form \{api-id\}.execute-api.\{region\}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>
|
|
1994
2180
|
*/
|
|
1995
2181
|
ApiEndpoint?: string;
|
|
1996
2182
|
/**
|
|
@@ -2022,7 +2208,7 @@ export interface GetApiResponse {
|
|
|
2022
2208
|
*/
|
|
2023
2209
|
DisableSchemaValidation?: boolean;
|
|
2024
2210
|
/**
|
|
2025
|
-
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https
|
|
2211
|
+
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://\{api_id\}.execute-api.\{region\}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
|
|
2026
2212
|
*/
|
|
2027
2213
|
DisableExecuteApiEndpoint?: boolean;
|
|
2028
2214
|
/**
|
|
@@ -2038,7 +2224,7 @@ export interface GetApiResponse {
|
|
|
2038
2224
|
*/
|
|
2039
2225
|
ProtocolType?: ProtocolType | string;
|
|
2040
2226
|
/**
|
|
2041
|
-
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be
|
|
2227
|
+
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
2042
2228
|
*/
|
|
2043
2229
|
RouteSelectionExpression?: string;
|
|
2044
2230
|
/**
|
|
@@ -2054,6 +2240,9 @@ export interface GetApiResponse {
|
|
|
2054
2240
|
*/
|
|
2055
2241
|
Warnings?: string[];
|
|
2056
2242
|
}
|
|
2243
|
+
/**
|
|
2244
|
+
* @public
|
|
2245
|
+
*/
|
|
2057
2246
|
export interface GetApiMappingRequest {
|
|
2058
2247
|
/**
|
|
2059
2248
|
* <p>The API mapping identifier.</p>
|
|
@@ -2064,6 +2253,9 @@ export interface GetApiMappingRequest {
|
|
|
2064
2253
|
*/
|
|
2065
2254
|
DomainName: string | undefined;
|
|
2066
2255
|
}
|
|
2256
|
+
/**
|
|
2257
|
+
* @public
|
|
2258
|
+
*/
|
|
2067
2259
|
export interface GetApiMappingResponse {
|
|
2068
2260
|
/**
|
|
2069
2261
|
* <p>The API identifier.</p>
|
|
@@ -2082,6 +2274,9 @@ export interface GetApiMappingResponse {
|
|
|
2082
2274
|
*/
|
|
2083
2275
|
Stage?: string;
|
|
2084
2276
|
}
|
|
2277
|
+
/**
|
|
2278
|
+
* @public
|
|
2279
|
+
*/
|
|
2085
2280
|
export interface GetApiMappingsRequest {
|
|
2086
2281
|
/**
|
|
2087
2282
|
* <p>The domain name.</p>
|
|
@@ -2096,6 +2291,9 @@ export interface GetApiMappingsRequest {
|
|
|
2096
2291
|
*/
|
|
2097
2292
|
NextToken?: string;
|
|
2098
2293
|
}
|
|
2294
|
+
/**
|
|
2295
|
+
* @public
|
|
2296
|
+
*/
|
|
2099
2297
|
export interface GetApiMappingsResponse {
|
|
2100
2298
|
/**
|
|
2101
2299
|
* <p>The elements from this collection.</p>
|
|
@@ -2106,6 +2304,9 @@ export interface GetApiMappingsResponse {
|
|
|
2106
2304
|
*/
|
|
2107
2305
|
NextToken?: string;
|
|
2108
2306
|
}
|
|
2307
|
+
/**
|
|
2308
|
+
* @public
|
|
2309
|
+
*/
|
|
2109
2310
|
export interface GetApisRequest {
|
|
2110
2311
|
/**
|
|
2111
2312
|
* <p>The maximum number of elements to be returned for this resource.</p>
|
|
@@ -2116,6 +2317,9 @@ export interface GetApisRequest {
|
|
|
2116
2317
|
*/
|
|
2117
2318
|
NextToken?: string;
|
|
2118
2319
|
}
|
|
2320
|
+
/**
|
|
2321
|
+
* @public
|
|
2322
|
+
*/
|
|
2119
2323
|
export interface GetApisResponse {
|
|
2120
2324
|
/**
|
|
2121
2325
|
* <p>The elements from this collection.</p>
|
|
@@ -2126,6 +2330,9 @@ export interface GetApisResponse {
|
|
|
2126
2330
|
*/
|
|
2127
2331
|
NextToken?: string;
|
|
2128
2332
|
}
|
|
2333
|
+
/**
|
|
2334
|
+
* @public
|
|
2335
|
+
*/
|
|
2129
2336
|
export interface GetAuthorizerRequest {
|
|
2130
2337
|
/**
|
|
2131
2338
|
* <p>The API identifier.</p>
|
|
@@ -2136,6 +2343,9 @@ export interface GetAuthorizerRequest {
|
|
|
2136
2343
|
*/
|
|
2137
2344
|
AuthorizerId: string | undefined;
|
|
2138
2345
|
}
|
|
2346
|
+
/**
|
|
2347
|
+
* @public
|
|
2348
|
+
*/
|
|
2139
2349
|
export interface GetAuthorizerResponse {
|
|
2140
2350
|
/**
|
|
2141
2351
|
* <p>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, don't specify this parameter. Supported only for REQUEST authorizers.</p>
|
|
@@ -2158,8 +2368,8 @@ export interface GetAuthorizerResponse {
|
|
|
2158
2368
|
*/
|
|
2159
2369
|
AuthorizerType?: AuthorizerType | string;
|
|
2160
2370
|
/**
|
|
2161
|
-
* <p>The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable
|
|
2162
|
-
* , where <replaceable></replaceable
|
|
2371
|
+
* <p>The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable>\{account_id\}</replaceable>:function:<replaceable>\{lambda_function_name\}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>\{region\}</replaceable>:lambda:path/<replaceable>\{service_api\}</replaceable>
|
|
2372
|
+
* , where <replaceable></replaceable>\{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. Supported only for REQUEST authorizers.</p>
|
|
2163
2373
|
*/
|
|
2164
2374
|
AuthorizerUri?: string;
|
|
2165
2375
|
/**
|
|
@@ -2183,6 +2393,9 @@ export interface GetAuthorizerResponse {
|
|
|
2183
2393
|
*/
|
|
2184
2394
|
Name?: string;
|
|
2185
2395
|
}
|
|
2396
|
+
/**
|
|
2397
|
+
* @public
|
|
2398
|
+
*/
|
|
2186
2399
|
export interface GetAuthorizersRequest {
|
|
2187
2400
|
/**
|
|
2188
2401
|
* <p>The API identifier.</p>
|
|
@@ -2197,6 +2410,9 @@ export interface GetAuthorizersRequest {
|
|
|
2197
2410
|
*/
|
|
2198
2411
|
NextToken?: string;
|
|
2199
2412
|
}
|
|
2413
|
+
/**
|
|
2414
|
+
* @public
|
|
2415
|
+
*/
|
|
2200
2416
|
export interface GetAuthorizersResponse {
|
|
2201
2417
|
/**
|
|
2202
2418
|
* <p>The elements from this collection.</p>
|
|
@@ -2207,6 +2423,9 @@ export interface GetAuthorizersResponse {
|
|
|
2207
2423
|
*/
|
|
2208
2424
|
NextToken?: string;
|
|
2209
2425
|
}
|
|
2426
|
+
/**
|
|
2427
|
+
* @public
|
|
2428
|
+
*/
|
|
2210
2429
|
export interface GetDeploymentRequest {
|
|
2211
2430
|
/**
|
|
2212
2431
|
* <p>The API identifier.</p>
|
|
@@ -2217,6 +2436,9 @@ export interface GetDeploymentRequest {
|
|
|
2217
2436
|
*/
|
|
2218
2437
|
DeploymentId: string | undefined;
|
|
2219
2438
|
}
|
|
2439
|
+
/**
|
|
2440
|
+
* @public
|
|
2441
|
+
*/
|
|
2220
2442
|
export interface GetDeploymentResponse {
|
|
2221
2443
|
/**
|
|
2222
2444
|
* <p>Specifies whether a deployment was automatically released.</p>
|
|
@@ -2243,6 +2465,9 @@ export interface GetDeploymentResponse {
|
|
|
2243
2465
|
*/
|
|
2244
2466
|
Description?: string;
|
|
2245
2467
|
}
|
|
2468
|
+
/**
|
|
2469
|
+
* @public
|
|
2470
|
+
*/
|
|
2246
2471
|
export interface GetDeploymentsRequest {
|
|
2247
2472
|
/**
|
|
2248
2473
|
* <p>The API identifier.</p>
|
|
@@ -2257,6 +2482,9 @@ export interface GetDeploymentsRequest {
|
|
|
2257
2482
|
*/
|
|
2258
2483
|
NextToken?: string;
|
|
2259
2484
|
}
|
|
2485
|
+
/**
|
|
2486
|
+
* @public
|
|
2487
|
+
*/
|
|
2260
2488
|
export interface GetDeploymentsResponse {
|
|
2261
2489
|
/**
|
|
2262
2490
|
* <p>The elements from this collection.</p>
|
|
@@ -2267,12 +2495,18 @@ export interface GetDeploymentsResponse {
|
|
|
2267
2495
|
*/
|
|
2268
2496
|
NextToken?: string;
|
|
2269
2497
|
}
|
|
2498
|
+
/**
|
|
2499
|
+
* @public
|
|
2500
|
+
*/
|
|
2270
2501
|
export interface GetDomainNameRequest {
|
|
2271
2502
|
/**
|
|
2272
2503
|
* <p>The domain name.</p>
|
|
2273
2504
|
*/
|
|
2274
2505
|
DomainName: string | undefined;
|
|
2275
2506
|
}
|
|
2507
|
+
/**
|
|
2508
|
+
* @public
|
|
2509
|
+
*/
|
|
2276
2510
|
export interface GetDomainNameResponse {
|
|
2277
2511
|
/**
|
|
2278
2512
|
* <p>The API mapping selection expression.</p>
|
|
@@ -2295,6 +2529,9 @@ export interface GetDomainNameResponse {
|
|
|
2295
2529
|
*/
|
|
2296
2530
|
Tags?: Record<string, string>;
|
|
2297
2531
|
}
|
|
2532
|
+
/**
|
|
2533
|
+
* @public
|
|
2534
|
+
*/
|
|
2298
2535
|
export interface GetDomainNamesRequest {
|
|
2299
2536
|
/**
|
|
2300
2537
|
* <p>The maximum number of elements to be returned for this resource.</p>
|
|
@@ -2305,6 +2542,9 @@ export interface GetDomainNamesRequest {
|
|
|
2305
2542
|
*/
|
|
2306
2543
|
NextToken?: string;
|
|
2307
2544
|
}
|
|
2545
|
+
/**
|
|
2546
|
+
* @public
|
|
2547
|
+
*/
|
|
2308
2548
|
export interface GetDomainNamesResponse {
|
|
2309
2549
|
/**
|
|
2310
2550
|
* <p>The elements from this collection.</p>
|
|
@@ -2315,6 +2555,9 @@ export interface GetDomainNamesResponse {
|
|
|
2315
2555
|
*/
|
|
2316
2556
|
NextToken?: string;
|
|
2317
2557
|
}
|
|
2558
|
+
/**
|
|
2559
|
+
* @public
|
|
2560
|
+
*/
|
|
2318
2561
|
export interface GetIntegrationRequest {
|
|
2319
2562
|
/**
|
|
2320
2563
|
* <p>The API identifier.</p>
|
|
@@ -2325,6 +2568,9 @@ export interface GetIntegrationRequest {
|
|
|
2325
2568
|
*/
|
|
2326
2569
|
IntegrationId: string | undefined;
|
|
2327
2570
|
}
|
|
2571
|
+
/**
|
|
2572
|
+
* @public
|
|
2573
|
+
*/
|
|
2328
2574
|
export interface GetIntegrationResult {
|
|
2329
2575
|
/**
|
|
2330
2576
|
* <p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>
|
|
@@ -2383,11 +2629,11 @@ export interface GetIntegrationResult {
|
|
|
2383
2629
|
*/
|
|
2384
2630
|
PayloadFormatVersion?: string;
|
|
2385
2631
|
/**
|
|
2386
|
-
* <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable
|
|
2632
|
+
* <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>\{location\}</replaceable>.<replaceable>\{name\}</replaceable>
|
|
2387
2633
|
* , where
|
|
2388
|
-
* <replaceable
|
|
2634
|
+
* <replaceable>\{location\}</replaceable>
|
|
2389
2635
|
* is querystring, path, or header; and
|
|
2390
|
-
* <replaceable
|
|
2636
|
+
* <replaceable>\{name\}</replaceable>
|
|
2391
2637
|
* must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
|
|
2392
2638
|
*/
|
|
2393
2639
|
RequestParameters?: Record<string, string>;
|
|
@@ -2412,6 +2658,9 @@ export interface GetIntegrationResult {
|
|
|
2412
2658
|
*/
|
|
2413
2659
|
TlsConfig?: TlsConfig;
|
|
2414
2660
|
}
|
|
2661
|
+
/**
|
|
2662
|
+
* @public
|
|
2663
|
+
*/
|
|
2415
2664
|
export interface GetIntegrationResponseRequest {
|
|
2416
2665
|
/**
|
|
2417
2666
|
* <p>The API identifier.</p>
|
|
@@ -2426,6 +2675,9 @@ export interface GetIntegrationResponseRequest {
|
|
|
2426
2675
|
*/
|
|
2427
2676
|
IntegrationResponseId: string | undefined;
|
|
2428
2677
|
}
|
|
2678
|
+
/**
|
|
2679
|
+
* @public
|
|
2680
|
+
*/
|
|
2429
2681
|
export interface GetIntegrationResponseResponse {
|
|
2430
2682
|
/**
|
|
2431
2683
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
@@ -2440,7 +2692,7 @@ export interface GetIntegrationResponseResponse {
|
|
|
2440
2692
|
*/
|
|
2441
2693
|
IntegrationResponseKey?: string;
|
|
2442
2694
|
/**
|
|
2443
|
-
* <p>A key-value map specifying response parameters that are passed to the method response from the backend. 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
|
|
2695
|
+
* <p>A key-value map specifying response parameters that are passed to the method response from the backend. 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.</p>
|
|
2444
2696
|
*/
|
|
2445
2697
|
ResponseParameters?: Record<string, string>;
|
|
2446
2698
|
/**
|
|
@@ -2452,6 +2704,9 @@ export interface GetIntegrationResponseResponse {
|
|
|
2452
2704
|
*/
|
|
2453
2705
|
TemplateSelectionExpression?: string;
|
|
2454
2706
|
}
|
|
2707
|
+
/**
|
|
2708
|
+
* @public
|
|
2709
|
+
*/
|
|
2455
2710
|
export interface GetIntegrationResponsesRequest {
|
|
2456
2711
|
/**
|
|
2457
2712
|
* <p>The API identifier.</p>
|
|
@@ -2470,6 +2725,9 @@ export interface GetIntegrationResponsesRequest {
|
|
|
2470
2725
|
*/
|
|
2471
2726
|
NextToken?: string;
|
|
2472
2727
|
}
|
|
2728
|
+
/**
|
|
2729
|
+
* @public
|
|
2730
|
+
*/
|
|
2473
2731
|
export interface GetIntegrationResponsesResponse {
|
|
2474
2732
|
/**
|
|
2475
2733
|
* <p>The elements from this collection.</p>
|
|
@@ -2480,6 +2738,9 @@ export interface GetIntegrationResponsesResponse {
|
|
|
2480
2738
|
*/
|
|
2481
2739
|
NextToken?: string;
|
|
2482
2740
|
}
|
|
2741
|
+
/**
|
|
2742
|
+
* @public
|
|
2743
|
+
*/
|
|
2483
2744
|
export interface GetIntegrationsRequest {
|
|
2484
2745
|
/**
|
|
2485
2746
|
* <p>The API identifier.</p>
|
|
@@ -2494,6 +2755,9 @@ export interface GetIntegrationsRequest {
|
|
|
2494
2755
|
*/
|
|
2495
2756
|
NextToken?: string;
|
|
2496
2757
|
}
|
|
2758
|
+
/**
|
|
2759
|
+
* @public
|
|
2760
|
+
*/
|
|
2497
2761
|
export interface GetIntegrationsResponse {
|
|
2498
2762
|
/**
|
|
2499
2763
|
* <p>The elements from this collection.</p>
|
|
@@ -2504,6 +2768,9 @@ export interface GetIntegrationsResponse {
|
|
|
2504
2768
|
*/
|
|
2505
2769
|
NextToken?: string;
|
|
2506
2770
|
}
|
|
2771
|
+
/**
|
|
2772
|
+
* @public
|
|
2773
|
+
*/
|
|
2507
2774
|
export interface GetModelRequest {
|
|
2508
2775
|
/**
|
|
2509
2776
|
* <p>The API identifier.</p>
|
|
@@ -2514,6 +2781,9 @@ export interface GetModelRequest {
|
|
|
2514
2781
|
*/
|
|
2515
2782
|
ModelId: string | undefined;
|
|
2516
2783
|
}
|
|
2784
|
+
/**
|
|
2785
|
+
* @public
|
|
2786
|
+
*/
|
|
2517
2787
|
export interface GetModelResponse {
|
|
2518
2788
|
/**
|
|
2519
2789
|
* <p>The content-type for the model, for example, "application/json".</p>
|
|
@@ -2536,6 +2806,9 @@ export interface GetModelResponse {
|
|
|
2536
2806
|
*/
|
|
2537
2807
|
Schema?: string;
|
|
2538
2808
|
}
|
|
2809
|
+
/**
|
|
2810
|
+
* @public
|
|
2811
|
+
*/
|
|
2539
2812
|
export interface GetModelsRequest {
|
|
2540
2813
|
/**
|
|
2541
2814
|
* <p>The API identifier.</p>
|
|
@@ -2550,6 +2823,9 @@ export interface GetModelsRequest {
|
|
|
2550
2823
|
*/
|
|
2551
2824
|
NextToken?: string;
|
|
2552
2825
|
}
|
|
2826
|
+
/**
|
|
2827
|
+
* @public
|
|
2828
|
+
*/
|
|
2553
2829
|
export interface GetModelsResponse {
|
|
2554
2830
|
/**
|
|
2555
2831
|
* <p>The elements from this collection.</p>
|
|
@@ -2560,6 +2836,9 @@ export interface GetModelsResponse {
|
|
|
2560
2836
|
*/
|
|
2561
2837
|
NextToken?: string;
|
|
2562
2838
|
}
|
|
2839
|
+
/**
|
|
2840
|
+
* @public
|
|
2841
|
+
*/
|
|
2563
2842
|
export interface GetModelTemplateRequest {
|
|
2564
2843
|
/**
|
|
2565
2844
|
* <p>The API identifier.</p>
|
|
@@ -2570,12 +2849,18 @@ export interface GetModelTemplateRequest {
|
|
|
2570
2849
|
*/
|
|
2571
2850
|
ModelId: string | undefined;
|
|
2572
2851
|
}
|
|
2852
|
+
/**
|
|
2853
|
+
* @public
|
|
2854
|
+
*/
|
|
2573
2855
|
export interface GetModelTemplateResponse {
|
|
2574
2856
|
/**
|
|
2575
2857
|
* <p>The template value.</p>
|
|
2576
2858
|
*/
|
|
2577
2859
|
Value?: string;
|
|
2578
2860
|
}
|
|
2861
|
+
/**
|
|
2862
|
+
* @public
|
|
2863
|
+
*/
|
|
2579
2864
|
export interface GetRouteRequest {
|
|
2580
2865
|
/**
|
|
2581
2866
|
* <p>The API identifier.</p>
|
|
@@ -2586,6 +2871,9 @@ export interface GetRouteRequest {
|
|
|
2586
2871
|
*/
|
|
2587
2872
|
RouteId: string | undefined;
|
|
2588
2873
|
}
|
|
2874
|
+
/**
|
|
2875
|
+
* @public
|
|
2876
|
+
*/
|
|
2589
2877
|
export interface GetRouteResult {
|
|
2590
2878
|
/**
|
|
2591
2879
|
* <p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>
|
|
@@ -2640,6 +2928,9 @@ export interface GetRouteResult {
|
|
|
2640
2928
|
*/
|
|
2641
2929
|
Target?: string;
|
|
2642
2930
|
}
|
|
2931
|
+
/**
|
|
2932
|
+
* @public
|
|
2933
|
+
*/
|
|
2643
2934
|
export interface GetRouteResponseRequest {
|
|
2644
2935
|
/**
|
|
2645
2936
|
* <p>The API identifier.</p>
|
|
@@ -2654,6 +2945,9 @@ export interface GetRouteResponseRequest {
|
|
|
2654
2945
|
*/
|
|
2655
2946
|
RouteResponseId: string | undefined;
|
|
2656
2947
|
}
|
|
2948
|
+
/**
|
|
2949
|
+
* @public
|
|
2950
|
+
*/
|
|
2657
2951
|
export interface GetRouteResponseResponse {
|
|
2658
2952
|
/**
|
|
2659
2953
|
* <p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>
|
|
@@ -2676,6 +2970,9 @@ export interface GetRouteResponseResponse {
|
|
|
2676
2970
|
*/
|
|
2677
2971
|
RouteResponseKey?: string;
|
|
2678
2972
|
}
|
|
2973
|
+
/**
|
|
2974
|
+
* @public
|
|
2975
|
+
*/
|
|
2679
2976
|
export interface GetRouteResponsesRequest {
|
|
2680
2977
|
/**
|
|
2681
2978
|
* <p>The API identifier.</p>
|
|
@@ -2694,6 +2991,9 @@ export interface GetRouteResponsesRequest {
|
|
|
2694
2991
|
*/
|
|
2695
2992
|
RouteId: string | undefined;
|
|
2696
2993
|
}
|
|
2994
|
+
/**
|
|
2995
|
+
* @public
|
|
2996
|
+
*/
|
|
2697
2997
|
export interface GetRouteResponsesResponse {
|
|
2698
2998
|
/**
|
|
2699
2999
|
* <p>The elements from this collection.</p>
|
|
@@ -2704,6 +3004,9 @@ export interface GetRouteResponsesResponse {
|
|
|
2704
3004
|
*/
|
|
2705
3005
|
NextToken?: string;
|
|
2706
3006
|
}
|
|
3007
|
+
/**
|
|
3008
|
+
* @public
|
|
3009
|
+
*/
|
|
2707
3010
|
export interface GetRoutesRequest {
|
|
2708
3011
|
/**
|
|
2709
3012
|
* <p>The API identifier.</p>
|
|
@@ -2718,6 +3021,9 @@ export interface GetRoutesRequest {
|
|
|
2718
3021
|
*/
|
|
2719
3022
|
NextToken?: string;
|
|
2720
3023
|
}
|
|
3024
|
+
/**
|
|
3025
|
+
* @public
|
|
3026
|
+
*/
|
|
2721
3027
|
export interface GetRoutesResponse {
|
|
2722
3028
|
/**
|
|
2723
3029
|
* <p>The elements from this collection.</p>
|
|
@@ -2728,6 +3034,9 @@ export interface GetRoutesResponse {
|
|
|
2728
3034
|
*/
|
|
2729
3035
|
NextToken?: string;
|
|
2730
3036
|
}
|
|
3037
|
+
/**
|
|
3038
|
+
* @public
|
|
3039
|
+
*/
|
|
2731
3040
|
export interface GetStageRequest {
|
|
2732
3041
|
/**
|
|
2733
3042
|
* <p>The API identifier.</p>
|
|
@@ -2738,6 +3047,9 @@ export interface GetStageRequest {
|
|
|
2738
3047
|
*/
|
|
2739
3048
|
StageName: string | undefined;
|
|
2740
3049
|
}
|
|
3050
|
+
/**
|
|
3051
|
+
* @public
|
|
3052
|
+
*/
|
|
2741
3053
|
export interface GetStageResponse {
|
|
2742
3054
|
/**
|
|
2743
3055
|
* <p>Settings for logging access in this stage.</p>
|
|
@@ -2796,6 +3108,9 @@ export interface GetStageResponse {
|
|
|
2796
3108
|
*/
|
|
2797
3109
|
Tags?: Record<string, string>;
|
|
2798
3110
|
}
|
|
3111
|
+
/**
|
|
3112
|
+
* @public
|
|
3113
|
+
*/
|
|
2799
3114
|
export interface GetStagesRequest {
|
|
2800
3115
|
/**
|
|
2801
3116
|
* <p>The API identifier.</p>
|
|
@@ -2810,6 +3125,9 @@ export interface GetStagesRequest {
|
|
|
2810
3125
|
*/
|
|
2811
3126
|
NextToken?: string;
|
|
2812
3127
|
}
|
|
3128
|
+
/**
|
|
3129
|
+
* @public
|
|
3130
|
+
*/
|
|
2813
3131
|
export interface GetStagesResponse {
|
|
2814
3132
|
/**
|
|
2815
3133
|
* <p>The elements from this collection.</p>
|
|
@@ -2820,24 +3138,36 @@ export interface GetStagesResponse {
|
|
|
2820
3138
|
*/
|
|
2821
3139
|
NextToken?: string;
|
|
2822
3140
|
}
|
|
3141
|
+
/**
|
|
3142
|
+
* @public
|
|
3143
|
+
*/
|
|
2823
3144
|
export interface GetTagsRequest {
|
|
2824
3145
|
/**
|
|
2825
3146
|
* <p>The resource ARN for the tag.</p>
|
|
2826
3147
|
*/
|
|
2827
3148
|
ResourceArn: string | undefined;
|
|
2828
3149
|
}
|
|
3150
|
+
/**
|
|
3151
|
+
* @public
|
|
3152
|
+
*/
|
|
2829
3153
|
export interface GetTagsResponse {
|
|
2830
3154
|
/**
|
|
2831
3155
|
* <p>Represents a collection of tags associated with the resource.</p>
|
|
2832
3156
|
*/
|
|
2833
3157
|
Tags?: Record<string, string>;
|
|
2834
3158
|
}
|
|
3159
|
+
/**
|
|
3160
|
+
* @public
|
|
3161
|
+
*/
|
|
2835
3162
|
export interface GetVpcLinkRequest {
|
|
2836
3163
|
/**
|
|
2837
3164
|
* <p>The ID of the VPC link.</p>
|
|
2838
3165
|
*/
|
|
2839
3166
|
VpcLinkId: string | undefined;
|
|
2840
3167
|
}
|
|
3168
|
+
/**
|
|
3169
|
+
* @public
|
|
3170
|
+
*/
|
|
2841
3171
|
export interface GetVpcLinkResponse {
|
|
2842
3172
|
/**
|
|
2843
3173
|
* <p>The timestamp when the VPC link was created.</p>
|
|
@@ -2876,6 +3206,9 @@ export interface GetVpcLinkResponse {
|
|
|
2876
3206
|
*/
|
|
2877
3207
|
VpcLinkVersion?: VpcLinkVersion | string;
|
|
2878
3208
|
}
|
|
3209
|
+
/**
|
|
3210
|
+
* @public
|
|
3211
|
+
*/
|
|
2879
3212
|
export interface GetVpcLinksRequest {
|
|
2880
3213
|
/**
|
|
2881
3214
|
* <p>The maximum number of elements to be returned for this resource.</p>
|
|
@@ -2886,6 +3219,9 @@ export interface GetVpcLinksRequest {
|
|
|
2886
3219
|
*/
|
|
2887
3220
|
NextToken?: string;
|
|
2888
3221
|
}
|
|
3222
|
+
/**
|
|
3223
|
+
* @public
|
|
3224
|
+
*/
|
|
2889
3225
|
export interface GetVpcLinksResponse {
|
|
2890
3226
|
/**
|
|
2891
3227
|
* <p>A collection of VPC links.</p>
|
|
@@ -2897,6 +3233,7 @@ export interface GetVpcLinksResponse {
|
|
|
2897
3233
|
NextToken?: string;
|
|
2898
3234
|
}
|
|
2899
3235
|
/**
|
|
3236
|
+
* @public
|
|
2900
3237
|
* <p></p>
|
|
2901
3238
|
*/
|
|
2902
3239
|
export interface ImportApiRequest {
|
|
@@ -2913,9 +3250,12 @@ export interface ImportApiRequest {
|
|
|
2913
3250
|
*/
|
|
2914
3251
|
FailOnWarnings?: boolean;
|
|
2915
3252
|
}
|
|
3253
|
+
/**
|
|
3254
|
+
* @public
|
|
3255
|
+
*/
|
|
2916
3256
|
export interface ImportApiResponse {
|
|
2917
3257
|
/**
|
|
2918
|
-
* <p>The URI of the API, of the form {api-id}.execute-api
|
|
3258
|
+
* <p>The URI of the API, of the form \{api-id\}.execute-api.\{region\}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>
|
|
2919
3259
|
*/
|
|
2920
3260
|
ApiEndpoint?: string;
|
|
2921
3261
|
/**
|
|
@@ -2947,7 +3287,7 @@ export interface ImportApiResponse {
|
|
|
2947
3287
|
*/
|
|
2948
3288
|
DisableSchemaValidation?: boolean;
|
|
2949
3289
|
/**
|
|
2950
|
-
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https
|
|
3290
|
+
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://\{api_id\}.execute-api.\{region\}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
|
|
2951
3291
|
*/
|
|
2952
3292
|
DisableExecuteApiEndpoint?: boolean;
|
|
2953
3293
|
/**
|
|
@@ -2963,7 +3303,7 @@ export interface ImportApiResponse {
|
|
|
2963
3303
|
*/
|
|
2964
3304
|
ProtocolType?: ProtocolType | string;
|
|
2965
3305
|
/**
|
|
2966
|
-
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be
|
|
3306
|
+
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
2967
3307
|
*/
|
|
2968
3308
|
RouteSelectionExpression?: string;
|
|
2969
3309
|
/**
|
|
@@ -2980,6 +3320,7 @@ export interface ImportApiResponse {
|
|
|
2980
3320
|
Warnings?: string[];
|
|
2981
3321
|
}
|
|
2982
3322
|
/**
|
|
3323
|
+
* @public
|
|
2983
3324
|
* <p></p>
|
|
2984
3325
|
*/
|
|
2985
3326
|
export interface ReimportApiRequest {
|
|
@@ -3000,9 +3341,12 @@ export interface ReimportApiRequest {
|
|
|
3000
3341
|
*/
|
|
3001
3342
|
FailOnWarnings?: boolean;
|
|
3002
3343
|
}
|
|
3344
|
+
/**
|
|
3345
|
+
* @public
|
|
3346
|
+
*/
|
|
3003
3347
|
export interface ReimportApiResponse {
|
|
3004
3348
|
/**
|
|
3005
|
-
* <p>The URI of the API, of the form {api-id}.execute-api
|
|
3349
|
+
* <p>The URI of the API, of the form \{api-id\}.execute-api.\{region\}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>
|
|
3006
3350
|
*/
|
|
3007
3351
|
ApiEndpoint?: string;
|
|
3008
3352
|
/**
|
|
@@ -3034,7 +3378,7 @@ export interface ReimportApiResponse {
|
|
|
3034
3378
|
*/
|
|
3035
3379
|
DisableSchemaValidation?: boolean;
|
|
3036
3380
|
/**
|
|
3037
|
-
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https
|
|
3381
|
+
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://\{api_id\}.execute-api.\{region\}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
|
|
3038
3382
|
*/
|
|
3039
3383
|
DisableExecuteApiEndpoint?: boolean;
|
|
3040
3384
|
/**
|
|
@@ -3050,7 +3394,7 @@ export interface ReimportApiResponse {
|
|
|
3050
3394
|
*/
|
|
3051
3395
|
ProtocolType?: ProtocolType | string;
|
|
3052
3396
|
/**
|
|
3053
|
-
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be
|
|
3397
|
+
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
3054
3398
|
*/
|
|
3055
3399
|
RouteSelectionExpression?: string;
|
|
3056
3400
|
/**
|
|
@@ -3066,6 +3410,9 @@ export interface ReimportApiResponse {
|
|
|
3066
3410
|
*/
|
|
3067
3411
|
Warnings?: string[];
|
|
3068
3412
|
}
|
|
3413
|
+
/**
|
|
3414
|
+
* @public
|
|
3415
|
+
*/
|
|
3069
3416
|
export interface ResetAuthorizersCacheRequest {
|
|
3070
3417
|
/**
|
|
3071
3418
|
* <p>The API identifier.</p>
|
|
@@ -3077,6 +3424,7 @@ export interface ResetAuthorizersCacheRequest {
|
|
|
3077
3424
|
StageName: string | undefined;
|
|
3078
3425
|
}
|
|
3079
3426
|
/**
|
|
3427
|
+
* @public
|
|
3080
3428
|
* <p>Creates a new Tag resource to represent a tag.</p>
|
|
3081
3429
|
*/
|
|
3082
3430
|
export interface TagResourceRequest {
|
|
@@ -3089,8 +3437,14 @@ export interface TagResourceRequest {
|
|
|
3089
3437
|
*/
|
|
3090
3438
|
Tags?: Record<string, string>;
|
|
3091
3439
|
}
|
|
3440
|
+
/**
|
|
3441
|
+
* @public
|
|
3442
|
+
*/
|
|
3092
3443
|
export interface TagResourceResponse {
|
|
3093
3444
|
}
|
|
3445
|
+
/**
|
|
3446
|
+
* @public
|
|
3447
|
+
*/
|
|
3094
3448
|
export interface UntagResourceRequest {
|
|
3095
3449
|
/**
|
|
3096
3450
|
* <p>The resource ARN for the tag.</p>
|
|
@@ -3102,6 +3456,7 @@ export interface UntagResourceRequest {
|
|
|
3102
3456
|
TagKeys: string[] | undefined;
|
|
3103
3457
|
}
|
|
3104
3458
|
/**
|
|
3459
|
+
* @public
|
|
3105
3460
|
* <p>Updates an Api.</p>
|
|
3106
3461
|
*/
|
|
3107
3462
|
export interface UpdateApiRequest {
|
|
@@ -3130,7 +3485,7 @@ export interface UpdateApiRequest {
|
|
|
3130
3485
|
*/
|
|
3131
3486
|
DisableSchemaValidation?: boolean;
|
|
3132
3487
|
/**
|
|
3133
|
-
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https
|
|
3488
|
+
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://\{api_id\}.execute-api.\{region\}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
|
|
3134
3489
|
*/
|
|
3135
3490
|
DisableExecuteApiEndpoint?: boolean;
|
|
3136
3491
|
/**
|
|
@@ -3142,7 +3497,7 @@ export interface UpdateApiRequest {
|
|
|
3142
3497
|
*/
|
|
3143
3498
|
RouteKey?: string;
|
|
3144
3499
|
/**
|
|
3145
|
-
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be
|
|
3500
|
+
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
3146
3501
|
*/
|
|
3147
3502
|
RouteSelectionExpression?: string;
|
|
3148
3503
|
/**
|
|
@@ -3154,9 +3509,12 @@ export interface UpdateApiRequest {
|
|
|
3154
3509
|
*/
|
|
3155
3510
|
Version?: string;
|
|
3156
3511
|
}
|
|
3512
|
+
/**
|
|
3513
|
+
* @public
|
|
3514
|
+
*/
|
|
3157
3515
|
export interface UpdateApiResponse {
|
|
3158
3516
|
/**
|
|
3159
|
-
* <p>The URI of the API, of the form {api-id}.execute-api
|
|
3517
|
+
* <p>The URI of the API, of the form \{api-id\}.execute-api.\{region\}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>
|
|
3160
3518
|
*/
|
|
3161
3519
|
ApiEndpoint?: string;
|
|
3162
3520
|
/**
|
|
@@ -3188,7 +3546,7 @@ export interface UpdateApiResponse {
|
|
|
3188
3546
|
*/
|
|
3189
3547
|
DisableSchemaValidation?: boolean;
|
|
3190
3548
|
/**
|
|
3191
|
-
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https
|
|
3549
|
+
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://\{api_id\}.execute-api.\{region\}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
|
|
3192
3550
|
*/
|
|
3193
3551
|
DisableExecuteApiEndpoint?: boolean;
|
|
3194
3552
|
/**
|
|
@@ -3204,7 +3562,7 @@ export interface UpdateApiResponse {
|
|
|
3204
3562
|
*/
|
|
3205
3563
|
ProtocolType?: ProtocolType | string;
|
|
3206
3564
|
/**
|
|
3207
|
-
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be
|
|
3565
|
+
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
3208
3566
|
*/
|
|
3209
3567
|
RouteSelectionExpression?: string;
|
|
3210
3568
|
/**
|
|
@@ -3221,6 +3579,7 @@ export interface UpdateApiResponse {
|
|
|
3221
3579
|
Warnings?: string[];
|
|
3222
3580
|
}
|
|
3223
3581
|
/**
|
|
3582
|
+
* @public
|
|
3224
3583
|
* <p>Updates an ApiMapping.</p>
|
|
3225
3584
|
*/
|
|
3226
3585
|
export interface UpdateApiMappingRequest {
|
|
@@ -3245,6 +3604,9 @@ export interface UpdateApiMappingRequest {
|
|
|
3245
3604
|
*/
|
|
3246
3605
|
Stage?: string;
|
|
3247
3606
|
}
|
|
3607
|
+
/**
|
|
3608
|
+
* @public
|
|
3609
|
+
*/
|
|
3248
3610
|
export interface UpdateApiMappingResponse {
|
|
3249
3611
|
/**
|
|
3250
3612
|
* <p>The API identifier.</p>
|
|
@@ -3264,6 +3626,7 @@ export interface UpdateApiMappingResponse {
|
|
|
3264
3626
|
Stage?: string;
|
|
3265
3627
|
}
|
|
3266
3628
|
/**
|
|
3629
|
+
* @public
|
|
3267
3630
|
* <p>Updates an Authorizer.</p>
|
|
3268
3631
|
*/
|
|
3269
3632
|
export interface UpdateAuthorizerRequest {
|
|
@@ -3292,8 +3655,8 @@ export interface UpdateAuthorizerRequest {
|
|
|
3292
3655
|
*/
|
|
3293
3656
|
AuthorizerType?: AuthorizerType | string;
|
|
3294
3657
|
/**
|
|
3295
|
-
* <p>The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable
|
|
3296
|
-
* , where <replaceable></replaceable
|
|
3658
|
+
* <p>The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable>\{account_id\}</replaceable>:function:<replaceable>\{lambda_function_name\}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>\{region\}</replaceable>:lambda:path/<replaceable>\{service_api\}</replaceable>
|
|
3659
|
+
* , where <replaceable></replaceable>\{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. Supported only for REQUEST authorizers.</p>
|
|
3297
3660
|
*/
|
|
3298
3661
|
AuthorizerUri?: string;
|
|
3299
3662
|
/**
|
|
@@ -3317,6 +3680,9 @@ export interface UpdateAuthorizerRequest {
|
|
|
3317
3680
|
*/
|
|
3318
3681
|
Name?: string;
|
|
3319
3682
|
}
|
|
3683
|
+
/**
|
|
3684
|
+
* @public
|
|
3685
|
+
*/
|
|
3320
3686
|
export interface UpdateAuthorizerResponse {
|
|
3321
3687
|
/**
|
|
3322
3688
|
* <p>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, don't specify this parameter. Supported only for REQUEST authorizers.</p>
|
|
@@ -3339,8 +3705,8 @@ export interface UpdateAuthorizerResponse {
|
|
|
3339
3705
|
*/
|
|
3340
3706
|
AuthorizerType?: AuthorizerType | string;
|
|
3341
3707
|
/**
|
|
3342
|
-
* <p>The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable
|
|
3343
|
-
* , where <replaceable></replaceable
|
|
3708
|
+
* <p>The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable>\{account_id\}</replaceable>:function:<replaceable>\{lambda_function_name\}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>\{region\}</replaceable>:lambda:path/<replaceable>\{service_api\}</replaceable>
|
|
3709
|
+
* , where <replaceable></replaceable>\{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. Supported only for REQUEST authorizers.</p>
|
|
3344
3710
|
*/
|
|
3345
3711
|
AuthorizerUri?: string;
|
|
3346
3712
|
/**
|
|
@@ -3365,6 +3731,7 @@ export interface UpdateAuthorizerResponse {
|
|
|
3365
3731
|
Name?: string;
|
|
3366
3732
|
}
|
|
3367
3733
|
/**
|
|
3734
|
+
* @public
|
|
3368
3735
|
* <p>Updates a Deployment.</p>
|
|
3369
3736
|
*/
|
|
3370
3737
|
export interface UpdateDeploymentRequest {
|
|
@@ -3381,6 +3748,9 @@ export interface UpdateDeploymentRequest {
|
|
|
3381
3748
|
*/
|
|
3382
3749
|
Description?: string;
|
|
3383
3750
|
}
|
|
3751
|
+
/**
|
|
3752
|
+
* @public
|
|
3753
|
+
*/
|
|
3384
3754
|
export interface UpdateDeploymentResponse {
|
|
3385
3755
|
/**
|
|
3386
3756
|
* <p>Specifies whether a deployment was automatically released.</p>
|
|
@@ -3408,6 +3778,7 @@ export interface UpdateDeploymentResponse {
|
|
|
3408
3778
|
Description?: string;
|
|
3409
3779
|
}
|
|
3410
3780
|
/**
|
|
3781
|
+
* @public
|
|
3411
3782
|
* <p>Updates a DomainName.</p>
|
|
3412
3783
|
*/
|
|
3413
3784
|
export interface UpdateDomainNameRequest {
|
|
@@ -3424,6 +3795,9 @@ export interface UpdateDomainNameRequest {
|
|
|
3424
3795
|
*/
|
|
3425
3796
|
MutualTlsAuthentication?: MutualTlsAuthenticationInput;
|
|
3426
3797
|
}
|
|
3798
|
+
/**
|
|
3799
|
+
* @public
|
|
3800
|
+
*/
|
|
3427
3801
|
export interface UpdateDomainNameResponse {
|
|
3428
3802
|
/**
|
|
3429
3803
|
* <p>The API mapping selection expression.</p>
|
|
@@ -3447,6 +3821,7 @@ export interface UpdateDomainNameResponse {
|
|
|
3447
3821
|
Tags?: Record<string, string>;
|
|
3448
3822
|
}
|
|
3449
3823
|
/**
|
|
3824
|
+
* @public
|
|
3450
3825
|
* <p>Updates an Integration.</p>
|
|
3451
3826
|
*/
|
|
3452
3827
|
export interface UpdateIntegrationRequest {
|
|
@@ -3503,11 +3878,11 @@ export interface UpdateIntegrationRequest {
|
|
|
3503
3878
|
*/
|
|
3504
3879
|
PayloadFormatVersion?: string;
|
|
3505
3880
|
/**
|
|
3506
|
-
* <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable
|
|
3881
|
+
* <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>\{location\}</replaceable>.<replaceable>\{name\}</replaceable>
|
|
3507
3882
|
* , where
|
|
3508
|
-
* <replaceable
|
|
3883
|
+
* <replaceable>\{location\}</replaceable>
|
|
3509
3884
|
* is querystring, path, or header; and
|
|
3510
|
-
* <replaceable
|
|
3885
|
+
* <replaceable>\{name\}</replaceable>
|
|
3511
3886
|
* must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.">Transforming API requests and responses</a>.</p>
|
|
3512
3887
|
*/
|
|
3513
3888
|
RequestParameters?: Record<string, string>;
|
|
@@ -3532,6 +3907,9 @@ export interface UpdateIntegrationRequest {
|
|
|
3532
3907
|
*/
|
|
3533
3908
|
TlsConfig?: TlsConfigInput;
|
|
3534
3909
|
}
|
|
3910
|
+
/**
|
|
3911
|
+
* @public
|
|
3912
|
+
*/
|
|
3535
3913
|
export interface UpdateIntegrationResult {
|
|
3536
3914
|
/**
|
|
3537
3915
|
* <p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>
|
|
@@ -3590,11 +3968,11 @@ export interface UpdateIntegrationResult {
|
|
|
3590
3968
|
*/
|
|
3591
3969
|
PayloadFormatVersion?: string;
|
|
3592
3970
|
/**
|
|
3593
|
-
* <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable
|
|
3971
|
+
* <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>\{location\}</replaceable>.<replaceable>\{name\}</replaceable>
|
|
3594
3972
|
* , where
|
|
3595
|
-
* <replaceable
|
|
3973
|
+
* <replaceable>\{location\}</replaceable>
|
|
3596
3974
|
* is querystring, path, or header; and
|
|
3597
|
-
* <replaceable
|
|
3975
|
+
* <replaceable>\{name\}</replaceable>
|
|
3598
3976
|
* must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
|
|
3599
3977
|
*/
|
|
3600
3978
|
RequestParameters?: Record<string, string>;
|
|
@@ -3620,6 +3998,7 @@ export interface UpdateIntegrationResult {
|
|
|
3620
3998
|
TlsConfig?: TlsConfig;
|
|
3621
3999
|
}
|
|
3622
4000
|
/**
|
|
4001
|
+
* @public
|
|
3623
4002
|
* <p>Updates an IntegrationResponses.</p>
|
|
3624
4003
|
*/
|
|
3625
4004
|
export interface UpdateIntegrationResponseRequest {
|
|
@@ -3644,13 +4023,13 @@ export interface UpdateIntegrationResponseRequest {
|
|
|
3644
4023
|
*/
|
|
3645
4024
|
IntegrationResponseKey?: string;
|
|
3646
4025
|
/**
|
|
3647
|
-
* <p>A key-value map specifying response parameters that are passed to the method response from the backend. 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.<replaceable
|
|
3648
|
-
* , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.<replaceable
|
|
3649
|
-
* or integration.response.body.<replaceable
|
|
4026
|
+
* <p>A key-value map specifying response parameters that are passed to the method response from the backend. 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.<replaceable>\{name\}</replaceable>
|
|
4027
|
+
* , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.<replaceable>\{name\}</replaceable>
|
|
4028
|
+
* or integration.response.body.<replaceable>\{JSON-expression\}</replaceable>
|
|
3650
4029
|
* , where
|
|
3651
|
-
* <replaceable
|
|
4030
|
+
* <replaceable>\{name\}</replaceable>
|
|
3652
4031
|
* is a valid and unique response header name and
|
|
3653
|
-
* <replaceable
|
|
4032
|
+
* <replaceable>\{JSON-expression\}</replaceable>
|
|
3654
4033
|
* is a valid JSON expression without the $ prefix.</p>
|
|
3655
4034
|
*/
|
|
3656
4035
|
ResponseParameters?: Record<string, string>;
|
|
@@ -3663,6 +4042,9 @@ export interface UpdateIntegrationResponseRequest {
|
|
|
3663
4042
|
*/
|
|
3664
4043
|
TemplateSelectionExpression?: string;
|
|
3665
4044
|
}
|
|
4045
|
+
/**
|
|
4046
|
+
* @public
|
|
4047
|
+
*/
|
|
3666
4048
|
export interface UpdateIntegrationResponseResponse {
|
|
3667
4049
|
/**
|
|
3668
4050
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
@@ -3677,7 +4059,7 @@ export interface UpdateIntegrationResponseResponse {
|
|
|
3677
4059
|
*/
|
|
3678
4060
|
IntegrationResponseKey?: string;
|
|
3679
4061
|
/**
|
|
3680
|
-
* <p>A key-value map specifying response parameters that are passed to the method response from the backend. 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
|
|
4062
|
+
* <p>A key-value map specifying response parameters that are passed to the method response from the backend. 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.</p>
|
|
3681
4063
|
*/
|
|
3682
4064
|
ResponseParameters?: Record<string, string>;
|
|
3683
4065
|
/**
|
|
@@ -3690,6 +4072,7 @@ export interface UpdateIntegrationResponseResponse {
|
|
|
3690
4072
|
TemplateSelectionExpression?: string;
|
|
3691
4073
|
}
|
|
3692
4074
|
/**
|
|
4075
|
+
* @public
|
|
3693
4076
|
* <p>Updates a Model.</p>
|
|
3694
4077
|
*/
|
|
3695
4078
|
export interface UpdateModelRequest {
|
|
@@ -3718,6 +4101,9 @@ export interface UpdateModelRequest {
|
|
|
3718
4101
|
*/
|
|
3719
4102
|
Schema?: string;
|
|
3720
4103
|
}
|
|
4104
|
+
/**
|
|
4105
|
+
* @public
|
|
4106
|
+
*/
|
|
3721
4107
|
export interface UpdateModelResponse {
|
|
3722
4108
|
/**
|
|
3723
4109
|
* <p>The content-type for the model, for example, "application/json".</p>
|
|
@@ -3741,6 +4127,7 @@ export interface UpdateModelResponse {
|
|
|
3741
4127
|
Schema?: string;
|
|
3742
4128
|
}
|
|
3743
4129
|
/**
|
|
4130
|
+
* @public
|
|
3744
4131
|
* <p>Updates a Route.</p>
|
|
3745
4132
|
*/
|
|
3746
4133
|
export interface UpdateRouteRequest {
|
|
@@ -3797,6 +4184,9 @@ export interface UpdateRouteRequest {
|
|
|
3797
4184
|
*/
|
|
3798
4185
|
Target?: string;
|
|
3799
4186
|
}
|
|
4187
|
+
/**
|
|
4188
|
+
* @public
|
|
4189
|
+
*/
|
|
3800
4190
|
export interface UpdateRouteResult {
|
|
3801
4191
|
/**
|
|
3802
4192
|
* <p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>
|
|
@@ -3852,6 +4242,7 @@ export interface UpdateRouteResult {
|
|
|
3852
4242
|
Target?: string;
|
|
3853
4243
|
}
|
|
3854
4244
|
/**
|
|
4245
|
+
* @public
|
|
3855
4246
|
* <p>Updates a RouteResponse.</p>
|
|
3856
4247
|
*/
|
|
3857
4248
|
export interface UpdateRouteResponseRequest {
|
|
@@ -3884,6 +4275,9 @@ export interface UpdateRouteResponseRequest {
|
|
|
3884
4275
|
*/
|
|
3885
4276
|
RouteResponseKey?: string;
|
|
3886
4277
|
}
|
|
4278
|
+
/**
|
|
4279
|
+
* @public
|
|
4280
|
+
*/
|
|
3887
4281
|
export interface UpdateRouteResponseResponse {
|
|
3888
4282
|
/**
|
|
3889
4283
|
* <p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>
|
|
@@ -3907,6 +4301,7 @@ export interface UpdateRouteResponseResponse {
|
|
|
3907
4301
|
RouteResponseKey?: string;
|
|
3908
4302
|
}
|
|
3909
4303
|
/**
|
|
4304
|
+
* @public
|
|
3910
4305
|
* <p>Updates a Stage.</p>
|
|
3911
4306
|
*/
|
|
3912
4307
|
export interface UpdateStageRequest {
|
|
@@ -3951,6 +4346,9 @@ export interface UpdateStageRequest {
|
|
|
3951
4346
|
*/
|
|
3952
4347
|
StageVariables?: Record<string, string>;
|
|
3953
4348
|
}
|
|
4349
|
+
/**
|
|
4350
|
+
* @public
|
|
4351
|
+
*/
|
|
3954
4352
|
export interface UpdateStageResponse {
|
|
3955
4353
|
/**
|
|
3956
4354
|
* <p>Settings for logging access in this stage.</p>
|
|
@@ -4010,6 +4408,7 @@ export interface UpdateStageResponse {
|
|
|
4010
4408
|
Tags?: Record<string, string>;
|
|
4011
4409
|
}
|
|
4012
4410
|
/**
|
|
4411
|
+
* @public
|
|
4013
4412
|
* <p>Updates a VPC link.</p>
|
|
4014
4413
|
*/
|
|
4015
4414
|
export interface UpdateVpcLinkRequest {
|
|
@@ -4022,6 +4421,9 @@ export interface UpdateVpcLinkRequest {
|
|
|
4022
4421
|
*/
|
|
4023
4422
|
VpcLinkId: string | undefined;
|
|
4024
4423
|
}
|
|
4424
|
+
/**
|
|
4425
|
+
* @public
|
|
4426
|
+
*/
|
|
4025
4427
|
export interface UpdateVpcLinkResponse {
|
|
4026
4428
|
/**
|
|
4027
4429
|
* <p>The timestamp when the VPC link was created.</p>
|