aws-sdk 2.583.0 → 2.587.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/CHANGELOG.md +26 -1
- package/README.md +1 -1
- package/apis/apigatewayv2-2018-11-29.min.json +632 -201
- package/apis/ebs-2019-11-02.examples.json +5 -0
- package/apis/ebs-2019-11-02.min.json +195 -0
- package/apis/ebs-2019-11-02.paginators.json +14 -0
- package/apis/kafka-2018-11-14.min.json +170 -34
- package/apis/kendra-2019-02-03.min.json +2 -1
- package/apis/kinesis-video-signaling-2019-12-04.examples.json +5 -0
- package/apis/kinesis-video-signaling-2019-12-04.min.json +79 -0
- package/apis/kinesis-video-signaling-2019-12-04.paginators.json +4 -0
- package/apis/kinesisvideo-2017-09-30.min.json +281 -8
- package/apis/kinesisvideo-2017-09-30.paginators.json +6 -0
- package/apis/lambda-2015-03-31.min.json +217 -25
- package/apis/lambda-2015-03-31.paginators.json +6 -0
- package/apis/metadata.json +8 -0
- package/apis/rds-2014-10-31.min.json +495 -101
- package/apis/rds-2014-10-31.paginators.json +18 -0
- package/apis/rekognition-2016-06-27.min.json +409 -85
- package/apis/rekognition-2016-06-27.paginators.json +12 -0
- package/apis/rekognition-2016-06-27.waiters2.json +45 -0
- package/apis/sagemaker-2017-07-24.min.json +3471 -472
- package/apis/sagemaker-2017-07-24.paginators.json +128 -16
- package/apis/sagemaker-2017-07-24.waiters2.json +30 -0
- package/apis/ssm-2014-11-06.min.json +94 -71
- package/apis/states-2016-11-23.min.json +92 -55
- package/clients/all.d.ts +2 -0
- package/clients/all.js +3 -1
- package/clients/apigatewayv2.d.ts +856 -1161
- package/clients/applicationautoscaling.d.ts +32 -32
- package/clients/browser_default.d.ts +1 -0
- package/clients/browser_default.js +2 -1
- package/clients/ebs.d.ts +211 -0
- package/clients/ebs.js +18 -0
- package/clients/kafka.d.ts +152 -0
- package/clients/kendra.d.ts +7 -3
- package/clients/kinesisvideo.d.ts +312 -1
- package/clients/kinesisvideosignalingchannels.d.ts +121 -0
- package/clients/kinesisvideosignalingchannels.js +18 -0
- package/clients/kms.d.ts +6 -6
- package/clients/lambda.d.ts +199 -2
- package/clients/quicksight.d.ts +223 -223
- package/clients/rds.d.ts +549 -0
- package/clients/rekognition.d.ts +423 -8
- package/clients/rekognition.js +1 -0
- package/clients/sagemaker.d.ts +4588 -610
- package/clients/ssm.d.ts +42 -6
- package/clients/stepfunctions.d.ts +54 -0
- package/dist/aws-sdk-core-react-native.js +2 -2
- package/dist/aws-sdk-react-native.js +1182 -1102
- package/dist/aws-sdk.js +2265 -859
- package/dist/aws-sdk.min.js +35 -35
- package/lib/config.d.ts +12 -0
- package/lib/config_service_placeholders.d.ts +4 -0
- package/lib/core.js +1 -1
- package/lib/services/s3.js +5 -4
- package/lib/services/sts.js +2 -4
- package/package.json +1 -1
- package/scripts/region-checker/whitelist.js +5 -5
|
@@ -54,11 +54,11 @@ declare class ApiGatewayV2 extends Service {
|
|
|
54
54
|
/**
|
|
55
55
|
* Creates an Integration.
|
|
56
56
|
*/
|
|
57
|
-
createIntegration(params: ApiGatewayV2.Types.CreateIntegrationRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.
|
|
57
|
+
createIntegration(params: ApiGatewayV2.Types.CreateIntegrationRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateIntegrationResult) => void): Request<ApiGatewayV2.Types.CreateIntegrationResult, AWSError>;
|
|
58
58
|
/**
|
|
59
59
|
* Creates an Integration.
|
|
60
60
|
*/
|
|
61
|
-
createIntegration(callback?: (err: AWSError, data: ApiGatewayV2.Types.
|
|
61
|
+
createIntegration(callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateIntegrationResult) => void): Request<ApiGatewayV2.Types.CreateIntegrationResult, AWSError>;
|
|
62
62
|
/**
|
|
63
63
|
* Creates an IntegrationResponses.
|
|
64
64
|
*/
|
|
@@ -78,11 +78,11 @@ declare class ApiGatewayV2 extends Service {
|
|
|
78
78
|
/**
|
|
79
79
|
* Creates a Route for an API.
|
|
80
80
|
*/
|
|
81
|
-
createRoute(params: ApiGatewayV2.Types.CreateRouteRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.
|
|
81
|
+
createRoute(params: ApiGatewayV2.Types.CreateRouteRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateRouteResult) => void): Request<ApiGatewayV2.Types.CreateRouteResult, AWSError>;
|
|
82
82
|
/**
|
|
83
83
|
* Creates a Route for an API.
|
|
84
84
|
*/
|
|
85
|
-
createRoute(callback?: (err: AWSError, data: ApiGatewayV2.Types.
|
|
85
|
+
createRoute(callback?: (err: AWSError, data: ApiGatewayV2.Types.CreateRouteResult) => void): Request<ApiGatewayV2.Types.CreateRouteResult, AWSError>;
|
|
86
86
|
/**
|
|
87
87
|
* Creates a RouteResponse for a Route.
|
|
88
88
|
*/
|
|
@@ -123,6 +123,14 @@ declare class ApiGatewayV2 extends Service {
|
|
|
123
123
|
* Deletes an Authorizer.
|
|
124
124
|
*/
|
|
125
125
|
deleteAuthorizer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
126
|
+
/**
|
|
127
|
+
* Deletes a CORS configuration.
|
|
128
|
+
*/
|
|
129
|
+
deleteCorsConfiguration(params: ApiGatewayV2.Types.DeleteCorsConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
130
|
+
/**
|
|
131
|
+
* Deletes a CORS configuration.
|
|
132
|
+
*/
|
|
133
|
+
deleteCorsConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
126
134
|
/**
|
|
127
135
|
* Deletes a Deployment.
|
|
128
136
|
*/
|
|
@@ -179,6 +187,14 @@ declare class ApiGatewayV2 extends Service {
|
|
|
179
187
|
* Deletes a RouteResponse.
|
|
180
188
|
*/
|
|
181
189
|
deleteRouteResponse(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
190
|
+
/**
|
|
191
|
+
* Deletes the RouteSettings for a stage.
|
|
192
|
+
*/
|
|
193
|
+
deleteRouteSettings(params: ApiGatewayV2.Types.DeleteRouteSettingsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
194
|
+
/**
|
|
195
|
+
* Deletes the RouteSettings for a stage.
|
|
196
|
+
*/
|
|
197
|
+
deleteRouteSettings(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
182
198
|
/**
|
|
183
199
|
* Deletes a Stage.
|
|
184
200
|
*/
|
|
@@ -196,19 +212,19 @@ declare class ApiGatewayV2 extends Service {
|
|
|
196
212
|
*/
|
|
197
213
|
getApi(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetApiResponse) => void): Request<ApiGatewayV2.Types.GetApiResponse, AWSError>;
|
|
198
214
|
/**
|
|
199
|
-
*
|
|
215
|
+
* Gets an API mapping.
|
|
200
216
|
*/
|
|
201
217
|
getApiMapping(params: ApiGatewayV2.Types.GetApiMappingRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetApiMappingResponse) => void): Request<ApiGatewayV2.Types.GetApiMappingResponse, AWSError>;
|
|
202
218
|
/**
|
|
203
|
-
*
|
|
219
|
+
* Gets an API mapping.
|
|
204
220
|
*/
|
|
205
221
|
getApiMapping(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetApiMappingResponse) => void): Request<ApiGatewayV2.Types.GetApiMappingResponse, AWSError>;
|
|
206
222
|
/**
|
|
207
|
-
*
|
|
223
|
+
* Gets API mappings.
|
|
208
224
|
*/
|
|
209
225
|
getApiMappings(params: ApiGatewayV2.Types.GetApiMappingsRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetApiMappingsResponse) => void): Request<ApiGatewayV2.Types.GetApiMappingsResponse, AWSError>;
|
|
210
226
|
/**
|
|
211
|
-
*
|
|
227
|
+
* Gets API mappings.
|
|
212
228
|
*/
|
|
213
229
|
getApiMappings(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetApiMappingsResponse) => void): Request<ApiGatewayV2.Types.GetApiMappingsResponse, AWSError>;
|
|
214
230
|
/**
|
|
@@ -270,11 +286,11 @@ declare class ApiGatewayV2 extends Service {
|
|
|
270
286
|
/**
|
|
271
287
|
* Gets an Integration.
|
|
272
288
|
*/
|
|
273
|
-
getIntegration(params: ApiGatewayV2.Types.GetIntegrationRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.
|
|
289
|
+
getIntegration(params: ApiGatewayV2.Types.GetIntegrationRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetIntegrationResult) => void): Request<ApiGatewayV2.Types.GetIntegrationResult, AWSError>;
|
|
274
290
|
/**
|
|
275
291
|
* Gets an Integration.
|
|
276
292
|
*/
|
|
277
|
-
getIntegration(callback?: (err: AWSError, data: ApiGatewayV2.Types.
|
|
293
|
+
getIntegration(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetIntegrationResult) => void): Request<ApiGatewayV2.Types.GetIntegrationResult, AWSError>;
|
|
278
294
|
/**
|
|
279
295
|
* Gets an IntegrationResponses.
|
|
280
296
|
*/
|
|
@@ -326,11 +342,11 @@ declare class ApiGatewayV2 extends Service {
|
|
|
326
342
|
/**
|
|
327
343
|
* Gets a Route.
|
|
328
344
|
*/
|
|
329
|
-
getRoute(params: ApiGatewayV2.Types.GetRouteRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.
|
|
345
|
+
getRoute(params: ApiGatewayV2.Types.GetRouteRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetRouteResult) => void): Request<ApiGatewayV2.Types.GetRouteResult, AWSError>;
|
|
330
346
|
/**
|
|
331
347
|
* Gets a Route.
|
|
332
348
|
*/
|
|
333
|
-
getRoute(callback?: (err: AWSError, data: ApiGatewayV2.Types.
|
|
349
|
+
getRoute(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetRouteResult) => void): Request<ApiGatewayV2.Types.GetRouteResult, AWSError>;
|
|
334
350
|
/**
|
|
335
351
|
* Gets a RouteResponse.
|
|
336
352
|
*/
|
|
@@ -372,27 +388,43 @@ declare class ApiGatewayV2 extends Service {
|
|
|
372
388
|
*/
|
|
373
389
|
getStages(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetStagesResponse) => void): Request<ApiGatewayV2.Types.GetStagesResponse, AWSError>;
|
|
374
390
|
/**
|
|
375
|
-
* Gets
|
|
391
|
+
* Gets a collection of Tag resources.
|
|
376
392
|
*/
|
|
377
393
|
getTags(params: ApiGatewayV2.Types.GetTagsRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.GetTagsResponse) => void): Request<ApiGatewayV2.Types.GetTagsResponse, AWSError>;
|
|
378
394
|
/**
|
|
379
|
-
* Gets
|
|
395
|
+
* Gets a collection of Tag resources.
|
|
380
396
|
*/
|
|
381
397
|
getTags(callback?: (err: AWSError, data: ApiGatewayV2.Types.GetTagsResponse) => void): Request<ApiGatewayV2.Types.GetTagsResponse, AWSError>;
|
|
382
398
|
/**
|
|
383
|
-
*
|
|
399
|
+
* Imports an API.
|
|
400
|
+
*/
|
|
401
|
+
importApi(params: ApiGatewayV2.Types.ImportApiRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.ImportApiResponse) => void): Request<ApiGatewayV2.Types.ImportApiResponse, AWSError>;
|
|
402
|
+
/**
|
|
403
|
+
* Imports an API.
|
|
404
|
+
*/
|
|
405
|
+
importApi(callback?: (err: AWSError, data: ApiGatewayV2.Types.ImportApiResponse) => void): Request<ApiGatewayV2.Types.ImportApiResponse, AWSError>;
|
|
406
|
+
/**
|
|
407
|
+
* Puts an Api resource.
|
|
408
|
+
*/
|
|
409
|
+
reimportApi(params: ApiGatewayV2.Types.ReimportApiRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.ReimportApiResponse) => void): Request<ApiGatewayV2.Types.ReimportApiResponse, AWSError>;
|
|
410
|
+
/**
|
|
411
|
+
* Puts an Api resource.
|
|
412
|
+
*/
|
|
413
|
+
reimportApi(callback?: (err: AWSError, data: ApiGatewayV2.Types.ReimportApiResponse) => void): Request<ApiGatewayV2.Types.ReimportApiResponse, AWSError>;
|
|
414
|
+
/**
|
|
415
|
+
* Creates a new Tag resource to represent a tag.
|
|
384
416
|
*/
|
|
385
417
|
tagResource(params: ApiGatewayV2.Types.TagResourceRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.TagResourceResponse) => void): Request<ApiGatewayV2.Types.TagResourceResponse, AWSError>;
|
|
386
418
|
/**
|
|
387
|
-
* Tag
|
|
419
|
+
* Creates a new Tag resource to represent a tag.
|
|
388
420
|
*/
|
|
389
421
|
tagResource(callback?: (err: AWSError, data: ApiGatewayV2.Types.TagResourceResponse) => void): Request<ApiGatewayV2.Types.TagResourceResponse, AWSError>;
|
|
390
422
|
/**
|
|
391
|
-
*
|
|
423
|
+
* Deletes a Tag.
|
|
392
424
|
*/
|
|
393
425
|
untagResource(params: ApiGatewayV2.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
394
426
|
/**
|
|
395
|
-
*
|
|
427
|
+
* Deletes a Tag.
|
|
396
428
|
*/
|
|
397
429
|
untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
398
430
|
/**
|
|
@@ -438,11 +470,11 @@ declare class ApiGatewayV2 extends Service {
|
|
|
438
470
|
/**
|
|
439
471
|
* Updates an Integration.
|
|
440
472
|
*/
|
|
441
|
-
updateIntegration(params: ApiGatewayV2.Types.UpdateIntegrationRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.
|
|
473
|
+
updateIntegration(params: ApiGatewayV2.Types.UpdateIntegrationRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateIntegrationResult) => void): Request<ApiGatewayV2.Types.UpdateIntegrationResult, AWSError>;
|
|
442
474
|
/**
|
|
443
475
|
* Updates an Integration.
|
|
444
476
|
*/
|
|
445
|
-
updateIntegration(callback?: (err: AWSError, data: ApiGatewayV2.Types.
|
|
477
|
+
updateIntegration(callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateIntegrationResult) => void): Request<ApiGatewayV2.Types.UpdateIntegrationResult, AWSError>;
|
|
446
478
|
/**
|
|
447
479
|
* Updates an IntegrationResponses.
|
|
448
480
|
*/
|
|
@@ -462,11 +494,11 @@ declare class ApiGatewayV2 extends Service {
|
|
|
462
494
|
/**
|
|
463
495
|
* Updates a Route.
|
|
464
496
|
*/
|
|
465
|
-
updateRoute(params: ApiGatewayV2.Types.UpdateRouteRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.
|
|
497
|
+
updateRoute(params: ApiGatewayV2.Types.UpdateRouteRequest, callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateRouteResult) => void): Request<ApiGatewayV2.Types.UpdateRouteResult, AWSError>;
|
|
466
498
|
/**
|
|
467
499
|
* Updates a Route.
|
|
468
500
|
*/
|
|
469
|
-
updateRoute(callback?: (err: AWSError, data: ApiGatewayV2.Types.
|
|
501
|
+
updateRoute(callback?: (err: AWSError, data: ApiGatewayV2.Types.UpdateRouteResult) => void): Request<ApiGatewayV2.Types.UpdateRouteResult, AWSError>;
|
|
470
502
|
/**
|
|
471
503
|
* Updates a RouteResponse.
|
|
472
504
|
*/
|
|
@@ -491,16 +523,13 @@ declare namespace ApiGatewayV2 {
|
|
|
491
523
|
*/
|
|
492
524
|
DestinationArn?: Arn;
|
|
493
525
|
/**
|
|
494
|
-
* A single line format of the access logs of data, as specified by selected $context
|
|
495
|
-
variables. The format must include at least $context.requestId.
|
|
526
|
+
* A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
|
|
496
527
|
*/
|
|
497
528
|
Format?: StringWithLengthBetween1And1024;
|
|
498
529
|
}
|
|
499
530
|
export interface Api {
|
|
500
531
|
/**
|
|
501
|
-
* The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The
|
|
502
|
-
stage name is typically appended to this URI to form a complete path to a deployed
|
|
503
|
-
API stage.
|
|
532
|
+
* 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.
|
|
504
533
|
*/
|
|
505
534
|
ApiEndpoint?: __string;
|
|
506
535
|
/**
|
|
@@ -508,9 +537,13 @@ declare namespace ApiGatewayV2 {
|
|
|
508
537
|
*/
|
|
509
538
|
ApiId?: Id;
|
|
510
539
|
/**
|
|
511
|
-
* An API key selection expression. See API Key Selection Expressions.
|
|
540
|
+
* An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
|
|
512
541
|
*/
|
|
513
542
|
ApiKeySelectionExpression?: SelectionExpression;
|
|
543
|
+
/**
|
|
544
|
+
* A CORS configuration. Supported only for HTTP APIs.
|
|
545
|
+
*/
|
|
546
|
+
CorsConfiguration?: Cors;
|
|
514
547
|
/**
|
|
515
548
|
* The timestamp when the API was created.
|
|
516
549
|
*/
|
|
@@ -520,34 +553,37 @@ declare namespace ApiGatewayV2 {
|
|
|
520
553
|
*/
|
|
521
554
|
Description?: StringWithLengthBetween0And1024;
|
|
522
555
|
/**
|
|
523
|
-
* Avoid validating models when creating a deployment.
|
|
556
|
+
* Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
|
|
524
557
|
*/
|
|
525
558
|
DisableSchemaValidation?: __boolean;
|
|
559
|
+
/**
|
|
560
|
+
* The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
|
|
561
|
+
*/
|
|
562
|
+
ImportInfo?: __listOf__string;
|
|
526
563
|
/**
|
|
527
564
|
* The name of the API.
|
|
528
565
|
*/
|
|
529
566
|
Name: StringWithLengthBetween1And128;
|
|
530
567
|
/**
|
|
531
|
-
* The API protocol
|
|
568
|
+
* The API protocol.
|
|
532
569
|
*/
|
|
533
570
|
ProtocolType: ProtocolType;
|
|
534
571
|
/**
|
|
535
|
-
* The route selection expression for the API.
|
|
572
|
+
* 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.
|
|
536
573
|
*/
|
|
537
574
|
RouteSelectionExpression: SelectionExpression;
|
|
575
|
+
/**
|
|
576
|
+
* A collection of tags associated with the API.
|
|
577
|
+
*/
|
|
578
|
+
Tags?: Tags;
|
|
538
579
|
/**
|
|
539
580
|
* A version identifier for the API.
|
|
540
581
|
*/
|
|
541
582
|
Version?: StringWithLengthBetween1And64;
|
|
542
583
|
/**
|
|
543
|
-
* The warning messages reported when failonwarnings is turned on during
|
|
544
|
-
API import.
|
|
584
|
+
* The warning messages reported when failonwarnings is turned on during API import.
|
|
545
585
|
*/
|
|
546
586
|
Warnings?: __listOf__string;
|
|
547
|
-
/**
|
|
548
|
-
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
|
|
549
|
-
*/
|
|
550
|
-
Tags?: Tags;
|
|
551
587
|
}
|
|
552
588
|
export interface ApiMapping {
|
|
553
589
|
/**
|
|
@@ -569,13 +605,10 @@ declare namespace ApiGatewayV2 {
|
|
|
569
605
|
}
|
|
570
606
|
export type Arn = string;
|
|
571
607
|
export type AuthorizationScopes = StringWithLengthBetween1And64[];
|
|
572
|
-
export type AuthorizationType = "NONE"|"AWS_IAM"|"CUSTOM"|string;
|
|
608
|
+
export type AuthorizationType = "NONE"|"AWS_IAM"|"CUSTOM"|"JWT"|string;
|
|
573
609
|
export interface Authorizer {
|
|
574
610
|
/**
|
|
575
|
-
* Specifies the required credentials as an IAM role for API Gateway to invoke the
|
|
576
|
-
authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon
|
|
577
|
-
Resource Name (ARN). To use resource-based permissions on the Lambda function,
|
|
578
|
-
specify null.
|
|
611
|
+
* Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.
|
|
579
612
|
*/
|
|
580
613
|
AuthorizerCredentialsArn?: Arn;
|
|
581
614
|
/**
|
|
@@ -583,72 +616,75 @@ declare namespace ApiGatewayV2 {
|
|
|
583
616
|
*/
|
|
584
617
|
AuthorizerId?: Id;
|
|
585
618
|
/**
|
|
586
|
-
*
|
|
587
|
-
authorization caching is disabled. If it is greater than 0, API Gateway will cache
|
|
588
|
-
authorizer responses. If this field is not set, the default value is 300. The maximum
|
|
589
|
-
value is 3600, or 1 hour.
|
|
619
|
+
* Authorizer caching is not currently supported. Don't specify this value for authorizers.
|
|
590
620
|
*/
|
|
591
621
|
AuthorizerResultTtlInSeconds?: IntegerWithLengthBetween0And3600;
|
|
592
622
|
/**
|
|
593
|
-
* The authorizer type.
|
|
594
|
-
Lambda function using incoming request parameters.
|
|
623
|
+
* The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
|
|
595
624
|
*/
|
|
596
625
|
AuthorizerType?: AuthorizerType;
|
|
597
626
|
/**
|
|
598
|
-
* The authorizer's Uniform Resource Identifier (URI).
|
|
599
|
-
|
|
600
|
-
well-formed Lambda function URI, for example,
|
|
601
|
-
arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations.
|
|
602
|
-
In general, the URI has this form:
|
|
603
|
-
arn:aws:apigateway:{region}:lambda:path/{service_api}
|
|
604
|
-
, where {region} is the same as the region hosting the Lambda
|
|
605
|
-
function, path indicates that the remaining substring in the URI should be treated as
|
|
606
|
-
the path to the resource, including the initial /. For Lambda functions,
|
|
607
|
-
this is usually of the form
|
|
608
|
-
/2015-03-31/functions/[FunctionARN]/invocations.
|
|
627
|
+
* The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}
|
|
628
|
+
, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.
|
|
609
629
|
*/
|
|
610
630
|
AuthorizerUri?: UriWithLengthBetween1And2048;
|
|
611
631
|
/**
|
|
612
|
-
* The identity source for which authorization is requested.For
|
|
613
|
-
caching is enabled. The value is a comma-separated string of one or more mapping
|
|
614
|
-
expressions of the specified request parameters. For example, if an Auth
|
|
615
|
-
header and a Name query string parameters are defined as identity
|
|
616
|
-
sources, this value is method.request.header.Auth,
|
|
617
|
-
method.request.querystring.Name. These parameters will be used to
|
|
618
|
-
derive the authorization caching key and to perform runtime validation of the
|
|
619
|
-
REQUEST authorizer by verifying all of the identity-related request
|
|
620
|
-
parameters are present, not null, and non-empty. Only when this is true does the
|
|
621
|
-
authorizer invoke the authorizer Lambda function, otherwise, it returns a 401
|
|
622
|
-
Unauthorized response without calling the Lambda function. The valid value
|
|
623
|
-
is a string of comma-separated mapping expressions of the specified request
|
|
624
|
-
parameters. When the authorization caching is not enabled, this property is
|
|
625
|
-
optional.
|
|
632
|
+
* The identity source for which authorization is requested. For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example "$request.header.Authorization".
|
|
626
633
|
*/
|
|
627
634
|
IdentitySource?: IdentitySourceList;
|
|
628
635
|
/**
|
|
629
|
-
* The
|
|
630
|
-
validation expression does not apply to the REQUEST authorizer.
|
|
636
|
+
* The validation expression does not apply to the REQUEST authorizer.
|
|
631
637
|
*/
|
|
632
638
|
IdentityValidationExpression?: StringWithLengthBetween0And1024;
|
|
633
639
|
/**
|
|
634
|
-
*
|
|
640
|
+
* Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
|
|
635
641
|
*/
|
|
636
|
-
|
|
642
|
+
JwtConfiguration?: JWTConfiguration;
|
|
637
643
|
/**
|
|
638
|
-
*
|
|
639
|
-
REQUEST authorizer, this is not
|
|
640
|
-
defined.
|
|
644
|
+
* The name of the authorizer.
|
|
641
645
|
*/
|
|
642
|
-
|
|
646
|
+
Name: StringWithLengthBetween1And128;
|
|
643
647
|
}
|
|
644
|
-
export type AuthorizerType = "REQUEST"|string;
|
|
648
|
+
export type AuthorizerType = "REQUEST"|"JWT"|string;
|
|
645
649
|
export type ConnectionType = "INTERNET"|"VPC_LINK"|string;
|
|
646
650
|
export type ContentHandlingStrategy = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT"|string;
|
|
651
|
+
export interface Cors {
|
|
652
|
+
/**
|
|
653
|
+
* Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
|
|
654
|
+
*/
|
|
655
|
+
AllowCredentials?: __boolean;
|
|
656
|
+
/**
|
|
657
|
+
* Represents a collection of allowed headers. Supported only for HTTP APIs.
|
|
658
|
+
*/
|
|
659
|
+
AllowHeaders?: CorsHeaderList;
|
|
660
|
+
/**
|
|
661
|
+
* Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
|
|
662
|
+
*/
|
|
663
|
+
AllowMethods?: CorsMethodList;
|
|
664
|
+
/**
|
|
665
|
+
* Represents a collection of allowed origins. Supported only for HTTP APIs.
|
|
666
|
+
*/
|
|
667
|
+
AllowOrigins?: CorsOriginList;
|
|
668
|
+
/**
|
|
669
|
+
* Represents a collection of exposed headers. Supported only for HTTP APIs.
|
|
670
|
+
*/
|
|
671
|
+
ExposeHeaders?: CorsHeaderList;
|
|
672
|
+
/**
|
|
673
|
+
* The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
|
|
674
|
+
*/
|
|
675
|
+
MaxAge?: IntegerWithLengthBetweenMinus1And86400;
|
|
676
|
+
}
|
|
677
|
+
export type CorsHeaderList = __string[];
|
|
678
|
+
export type CorsMethodList = StringWithLengthBetween1And64[];
|
|
679
|
+
export type CorsOriginList = __string[];
|
|
647
680
|
export interface CreateApiMappingRequest {
|
|
648
681
|
/**
|
|
649
682
|
* The API identifier.
|
|
650
683
|
*/
|
|
651
684
|
ApiId: Id;
|
|
685
|
+
/**
|
|
686
|
+
* The API mapping key.
|
|
687
|
+
*/
|
|
652
688
|
ApiMappingKey?: SelectionKey;
|
|
653
689
|
/**
|
|
654
690
|
* The domain name.
|
|
@@ -679,15 +715,23 @@ declare namespace ApiGatewayV2 {
|
|
|
679
715
|
}
|
|
680
716
|
export interface CreateApiRequest {
|
|
681
717
|
/**
|
|
682
|
-
* An API key selection expression. See API Key Selection Expressions.
|
|
718
|
+
* An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
|
|
683
719
|
*/
|
|
684
720
|
ApiKeySelectionExpression?: SelectionExpression;
|
|
721
|
+
/**
|
|
722
|
+
* A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
|
|
723
|
+
*/
|
|
724
|
+
CorsConfiguration?: Cors;
|
|
725
|
+
/**
|
|
726
|
+
* This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
|
|
727
|
+
*/
|
|
728
|
+
CredentialsArn?: Arn;
|
|
685
729
|
/**
|
|
686
730
|
* The description of the API.
|
|
687
731
|
*/
|
|
688
732
|
Description?: StringWithLengthBetween0And1024;
|
|
689
733
|
/**
|
|
690
|
-
* Avoid validating models when creating a deployment.
|
|
734
|
+
* Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
|
|
691
735
|
*/
|
|
692
736
|
DisableSchemaValidation?: __boolean;
|
|
693
737
|
/**
|
|
@@ -695,27 +739,33 @@ declare namespace ApiGatewayV2 {
|
|
|
695
739
|
*/
|
|
696
740
|
Name: StringWithLengthBetween1And128;
|
|
697
741
|
/**
|
|
698
|
-
* The API protocol
|
|
742
|
+
* The API protocol.
|
|
699
743
|
*/
|
|
700
744
|
ProtocolType: ProtocolType;
|
|
701
745
|
/**
|
|
702
|
-
* The route
|
|
746
|
+
* This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
|
|
703
747
|
*/
|
|
704
|
-
|
|
748
|
+
RouteKey?: SelectionKey;
|
|
705
749
|
/**
|
|
706
|
-
*
|
|
750
|
+
* 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.
|
|
707
751
|
*/
|
|
708
|
-
|
|
752
|
+
RouteSelectionExpression?: SelectionExpression;
|
|
709
753
|
/**
|
|
710
|
-
* The
|
|
754
|
+
* The collection of tags. Each tag element is associated with a given resource.
|
|
711
755
|
*/
|
|
712
756
|
Tags?: Tags;
|
|
757
|
+
/**
|
|
758
|
+
* This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
|
|
759
|
+
*/
|
|
760
|
+
Target?: UriWithLengthBetween1And2048;
|
|
761
|
+
/**
|
|
762
|
+
* A version identifier for the API.
|
|
763
|
+
*/
|
|
764
|
+
Version?: StringWithLengthBetween1And64;
|
|
713
765
|
}
|
|
714
766
|
export interface CreateApiResponse {
|
|
715
767
|
/**
|
|
716
|
-
* The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The
|
|
717
|
-
stage name is typically appended to this URI to form a complete path to a deployed
|
|
718
|
-
API stage.
|
|
768
|
+
* 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.
|
|
719
769
|
*/
|
|
720
770
|
ApiEndpoint?: __string;
|
|
721
771
|
/**
|
|
@@ -723,9 +773,13 @@ declare namespace ApiGatewayV2 {
|
|
|
723
773
|
*/
|
|
724
774
|
ApiId?: Id;
|
|
725
775
|
/**
|
|
726
|
-
* An API key selection expression. See API Key Selection Expressions.
|
|
776
|
+
* An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
|
|
727
777
|
*/
|
|
728
778
|
ApiKeySelectionExpression?: SelectionExpression;
|
|
779
|
+
/**
|
|
780
|
+
* A CORS configuration. Supported only for HTTP APIs.
|
|
781
|
+
*/
|
|
782
|
+
CorsConfiguration?: Cors;
|
|
729
783
|
/**
|
|
730
784
|
* The timestamp when the API was created.
|
|
731
785
|
*/
|
|
@@ -735,34 +789,37 @@ declare namespace ApiGatewayV2 {
|
|
|
735
789
|
*/
|
|
736
790
|
Description?: StringWithLengthBetween0And1024;
|
|
737
791
|
/**
|
|
738
|
-
* Avoid validating models when creating a deployment.
|
|
792
|
+
* Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
|
|
739
793
|
*/
|
|
740
794
|
DisableSchemaValidation?: __boolean;
|
|
795
|
+
/**
|
|
796
|
+
* The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
|
|
797
|
+
*/
|
|
798
|
+
ImportInfo?: __listOf__string;
|
|
741
799
|
/**
|
|
742
800
|
* The name of the API.
|
|
743
801
|
*/
|
|
744
802
|
Name?: StringWithLengthBetween1And128;
|
|
745
803
|
/**
|
|
746
|
-
* The API protocol
|
|
804
|
+
* The API protocol.
|
|
747
805
|
*/
|
|
748
806
|
ProtocolType?: ProtocolType;
|
|
749
807
|
/**
|
|
750
|
-
* The route selection expression for the API.
|
|
808
|
+
* 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.
|
|
751
809
|
*/
|
|
752
810
|
RouteSelectionExpression?: SelectionExpression;
|
|
811
|
+
/**
|
|
812
|
+
* A collection of tags associated with the API.
|
|
813
|
+
*/
|
|
814
|
+
Tags?: Tags;
|
|
753
815
|
/**
|
|
754
816
|
* A version identifier for the API.
|
|
755
817
|
*/
|
|
756
818
|
Version?: StringWithLengthBetween1And64;
|
|
757
819
|
/**
|
|
758
|
-
* The warning messages reported when failonwarnings is turned on during
|
|
759
|
-
API import.
|
|
820
|
+
* The warning messages reported when failonwarnings is turned on during API import.
|
|
760
821
|
*/
|
|
761
822
|
Warnings?: __listOf__string;
|
|
762
|
-
/**
|
|
763
|
-
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
|
|
764
|
-
*/
|
|
765
|
-
Tags?: Tags;
|
|
766
823
|
}
|
|
767
824
|
export interface CreateAuthorizerRequest {
|
|
768
825
|
/**
|
|
@@ -770,77 +827,42 @@ declare namespace ApiGatewayV2 {
|
|
|
770
827
|
*/
|
|
771
828
|
ApiId: __string;
|
|
772
829
|
/**
|
|
773
|
-
* Specifies the required credentials as an IAM role for API Gateway to invoke the
|
|
774
|
-
authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon
|
|
775
|
-
Resource Name (ARN). To use resource-based permissions on the Lambda function,
|
|
776
|
-
specify null.
|
|
830
|
+
* Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.
|
|
777
831
|
*/
|
|
778
832
|
AuthorizerCredentialsArn?: Arn;
|
|
779
833
|
/**
|
|
780
|
-
*
|
|
781
|
-
authorization caching is disabled. If it is greater than 0, API Gateway will cache
|
|
782
|
-
authorizer responses. If this field is not set, the default value is 300. The maximum
|
|
783
|
-
value is 3600, or 1 hour.
|
|
834
|
+
* Authorizer caching is not currently supported. Don't specify this value for authorizers.
|
|
784
835
|
*/
|
|
785
836
|
AuthorizerResultTtlInSeconds?: IntegerWithLengthBetween0And3600;
|
|
786
837
|
/**
|
|
787
|
-
* The authorizer type.
|
|
788
|
-
Lambda function using incoming request parameters.
|
|
838
|
+
* The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
|
|
789
839
|
*/
|
|
790
840
|
AuthorizerType: AuthorizerType;
|
|
791
841
|
/**
|
|
792
|
-
* The authorizer's Uniform Resource Identifier (URI). For
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
, where {region} is the same as the region hosting the Lambda
|
|
799
|
-
function, path indicates that the remaining substring in the URI should be treated as
|
|
800
|
-
the path to the resource, including the initial /. For Lambda functions,
|
|
801
|
-
this is usually of the form
|
|
802
|
-
/2015-03-31/functions/[FunctionARN]/invocations.
|
|
803
|
-
*/
|
|
804
|
-
AuthorizerUri: UriWithLengthBetween1And2048;
|
|
805
|
-
/**
|
|
806
|
-
* The identity source for which authorization is requested.For the REQUEST authorizer, this is required when authorization
|
|
807
|
-
caching is enabled. The value is a comma-separated string of one or more mapping
|
|
808
|
-
expressions of the specified request parameters. For example, if an Auth
|
|
809
|
-
header and a Name query string parameters are defined as identity
|
|
810
|
-
sources, this value is method.request.header.Auth,
|
|
811
|
-
method.request.querystring.Name. These parameters will be used to
|
|
812
|
-
derive the authorization caching key and to perform runtime validation of the
|
|
813
|
-
REQUEST authorizer by verifying all of the identity-related request
|
|
814
|
-
parameters are present, not null, and non-empty. Only when this is true does the
|
|
815
|
-
authorizer invoke the authorizer Lambda function, otherwise, it returns a 401
|
|
816
|
-
Unauthorized response without calling the Lambda function. The valid value
|
|
817
|
-
is a string of comma-separated mapping expressions of the specified request
|
|
818
|
-
parameters. When the authorization caching is not enabled, this property is
|
|
819
|
-
optional.
|
|
842
|
+
* 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:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}
|
|
843
|
+
, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.
|
|
844
|
+
*/
|
|
845
|
+
AuthorizerUri?: UriWithLengthBetween1And2048;
|
|
846
|
+
/**
|
|
847
|
+
* The identity source for which authorization is requested. For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For JWT, a single entry that specifies where to extract the JSON Web Token (JWT )from inbound requests. Currently only header-based and query parameter-based selections are supported, for example "$request.header.Authorization".
|
|
820
848
|
*/
|
|
821
849
|
IdentitySource: IdentitySourceList;
|
|
822
850
|
/**
|
|
823
|
-
*
|
|
824
|
-
validation expression does not apply to the REQUEST authorizer.
|
|
851
|
+
* This parameter is not used.
|
|
825
852
|
*/
|
|
826
853
|
IdentityValidationExpression?: StringWithLengthBetween0And1024;
|
|
827
854
|
/**
|
|
828
|
-
*
|
|
855
|
+
* Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
|
|
829
856
|
*/
|
|
830
|
-
|
|
857
|
+
JwtConfiguration?: JWTConfiguration;
|
|
831
858
|
/**
|
|
832
|
-
*
|
|
833
|
-
REQUEST authorizer, this is not
|
|
834
|
-
defined.
|
|
859
|
+
* The name of the authorizer.
|
|
835
860
|
*/
|
|
836
|
-
|
|
861
|
+
Name: StringWithLengthBetween1And128;
|
|
837
862
|
}
|
|
838
863
|
export interface CreateAuthorizerResponse {
|
|
839
864
|
/**
|
|
840
|
-
* Specifies the required credentials as an IAM role for API Gateway to invoke the
|
|
841
|
-
authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon
|
|
842
|
-
Resource Name (ARN). To use resource-based permissions on the Lambda function,
|
|
843
|
-
specify null.
|
|
865
|
+
* Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.
|
|
844
866
|
*/
|
|
845
867
|
AuthorizerCredentialsArn?: Arn;
|
|
846
868
|
/**
|
|
@@ -848,63 +870,34 @@ declare namespace ApiGatewayV2 {
|
|
|
848
870
|
*/
|
|
849
871
|
AuthorizerId?: Id;
|
|
850
872
|
/**
|
|
851
|
-
*
|
|
852
|
-
authorization caching is disabled. If it is greater than 0, API Gateway will cache
|
|
853
|
-
authorizer responses. If this field is not set, the default value is 300. The maximum
|
|
854
|
-
value is 3600, or 1 hour.
|
|
873
|
+
* Authorizer caching is not currently supported. Don't specify this value for authorizers.
|
|
855
874
|
*/
|
|
856
875
|
AuthorizerResultTtlInSeconds?: IntegerWithLengthBetween0And3600;
|
|
857
876
|
/**
|
|
858
|
-
* The authorizer type.
|
|
859
|
-
Lambda function using incoming request parameters.
|
|
877
|
+
* The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
|
|
860
878
|
*/
|
|
861
879
|
AuthorizerType?: AuthorizerType;
|
|
862
880
|
/**
|
|
863
|
-
* The authorizer's Uniform Resource Identifier (URI).
|
|
864
|
-
|
|
865
|
-
well-formed Lambda function URI, for example,
|
|
866
|
-
arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations.
|
|
867
|
-
In general, the URI has this form:
|
|
868
|
-
arn:aws:apigateway:{region}:lambda:path/{service_api}
|
|
869
|
-
, where {region} is the same as the region hosting the Lambda
|
|
870
|
-
function, path indicates that the remaining substring in the URI should be treated as
|
|
871
|
-
the path to the resource, including the initial /. For Lambda functions,
|
|
872
|
-
this is usually of the form
|
|
873
|
-
/2015-03-31/functions/[FunctionARN]/invocations.
|
|
881
|
+
* The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}
|
|
882
|
+
, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.
|
|
874
883
|
*/
|
|
875
884
|
AuthorizerUri?: UriWithLengthBetween1And2048;
|
|
876
885
|
/**
|
|
877
|
-
* The identity source for which authorization is requested.For
|
|
878
|
-
caching is enabled. The value is a comma-separated string of one or more mapping
|
|
879
|
-
expressions of the specified request parameters. For example, if an Auth
|
|
880
|
-
header and a Name query string parameters are defined as identity
|
|
881
|
-
sources, this value is method.request.header.Auth,
|
|
882
|
-
method.request.querystring.Name. These parameters will be used to
|
|
883
|
-
derive the authorization caching key and to perform runtime validation of the
|
|
884
|
-
REQUEST authorizer by verifying all of the identity-related request
|
|
885
|
-
parameters are present, not null, and non-empty. Only when this is true does the
|
|
886
|
-
authorizer invoke the authorizer Lambda function, otherwise, it returns a 401
|
|
887
|
-
Unauthorized response without calling the Lambda function. The valid value
|
|
888
|
-
is a string of comma-separated mapping expressions of the specified request
|
|
889
|
-
parameters. When the authorization caching is not enabled, this property is
|
|
890
|
-
optional.
|
|
886
|
+
* The identity source for which authorization is requested. For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example "$request.header.Authorization".
|
|
891
887
|
*/
|
|
892
888
|
IdentitySource?: IdentitySourceList;
|
|
893
889
|
/**
|
|
894
|
-
* The
|
|
895
|
-
validation expression does not apply to the REQUEST authorizer.
|
|
890
|
+
* The validation expression does not apply to the REQUEST authorizer.
|
|
896
891
|
*/
|
|
897
892
|
IdentityValidationExpression?: StringWithLengthBetween0And1024;
|
|
898
893
|
/**
|
|
899
|
-
*
|
|
894
|
+
* Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
|
|
900
895
|
*/
|
|
901
|
-
|
|
896
|
+
JwtConfiguration?: JWTConfiguration;
|
|
902
897
|
/**
|
|
903
|
-
*
|
|
904
|
-
REQUEST authorizer, this is not
|
|
905
|
-
defined.
|
|
898
|
+
* The name of the authorizer.
|
|
906
899
|
*/
|
|
907
|
-
|
|
900
|
+
Name?: StringWithLengthBetween1And128;
|
|
908
901
|
}
|
|
909
902
|
export interface CreateDeploymentRequest {
|
|
910
903
|
/**
|
|
@@ -916,12 +909,15 @@ declare namespace ApiGatewayV2 {
|
|
|
916
909
|
*/
|
|
917
910
|
Description?: StringWithLengthBetween0And1024;
|
|
918
911
|
/**
|
|
919
|
-
* The name of the Stage resource for the Deployment
|
|
920
|
-
resource to create.
|
|
912
|
+
* The name of the Stage resource for the Deployment resource to create.
|
|
921
913
|
*/
|
|
922
914
|
StageName?: StringWithLengthBetween1And128;
|
|
923
915
|
}
|
|
924
916
|
export interface CreateDeploymentResponse {
|
|
917
|
+
/**
|
|
918
|
+
* Specifies whether a deployment was automatically released.
|
|
919
|
+
*/
|
|
920
|
+
AutoDeployed?: __boolean;
|
|
925
921
|
/**
|
|
926
922
|
* The date and time when the Deployment resource was created.
|
|
927
923
|
*/
|
|
@@ -931,8 +927,7 @@ declare namespace ApiGatewayV2 {
|
|
|
931
927
|
*/
|
|
932
928
|
DeploymentId?: Id;
|
|
933
929
|
/**
|
|
934
|
-
* The status of the deployment: PENDING, FAILED, or
|
|
935
|
-
SUCCEEDED.
|
|
930
|
+
* The status of the deployment: PENDING, FAILED, or SUCCEEDED.
|
|
936
931
|
*/
|
|
937
932
|
DeploymentStatus?: DeploymentStatus;
|
|
938
933
|
/**
|
|
@@ -954,7 +949,7 @@ declare namespace ApiGatewayV2 {
|
|
|
954
949
|
*/
|
|
955
950
|
DomainNameConfigurations?: DomainNameConfigurations;
|
|
956
951
|
/**
|
|
957
|
-
* The
|
|
952
|
+
* The collection of tags associated with a domain name.
|
|
958
953
|
*/
|
|
959
954
|
Tags?: Tags;
|
|
960
955
|
}
|
|
@@ -972,7 +967,7 @@ declare namespace ApiGatewayV2 {
|
|
|
972
967
|
*/
|
|
973
968
|
DomainNameConfigurations?: DomainNameConfigurations;
|
|
974
969
|
/**
|
|
975
|
-
* The
|
|
970
|
+
* The collection of tags associated with a domain name.
|
|
976
971
|
*/
|
|
977
972
|
Tags?: Tags;
|
|
978
973
|
}
|
|
@@ -986,30 +981,15 @@ declare namespace ApiGatewayV2 {
|
|
|
986
981
|
*/
|
|
987
982
|
ConnectionId?: StringWithLengthBetween1And1024;
|
|
988
983
|
/**
|
|
989
|
-
* The type of the network connection to the integration endpoint. Currently the only
|
|
990
|
-
valid value is INTERNET, for connections through the public routable
|
|
991
|
-
internet.
|
|
984
|
+
* The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
|
|
992
985
|
*/
|
|
993
986
|
ConnectionType?: ConnectionType;
|
|
994
987
|
/**
|
|
995
|
-
* Specifies how to handle response payload content type conversions. Supported
|
|
996
|
-
values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
|
|
997
|
-
following behaviors:
|
|
998
|
-
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded
|
|
999
|
-
string to the corresponding binary blob.
|
|
1000
|
-
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a
|
|
1001
|
-
Base64-encoded string.If this property is not defined, the response payload will be passed through from
|
|
1002
|
-
the integration response to the route response or method response without
|
|
1003
|
-
modification.
|
|
988
|
+
* 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: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
|
|
1004
989
|
*/
|
|
1005
990
|
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
1006
991
|
/**
|
|
1007
|
-
* Specifies the credentials required for the integration, if any. For AWS
|
|
1008
|
-
integrations, three options are available. To specify an IAM Role for API Gateway to
|
|
1009
|
-
assume, use the role's Amazon Resource Name (ARN). To require that the caller's
|
|
1010
|
-
identity be passed through from the request, specify the string
|
|
1011
|
-
arn:aws:iam::*:user/*. To use resource-based permissions on supported
|
|
1012
|
-
AWS services, specify null.
|
|
992
|
+
* Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
|
|
1013
993
|
*/
|
|
1014
994
|
CredentialsArn?: Arn;
|
|
1015
995
|
/**
|
|
@@ -1021,23 +1001,7 @@ declare namespace ApiGatewayV2 {
|
|
|
1021
1001
|
*/
|
|
1022
1002
|
IntegrationMethod?: StringWithLengthBetween1And64;
|
|
1023
1003
|
/**
|
|
1024
|
-
* The integration type of an integration. One of the following:
|
|
1025
|
-
AWS: for integrating the route or method request with an AWS service
|
|
1026
|
-
action, including the Lambda function-invoking action. With the Lambda
|
|
1027
|
-
function-invoking action, this is referred to as the Lambda custom integration. With
|
|
1028
|
-
any other AWS service action, this is known as AWS integration.
|
|
1029
|
-
AWS_PROXY: for integrating the route or method request with the Lambda
|
|
1030
|
-
function-invoking action with the client request passed through as-is. This
|
|
1031
|
-
integration is also referred to as Lambda proxy integration.
|
|
1032
|
-
HTTP: for integrating the route or method request with an HTTP
|
|
1033
|
-
endpoint. This
|
|
1034
|
-
integration is also referred to as HTTP custom integration.
|
|
1035
|
-
HTTP_PROXY: for integrating route or method request with an HTTP
|
|
1036
|
-
endpoint, with the client
|
|
1037
|
-
request passed through as-is. This is also referred to as HTTP proxy
|
|
1038
|
-
integration.
|
|
1039
|
-
MOCK: for integrating the route or method request with API Gateway as a
|
|
1040
|
-
"loopback" endpoint without invoking any backend.
|
|
1004
|
+
* The integration type of an integration. One of the following: AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs. AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration. HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs. HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
|
|
1041
1005
|
*/
|
|
1042
1006
|
IntegrationType: IntegrationType;
|
|
1043
1007
|
/**
|
|
@@ -1045,40 +1009,24 @@ declare namespace ApiGatewayV2 {
|
|
|
1045
1009
|
*/
|
|
1046
1010
|
IntegrationUri?: UriWithLengthBetween1And2048;
|
|
1047
1011
|
/**
|
|
1048
|
-
* Specifies the pass-through behavior for incoming requests based on the
|
|
1049
|
-
Content-Type header in the request, and the available mapping
|
|
1050
|
-
templates specified as the requestTemplates property on the
|
|
1051
|
-
Integration resource. There are three valid values:
|
|
1052
|
-
WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
|
|
1053
|
-
NEVER.
|
|
1054
|
-
WHEN_NO_MATCH passes the request body for unmapped content types through
|
|
1055
|
-
to the integration backend without transformation.
|
|
1056
|
-
NEVER rejects unmapped content types with an HTTP 415 Unsupported
|
|
1057
|
-
Media Type response.
|
|
1058
|
-
WHEN_NO_TEMPLATES allows pass-through when the integration has no
|
|
1059
|
-
content types mapped to templates. However, if there is at least one content type
|
|
1060
|
-
defined, unmapped content types will be rejected with the same HTTP 415
|
|
1061
|
-
Unsupported Media Type response.
|
|
1012
|
+
* Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation. NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response. WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
|
|
1062
1013
|
*/
|
|
1063
1014
|
PassthroughBehavior?: PassthroughBehavior;
|
|
1064
1015
|
/**
|
|
1065
|
-
*
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
request parameter value must match the pattern of
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
must be a valid and unique method request parameter name.
|
|
1016
|
+
* Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.
|
|
1017
|
+
*/
|
|
1018
|
+
PayloadFormatVersion?: StringWithLengthBetween1And64;
|
|
1019
|
+
/**
|
|
1020
|
+
* 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.{location}.{name}
|
|
1021
|
+
, where
|
|
1022
|
+
{location}
|
|
1023
|
+
is querystring, path, or header; and
|
|
1024
|
+
{name}
|
|
1025
|
+
must be a valid and unique method request parameter name. Supported only for WebSocket APIs.
|
|
1076
1026
|
*/
|
|
1077
1027
|
RequestParameters?: IntegrationParameters;
|
|
1078
1028
|
/**
|
|
1079
|
-
* Represents a map of Velocity templates that are applied on the request payload
|
|
1080
|
-
based on the value of the Content-Type header sent by the client. The content type
|
|
1081
|
-
value is the key in this map, and the template (as a String) is the value.
|
|
1029
|
+
* Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
|
|
1082
1030
|
*/
|
|
1083
1031
|
RequestTemplates?: TemplateMap;
|
|
1084
1032
|
/**
|
|
@@ -1086,41 +1034,29 @@ declare namespace ApiGatewayV2 {
|
|
|
1086
1034
|
*/
|
|
1087
1035
|
TemplateSelectionExpression?: SelectionExpression;
|
|
1088
1036
|
/**
|
|
1089
|
-
* Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000
|
|
1090
|
-
milliseconds or 29 seconds.
|
|
1037
|
+
* Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
|
|
1091
1038
|
*/
|
|
1092
1039
|
TimeoutInMillis?: IntegerWithLengthBetween50And29000;
|
|
1093
1040
|
}
|
|
1094
|
-
export interface
|
|
1041
|
+
export interface CreateIntegrationResult {
|
|
1042
|
+
/**
|
|
1043
|
+
* 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.
|
|
1044
|
+
*/
|
|
1045
|
+
ApiGatewayManaged?: __boolean;
|
|
1095
1046
|
/**
|
|
1096
1047
|
* The connection ID.
|
|
1097
1048
|
*/
|
|
1098
1049
|
ConnectionId?: StringWithLengthBetween1And1024;
|
|
1099
1050
|
/**
|
|
1100
|
-
* The type of the network connection to the integration endpoint. Currently the only
|
|
1101
|
-
valid value is INTERNET, for connections through the public routable
|
|
1102
|
-
internet.
|
|
1051
|
+
* The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
|
|
1103
1052
|
*/
|
|
1104
1053
|
ConnectionType?: ConnectionType;
|
|
1105
1054
|
/**
|
|
1106
|
-
* Specifies how to handle response payload content type conversions. Supported
|
|
1107
|
-
values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
|
|
1108
|
-
following behaviors:
|
|
1109
|
-
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded
|
|
1110
|
-
string to the corresponding binary blob.
|
|
1111
|
-
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a
|
|
1112
|
-
Base64-encoded string.If this property is not defined, the response payload will be passed through from
|
|
1113
|
-
the integration response to the route response or method response without
|
|
1114
|
-
modification.
|
|
1055
|
+
* 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: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
|
|
1115
1056
|
*/
|
|
1116
1057
|
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
1117
1058
|
/**
|
|
1118
|
-
* Specifies the credentials required for the integration, if any. For AWS
|
|
1119
|
-
integrations, three options are available. To specify an IAM Role for API Gateway to
|
|
1120
|
-
assume, use the role's Amazon Resource Name (ARN). To require that the caller's
|
|
1121
|
-
identity be passed through from the request, specify the string
|
|
1122
|
-
arn:aws:iam::*:user/*. To use resource-based permissions on supported
|
|
1123
|
-
AWS services, specify null.
|
|
1059
|
+
* Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
|
|
1124
1060
|
*/
|
|
1125
1061
|
CredentialsArn?: Arn;
|
|
1126
1062
|
/**
|
|
@@ -1136,27 +1072,11 @@ declare namespace ApiGatewayV2 {
|
|
|
1136
1072
|
*/
|
|
1137
1073
|
IntegrationMethod?: StringWithLengthBetween1And64;
|
|
1138
1074
|
/**
|
|
1139
|
-
* The integration response selection expression for the integration. See Integration Response Selection Expressions.
|
|
1075
|
+
* The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
|
|
1140
1076
|
*/
|
|
1141
1077
|
IntegrationResponseSelectionExpression?: SelectionExpression;
|
|
1142
1078
|
/**
|
|
1143
|
-
* The integration type of an integration. One of the following:
|
|
1144
|
-
AWS: for integrating the route or method request with an AWS service
|
|
1145
|
-
action, including the Lambda function-invoking action. With the Lambda
|
|
1146
|
-
function-invoking action, this is referred to as the Lambda custom integration. With
|
|
1147
|
-
any other AWS service action, this is known as AWS integration.
|
|
1148
|
-
AWS_PROXY: for integrating the route or method request with the Lambda
|
|
1149
|
-
function-invoking action with the client request passed through as-is. This
|
|
1150
|
-
integration is also referred to as Lambda proxy integration.
|
|
1151
|
-
HTTP: for integrating the route or method request with an HTTP
|
|
1152
|
-
endpoint. This
|
|
1153
|
-
integration is also referred to as the HTTP custom integration.
|
|
1154
|
-
HTTP_PROXY: for integrating route or method request with an HTTP
|
|
1155
|
-
endpoint, with the client
|
|
1156
|
-
request passed through as-is. This is also referred to as HTTP proxy
|
|
1157
|
-
integration.
|
|
1158
|
-
MOCK: for integrating the route or method request with API Gateway as a
|
|
1159
|
-
"loopback" endpoint without invoking any backend.
|
|
1079
|
+
* The integration type of an integration. One of the following: AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs. AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration. HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs. HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
|
|
1160
1080
|
*/
|
|
1161
1081
|
IntegrationType?: IntegrationType;
|
|
1162
1082
|
/**
|
|
@@ -1164,49 +1084,32 @@ declare namespace ApiGatewayV2 {
|
|
|
1164
1084
|
*/
|
|
1165
1085
|
IntegrationUri?: UriWithLengthBetween1And2048;
|
|
1166
1086
|
/**
|
|
1167
|
-
* Specifies the pass-through behavior for incoming requests based on the
|
|
1168
|
-
Content-Type header in the request, and the available mapping
|
|
1169
|
-
templates specified as the requestTemplates property on the
|
|
1170
|
-
Integration resource. There are three valid values:
|
|
1171
|
-
WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
|
|
1172
|
-
NEVER.
|
|
1173
|
-
WHEN_NO_MATCH passes the request body for unmapped content types through
|
|
1174
|
-
to the integration backend without transformation.
|
|
1175
|
-
NEVER rejects unmapped content types with an HTTP 415 Unsupported
|
|
1176
|
-
Media Type response.
|
|
1177
|
-
WHEN_NO_TEMPLATES allows pass-through when the integration has no
|
|
1178
|
-
content types mapped to templates. However, if there is at least one content type
|
|
1179
|
-
defined, unmapped content types will be rejected with the same HTTP 415
|
|
1180
|
-
Unsupported Media Type response.
|
|
1087
|
+
* Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation. NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response. WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
|
|
1181
1088
|
*/
|
|
1182
1089
|
PassthroughBehavior?: PassthroughBehavior;
|
|
1183
1090
|
/**
|
|
1184
|
-
*
|
|
1185
|
-
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
request parameter value must match the pattern of
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
must be a valid and unique method request parameter name.
|
|
1091
|
+
* Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.
|
|
1092
|
+
*/
|
|
1093
|
+
PayloadFormatVersion?: StringWithLengthBetween1And64;
|
|
1094
|
+
/**
|
|
1095
|
+
* 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.{location}.{name}
|
|
1096
|
+
, where
|
|
1097
|
+
{location}
|
|
1098
|
+
is querystring, path, or header; and
|
|
1099
|
+
{name}
|
|
1100
|
+
must be a valid and unique method request parameter name. Supported only for WebSocket APIs.
|
|
1195
1101
|
*/
|
|
1196
1102
|
RequestParameters?: IntegrationParameters;
|
|
1197
1103
|
/**
|
|
1198
|
-
* Represents a map of Velocity templates that are applied on the request payload
|
|
1199
|
-
based on the value of the Content-Type header sent by the client. The content type
|
|
1200
|
-
value is the key in this map, and the template (as a String) is the value.
|
|
1104
|
+
* Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
|
|
1201
1105
|
*/
|
|
1202
1106
|
RequestTemplates?: TemplateMap;
|
|
1203
1107
|
/**
|
|
1204
|
-
* The template selection expression for the integration.
|
|
1108
|
+
* The template selection expression for the integration. Supported only for WebSocket APIs.
|
|
1205
1109
|
*/
|
|
1206
1110
|
TemplateSelectionExpression?: SelectionExpression;
|
|
1207
1111
|
/**
|
|
1208
|
-
* Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000
|
|
1209
|
-
milliseconds or 29 seconds.
|
|
1112
|
+
* Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
|
|
1210
1113
|
*/
|
|
1211
1114
|
TimeoutInMillis?: IntegerWithLengthBetween50And29000;
|
|
1212
1115
|
}
|
|
@@ -1216,15 +1119,7 @@ declare namespace ApiGatewayV2 {
|
|
|
1216
1119
|
*/
|
|
1217
1120
|
ApiId: __string;
|
|
1218
1121
|
/**
|
|
1219
|
-
* Specifies how to handle response payload content type conversions. Supported
|
|
1220
|
-
values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
|
|
1221
|
-
following behaviors:
|
|
1222
|
-
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded
|
|
1223
|
-
string to the corresponding binary blob.
|
|
1224
|
-
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a
|
|
1225
|
-
Base64-encoded string.If this property is not defined, the response payload will be passed through from
|
|
1226
|
-
the integration response to the route response or method response without
|
|
1227
|
-
modification.
|
|
1122
|
+
* Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
|
|
1228
1123
|
*/
|
|
1229
1124
|
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
1230
1125
|
/**
|
|
@@ -1236,41 +1131,21 @@ declare namespace ApiGatewayV2 {
|
|
|
1236
1131
|
*/
|
|
1237
1132
|
IntegrationResponseKey: SelectionKey;
|
|
1238
1133
|
/**
|
|
1239
|
-
* A key-value map specifying response parameters that are passed to the method
|
|
1240
|
-
response from the backend. The key is a method response header parameter name and the
|
|
1241
|
-
mapped value is an integration response header value, a static value enclosed within
|
|
1242
|
-
a pair of single quotes, or a JSON expression from the integration response body. The
|
|
1243
|
-
mapping key must match the pattern of method.response.header.{name},
|
|
1244
|
-
where {name} is a valid and unique header name. The mapped non-static
|
|
1245
|
-
value must match the pattern of integration.response.header.{name} or
|
|
1246
|
-
integration.response.body.{JSON-expression}, where
|
|
1247
|
-
{name} is a valid and unique response header name and
|
|
1248
|
-
{JSON-expression} is a valid JSON expression without the $
|
|
1249
|
-
prefix.
|
|
1134
|
+
* 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.
|
|
1250
1135
|
*/
|
|
1251
1136
|
ResponseParameters?: IntegrationParameters;
|
|
1252
1137
|
/**
|
|
1253
|
-
* The collection of response templates for the integration response as a
|
|
1254
|
-
string-to-string map of key-value pairs. Response templates are represented as a
|
|
1255
|
-
key/value map, with a content-type as the key and a template as the value.
|
|
1138
|
+
* The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
|
|
1256
1139
|
*/
|
|
1257
1140
|
ResponseTemplates?: TemplateMap;
|
|
1258
1141
|
/**
|
|
1259
|
-
* The template selection expression for the integration response.
|
|
1142
|
+
* The template selection expression for the integration response. Supported only for WebSocket APIs.
|
|
1260
1143
|
*/
|
|
1261
1144
|
TemplateSelectionExpression?: SelectionExpression;
|
|
1262
1145
|
}
|
|
1263
1146
|
export interface CreateIntegrationResponseResponse {
|
|
1264
1147
|
/**
|
|
1265
|
-
* Specifies how to handle response payload content type conversions. Supported
|
|
1266
|
-
values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
|
|
1267
|
-
following behaviors:
|
|
1268
|
-
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded
|
|
1269
|
-
string to the corresponding binary blob.
|
|
1270
|
-
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a
|
|
1271
|
-
Base64-encoded string.If this property is not defined, the response payload will be passed through from
|
|
1272
|
-
the integration response to the route response or method response without
|
|
1273
|
-
modification.
|
|
1148
|
+
* 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: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
|
|
1274
1149
|
*/
|
|
1275
1150
|
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
1276
1151
|
/**
|
|
@@ -1282,21 +1157,11 @@ declare namespace ApiGatewayV2 {
|
|
|
1282
1157
|
*/
|
|
1283
1158
|
IntegrationResponseKey?: SelectionKey;
|
|
1284
1159
|
/**
|
|
1285
|
-
* A key-value map specifying response parameters that are passed to the method
|
|
1286
|
-
response from the backend. The key is a method response header parameter name and the
|
|
1287
|
-
mapped value is an integration response header value, a static value enclosed within
|
|
1288
|
-
a pair of single quotes, or a JSON expression from the integration response body. The
|
|
1289
|
-
mapping key must match the pattern of method.response.header.{name}, where name is a
|
|
1290
|
-
valid and unique header name. The mapped non-static value must match the pattern of
|
|
1291
|
-
integration.response.header.{name} or integration.response.body.{JSON-expression},
|
|
1292
|
-
where name is a valid and unique response header name and JSON-expression is a valid
|
|
1293
|
-
JSON expression without the $ prefix.
|
|
1160
|
+
* 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.
|
|
1294
1161
|
*/
|
|
1295
1162
|
ResponseParameters?: IntegrationParameters;
|
|
1296
1163
|
/**
|
|
1297
|
-
* The collection of response templates for the integration response as a
|
|
1298
|
-
string-to-string map of key-value pairs. Response templates are represented as a
|
|
1299
|
-
key/value map, with a content-type as the key and a template as the value.
|
|
1164
|
+
* The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
|
|
1300
1165
|
*/
|
|
1301
1166
|
ResponseTemplates?: TemplateMap;
|
|
1302
1167
|
/**
|
|
@@ -1322,8 +1187,7 @@ declare namespace ApiGatewayV2 {
|
|
|
1322
1187
|
*/
|
|
1323
1188
|
Name: StringWithLengthBetween1And128;
|
|
1324
1189
|
/**
|
|
1325
|
-
* The schema for the model. For application/json models, this should be JSON schema
|
|
1326
|
-
draft 4 model.
|
|
1190
|
+
* The schema for the model. For application/json models, this should be JSON schema draft 4 model.
|
|
1327
1191
|
*/
|
|
1328
1192
|
Schema: StringWithLengthBetween0And32K;
|
|
1329
1193
|
}
|
|
@@ -1345,8 +1209,7 @@ declare namespace ApiGatewayV2 {
|
|
|
1345
1209
|
*/
|
|
1346
1210
|
Name?: StringWithLengthBetween1And128;
|
|
1347
1211
|
/**
|
|
1348
|
-
* The schema for the model. For application/json models, this should be JSON schema
|
|
1349
|
-
draft 4 model.
|
|
1212
|
+
* The schema for the model. For application/json models, this should be JSON schema draft 4 model.
|
|
1350
1213
|
*/
|
|
1351
1214
|
Schema?: StringWithLengthBetween0And32K;
|
|
1352
1215
|
}
|
|
@@ -1356,30 +1219,23 @@ declare namespace ApiGatewayV2 {
|
|
|
1356
1219
|
*/
|
|
1357
1220
|
ApiId: __string;
|
|
1358
1221
|
/**
|
|
1359
|
-
* Specifies whether an API key is required for the route.
|
|
1222
|
+
* Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
|
|
1360
1223
|
*/
|
|
1361
1224
|
ApiKeyRequired?: __boolean;
|
|
1362
1225
|
/**
|
|
1363
|
-
* The authorization scopes supported by this
|
|
1364
|
-
route.
|
|
1226
|
+
* The authorization scopes supported by this route.
|
|
1365
1227
|
*/
|
|
1366
1228
|
AuthorizationScopes?: AuthorizationScopes;
|
|
1367
1229
|
/**
|
|
1368
|
-
* The authorization type for the route.
|
|
1369
|
-
access, AWS_IAM for using AWS IAM permissions, and CUSTOM
|
|
1370
|
-
for using a Lambda
|
|
1371
|
-
authorizer.
|
|
1230
|
+
* The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.
|
|
1372
1231
|
*/
|
|
1373
1232
|
AuthorizationType?: AuthorizationType;
|
|
1374
1233
|
/**
|
|
1375
|
-
* The identifier of the Authorizer resource to be associated with this
|
|
1376
|
-
route, if the authorizationType is CUSTOM
|
|
1377
|
-
. The authorizer identifier is generated by API Gateway
|
|
1378
|
-
when you created the authorizer.
|
|
1234
|
+
* The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
|
|
1379
1235
|
*/
|
|
1380
1236
|
AuthorizerId?: Id;
|
|
1381
1237
|
/**
|
|
1382
|
-
* The model selection expression for the route.
|
|
1238
|
+
* The model selection expression for the route. Supported only for WebSocket APIs.
|
|
1383
1239
|
*/
|
|
1384
1240
|
ModelSelectionExpression?: SelectionExpression;
|
|
1385
1241
|
/**
|
|
@@ -1387,11 +1243,11 @@ declare namespace ApiGatewayV2 {
|
|
|
1387
1243
|
*/
|
|
1388
1244
|
OperationName?: StringWithLengthBetween1And64;
|
|
1389
1245
|
/**
|
|
1390
|
-
* The request models for the route.
|
|
1246
|
+
* The request models for the route. Supported only for WebSocket APIs.
|
|
1391
1247
|
*/
|
|
1392
1248
|
RequestModels?: RouteModels;
|
|
1393
1249
|
/**
|
|
1394
|
-
* The request parameters for the route.
|
|
1250
|
+
* The request parameters for the route. Supported only for WebSocket APIs.
|
|
1395
1251
|
*/
|
|
1396
1252
|
RequestParameters?: RouteParameters;
|
|
1397
1253
|
/**
|
|
@@ -1399,7 +1255,7 @@ declare namespace ApiGatewayV2 {
|
|
|
1399
1255
|
*/
|
|
1400
1256
|
RouteKey: SelectionKey;
|
|
1401
1257
|
/**
|
|
1402
|
-
* The route response selection expression for the route.
|
|
1258
|
+
* The route response selection expression for the route. Supported only for WebSocket APIs.
|
|
1403
1259
|
*/
|
|
1404
1260
|
RouteResponseSelectionExpression?: SelectionExpression;
|
|
1405
1261
|
/**
|
|
@@ -1407,37 +1263,29 @@ declare namespace ApiGatewayV2 {
|
|
|
1407
1263
|
*/
|
|
1408
1264
|
Target?: StringWithLengthBetween1And128;
|
|
1409
1265
|
}
|
|
1410
|
-
export interface
|
|
1266
|
+
export interface CreateRouteResult {
|
|
1267
|
+
/**
|
|
1268
|
+
* 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.
|
|
1269
|
+
*/
|
|
1270
|
+
ApiGatewayManaged?: __boolean;
|
|
1411
1271
|
/**
|
|
1412
|
-
* Specifies whether an API key is required for this route.
|
|
1272
|
+
* Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
|
|
1413
1273
|
*/
|
|
1414
1274
|
ApiKeyRequired?: __boolean;
|
|
1415
1275
|
/**
|
|
1416
|
-
* A list of authorization scopes configured on a route. The scopes are used with a
|
|
1417
|
-
COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization
|
|
1418
|
-
works by matching the route scopes against the scopes parsed from the access token in
|
|
1419
|
-
the incoming request. The method invocation is authorized if any route scope matches
|
|
1420
|
-
a claimed scope in the access token. Otherwise, the invocation is not authorized.
|
|
1421
|
-
When the route scope is configured, the client must provide an access token instead
|
|
1422
|
-
of an identity token for authorization purposes.
|
|
1276
|
+
* A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
|
|
1423
1277
|
*/
|
|
1424
1278
|
AuthorizationScopes?: AuthorizationScopes;
|
|
1425
1279
|
/**
|
|
1426
|
-
* The authorization type for the route.
|
|
1427
|
-
access, AWS_IAM for using AWS IAM permissions, and CUSTOM
|
|
1428
|
-
for using a Lambda
|
|
1429
|
-
authorizer
|
|
1280
|
+
* The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.
|
|
1430
1281
|
*/
|
|
1431
1282
|
AuthorizationType?: AuthorizationType;
|
|
1432
1283
|
/**
|
|
1433
|
-
* The identifier of the Authorizer resource to be associated with this
|
|
1434
|
-
route, if the authorizationType is CUSTOM
|
|
1435
|
-
. The authorizer identifier is generated by API Gateway
|
|
1436
|
-
when you created the authorizer.
|
|
1284
|
+
* The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
|
|
1437
1285
|
*/
|
|
1438
1286
|
AuthorizerId?: Id;
|
|
1439
1287
|
/**
|
|
1440
|
-
* The model selection expression for the route.
|
|
1288
|
+
* The model selection expression for the route. Supported only for WebSocket APIs.
|
|
1441
1289
|
*/
|
|
1442
1290
|
ModelSelectionExpression?: SelectionExpression;
|
|
1443
1291
|
/**
|
|
@@ -1445,11 +1293,11 @@ declare namespace ApiGatewayV2 {
|
|
|
1445
1293
|
*/
|
|
1446
1294
|
OperationName?: StringWithLengthBetween1And64;
|
|
1447
1295
|
/**
|
|
1448
|
-
* The request models for the route.
|
|
1296
|
+
* The request models for the route. Supported only for WebSocket APIs.
|
|
1449
1297
|
*/
|
|
1450
1298
|
RequestModels?: RouteModels;
|
|
1451
1299
|
/**
|
|
1452
|
-
* The request parameters for the route.
|
|
1300
|
+
* The request parameters for the route. Supported only for WebSocket APIs.
|
|
1453
1301
|
*/
|
|
1454
1302
|
RequestParameters?: RouteParameters;
|
|
1455
1303
|
/**
|
|
@@ -1461,7 +1309,7 @@ declare namespace ApiGatewayV2 {
|
|
|
1461
1309
|
*/
|
|
1462
1310
|
RouteKey?: SelectionKey;
|
|
1463
1311
|
/**
|
|
1464
|
-
* The route response selection expression for the route.
|
|
1312
|
+
* The route response selection expression for the route. Supported only for WebSocket APIs.
|
|
1465
1313
|
*/
|
|
1466
1314
|
RouteResponseSelectionExpression?: SelectionExpression;
|
|
1467
1315
|
/**
|
|
@@ -1475,7 +1323,7 @@ declare namespace ApiGatewayV2 {
|
|
|
1475
1323
|
*/
|
|
1476
1324
|
ApiId: __string;
|
|
1477
1325
|
/**
|
|
1478
|
-
* The model selection expression for the route response.
|
|
1326
|
+
* The model selection expression for the route response. Supported only for WebSocket APIs.
|
|
1479
1327
|
*/
|
|
1480
1328
|
ModelSelectionExpression?: SelectionExpression;
|
|
1481
1329
|
/**
|
|
@@ -1497,7 +1345,7 @@ declare namespace ApiGatewayV2 {
|
|
|
1497
1345
|
}
|
|
1498
1346
|
export interface CreateRouteResponseResponse {
|
|
1499
1347
|
/**
|
|
1500
|
-
* Represents the model selection expression of a route response.
|
|
1348
|
+
* Represents the model selection expression of a route response. Supported only for WebSocket APIs.
|
|
1501
1349
|
*/
|
|
1502
1350
|
ModelSelectionExpression?: SelectionExpression;
|
|
1503
1351
|
/**
|
|
@@ -1527,7 +1375,11 @@ declare namespace ApiGatewayV2 {
|
|
|
1527
1375
|
*/
|
|
1528
1376
|
ApiId: __string;
|
|
1529
1377
|
/**
|
|
1530
|
-
*
|
|
1378
|
+
* Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
|
|
1379
|
+
*/
|
|
1380
|
+
AutoDeploy?: __boolean;
|
|
1381
|
+
/**
|
|
1382
|
+
* The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
|
|
1531
1383
|
*/
|
|
1532
1384
|
ClientCertificateId?: Id;
|
|
1533
1385
|
/**
|
|
@@ -1543,7 +1395,7 @@ declare namespace ApiGatewayV2 {
|
|
|
1543
1395
|
*/
|
|
1544
1396
|
Description?: StringWithLengthBetween0And1024;
|
|
1545
1397
|
/**
|
|
1546
|
-
* Route settings for the stage.
|
|
1398
|
+
* Route settings for the stage, by routeKey.
|
|
1547
1399
|
*/
|
|
1548
1400
|
RouteSettings?: RouteSettingsMap;
|
|
1549
1401
|
/**
|
|
@@ -1551,13 +1403,11 @@ declare namespace ApiGatewayV2 {
|
|
|
1551
1403
|
*/
|
|
1552
1404
|
StageName: StringWithLengthBetween1And128;
|
|
1553
1405
|
/**
|
|
1554
|
-
* A map that defines the stage variables for a Stage. Variable names
|
|
1555
|
-
can have alphanumeric and underscore characters, and the values must match
|
|
1556
|
-
[A-Za-z0-9-._~:/?#&=,]+.
|
|
1406
|
+
* A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. Supported only for WebSocket APIs.
|
|
1557
1407
|
*/
|
|
1558
1408
|
StageVariables?: StageVariablesMap;
|
|
1559
1409
|
/**
|
|
1560
|
-
* The
|
|
1410
|
+
* The collection of tags. Each tag element is associated with a given resource.
|
|
1561
1411
|
*/
|
|
1562
1412
|
Tags?: Tags;
|
|
1563
1413
|
}
|
|
@@ -1567,7 +1417,15 @@ declare namespace ApiGatewayV2 {
|
|
|
1567
1417
|
*/
|
|
1568
1418
|
AccessLogSettings?: AccessLogSettings;
|
|
1569
1419
|
/**
|
|
1570
|
-
*
|
|
1420
|
+
* Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
|
|
1421
|
+
*/
|
|
1422
|
+
ApiGatewayManaged?: __boolean;
|
|
1423
|
+
/**
|
|
1424
|
+
* Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
|
|
1425
|
+
*/
|
|
1426
|
+
AutoDeploy?: __boolean;
|
|
1427
|
+
/**
|
|
1428
|
+
* The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
|
|
1571
1429
|
*/
|
|
1572
1430
|
ClientCertificateId?: Id;
|
|
1573
1431
|
/**
|
|
@@ -1579,20 +1437,23 @@ declare namespace ApiGatewayV2 {
|
|
|
1579
1437
|
*/
|
|
1580
1438
|
DefaultRouteSettings?: RouteSettings;
|
|
1581
1439
|
/**
|
|
1582
|
-
* The identifier of the Deployment that the Stage is
|
|
1583
|
-
associated with.
|
|
1440
|
+
* The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
|
|
1584
1441
|
*/
|
|
1585
1442
|
DeploymentId?: Id;
|
|
1586
1443
|
/**
|
|
1587
1444
|
* The description of the stage.
|
|
1588
1445
|
*/
|
|
1589
1446
|
Description?: StringWithLengthBetween0And1024;
|
|
1447
|
+
/**
|
|
1448
|
+
* Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
|
|
1449
|
+
*/
|
|
1450
|
+
LastDeploymentStatusMessage?: __string;
|
|
1590
1451
|
/**
|
|
1591
1452
|
* The timestamp when the stage was last updated.
|
|
1592
1453
|
*/
|
|
1593
1454
|
LastUpdatedDate?: __timestampIso8601;
|
|
1594
1455
|
/**
|
|
1595
|
-
* Route settings for the stage.
|
|
1456
|
+
* Route settings for the stage, by routeKey.
|
|
1596
1457
|
*/
|
|
1597
1458
|
RouteSettings?: RouteSettingsMap;
|
|
1598
1459
|
/**
|
|
@@ -1600,13 +1461,11 @@ declare namespace ApiGatewayV2 {
|
|
|
1600
1461
|
*/
|
|
1601
1462
|
StageName?: StringWithLengthBetween1And128;
|
|
1602
1463
|
/**
|
|
1603
|
-
* A map that defines the stage variables for a stage resource. Variable names can
|
|
1604
|
-
have alphanumeric and underscore characters, and the values must match
|
|
1605
|
-
[A-Za-z0-9-._~:/?#&=,]+.
|
|
1464
|
+
* A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. Supported only for WebSocket APIs.
|
|
1606
1465
|
*/
|
|
1607
1466
|
StageVariables?: StageVariablesMap;
|
|
1608
1467
|
/**
|
|
1609
|
-
* The
|
|
1468
|
+
* The collection of tags. Each tag element is associated with a given resource.
|
|
1610
1469
|
*/
|
|
1611
1470
|
Tags?: Tags;
|
|
1612
1471
|
}
|
|
@@ -1636,6 +1495,12 @@ declare namespace ApiGatewayV2 {
|
|
|
1636
1495
|
*/
|
|
1637
1496
|
AuthorizerId: __string;
|
|
1638
1497
|
}
|
|
1498
|
+
export interface DeleteCorsConfigurationRequest {
|
|
1499
|
+
/**
|
|
1500
|
+
* The API identifier.
|
|
1501
|
+
*/
|
|
1502
|
+
ApiId: __string;
|
|
1503
|
+
}
|
|
1639
1504
|
export interface DeleteDeploymentRequest {
|
|
1640
1505
|
/**
|
|
1641
1506
|
* The API identifier.
|
|
@@ -1710,17 +1575,35 @@ declare namespace ApiGatewayV2 {
|
|
|
1710
1575
|
*/
|
|
1711
1576
|
RouteResponseId: __string;
|
|
1712
1577
|
}
|
|
1578
|
+
export interface DeleteRouteSettingsRequest {
|
|
1579
|
+
/**
|
|
1580
|
+
* The API identifier.
|
|
1581
|
+
*/
|
|
1582
|
+
ApiId: __string;
|
|
1583
|
+
/**
|
|
1584
|
+
* The route key.
|
|
1585
|
+
*/
|
|
1586
|
+
RouteKey: __string;
|
|
1587
|
+
/**
|
|
1588
|
+
* The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
|
|
1589
|
+
*/
|
|
1590
|
+
StageName: __string;
|
|
1591
|
+
}
|
|
1713
1592
|
export interface DeleteStageRequest {
|
|
1714
1593
|
/**
|
|
1715
1594
|
* The API identifier.
|
|
1716
1595
|
*/
|
|
1717
1596
|
ApiId: __string;
|
|
1718
1597
|
/**
|
|
1719
|
-
* The stage name.
|
|
1598
|
+
* The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
|
|
1720
1599
|
*/
|
|
1721
1600
|
StageName: __string;
|
|
1722
1601
|
}
|
|
1723
1602
|
export interface Deployment {
|
|
1603
|
+
/**
|
|
1604
|
+
* Specifies whether a deployment was automatically released.
|
|
1605
|
+
*/
|
|
1606
|
+
AutoDeployed?: __boolean;
|
|
1724
1607
|
/**
|
|
1725
1608
|
* The date and time when the Deployment resource was created.
|
|
1726
1609
|
*/
|
|
@@ -1730,8 +1613,7 @@ declare namespace ApiGatewayV2 {
|
|
|
1730
1613
|
*/
|
|
1731
1614
|
DeploymentId?: Id;
|
|
1732
1615
|
/**
|
|
1733
|
-
* The status of the deployment: PENDING, FAILED, or
|
|
1734
|
-
SUCCEEDED.
|
|
1616
|
+
* The status of the deployment: PENDING, FAILED, or SUCCEEDED.
|
|
1735
1617
|
*/
|
|
1736
1618
|
DeploymentStatus?: DeploymentStatus;
|
|
1737
1619
|
/**
|
|
@@ -1758,30 +1640,35 @@ declare namespace ApiGatewayV2 {
|
|
|
1758
1640
|
*/
|
|
1759
1641
|
DomainNameConfigurations?: DomainNameConfigurations;
|
|
1760
1642
|
/**
|
|
1761
|
-
* The
|
|
1643
|
+
* The collection of tags associated with a domain name.
|
|
1762
1644
|
*/
|
|
1763
1645
|
Tags?: Tags;
|
|
1764
1646
|
}
|
|
1765
1647
|
export interface DomainNameConfiguration {
|
|
1766
1648
|
/**
|
|
1767
|
-
* A domain name for the
|
|
1649
|
+
* A domain name for the API.
|
|
1768
1650
|
*/
|
|
1769
1651
|
ApiGatewayDomainName?: __string;
|
|
1770
1652
|
/**
|
|
1771
|
-
* An AWS-managed certificate that will be used by the edge-optimized endpoint for
|
|
1772
|
-
this domain name. AWS Certificate Manager is the only supported source.
|
|
1653
|
+
* An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
|
|
1773
1654
|
*/
|
|
1774
1655
|
CertificateArn?: Arn;
|
|
1775
1656
|
/**
|
|
1776
|
-
* The user-friendly name of the certificate that will be used by the edge-optimized
|
|
1777
|
-
endpoint for this domain name.
|
|
1657
|
+
* The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
|
|
1778
1658
|
*/
|
|
1779
1659
|
CertificateName?: StringWithLengthBetween1And128;
|
|
1780
1660
|
/**
|
|
1781
|
-
* The timestamp when the certificate that was used by edge-optimized endpoint for
|
|
1782
|
-
this domain name was uploaded.
|
|
1661
|
+
* The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
|
|
1783
1662
|
*/
|
|
1784
1663
|
CertificateUploadDate?: __timestampIso8601;
|
|
1664
|
+
/**
|
|
1665
|
+
* The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
|
|
1666
|
+
*/
|
|
1667
|
+
DomainNameStatus?: DomainNameStatus;
|
|
1668
|
+
/**
|
|
1669
|
+
* An optional text message containing detailed information about status of the domain name migration.
|
|
1670
|
+
*/
|
|
1671
|
+
DomainNameStatusMessage?: __string;
|
|
1785
1672
|
/**
|
|
1786
1673
|
* The endpoint type.
|
|
1787
1674
|
*/
|
|
@@ -1794,19 +1681,10 @@ declare namespace ApiGatewayV2 {
|
|
|
1794
1681
|
* The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.
|
|
1795
1682
|
*/
|
|
1796
1683
|
SecurityPolicy?: SecurityPolicy;
|
|
1797
|
-
/**
|
|
1798
|
-
* The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
|
|
1799
|
-
*/
|
|
1800
|
-
DomainNameStatus?: DomainNameStatus;
|
|
1801
|
-
/**
|
|
1802
|
-
* An optional text message containing detailed information about status of the domain name migration.
|
|
1803
|
-
*/
|
|
1804
|
-
DomainNameStatusMessage?: __string;
|
|
1805
1684
|
}
|
|
1806
1685
|
export type DomainNameConfigurations = DomainNameConfiguration[];
|
|
1807
|
-
export type EndpointType = "REGIONAL"|"EDGE"|string;
|
|
1808
|
-
export type SecurityPolicy = "TLS_1_0"|"TLS_1_2"|string;
|
|
1809
1686
|
export type DomainNameStatus = "AVAILABLE"|"UPDATING"|string;
|
|
1687
|
+
export type EndpointType = "REGIONAL"|"EDGE"|string;
|
|
1810
1688
|
export interface GetApiMappingRequest {
|
|
1811
1689
|
/**
|
|
1812
1690
|
* The API mapping identifier.
|
|
@@ -1845,8 +1723,7 @@ declare namespace ApiGatewayV2 {
|
|
|
1845
1723
|
*/
|
|
1846
1724
|
MaxResults?: __string;
|
|
1847
1725
|
/**
|
|
1848
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
1849
|
-
the collection.
|
|
1726
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
1850
1727
|
*/
|
|
1851
1728
|
NextToken?: __string;
|
|
1852
1729
|
}
|
|
@@ -1856,8 +1733,7 @@ declare namespace ApiGatewayV2 {
|
|
|
1856
1733
|
*/
|
|
1857
1734
|
Items?: __listOfApiMapping;
|
|
1858
1735
|
/**
|
|
1859
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
1860
|
-
the collection.
|
|
1736
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
1861
1737
|
*/
|
|
1862
1738
|
NextToken?: NextToken;
|
|
1863
1739
|
}
|
|
@@ -1869,9 +1745,7 @@ declare namespace ApiGatewayV2 {
|
|
|
1869
1745
|
}
|
|
1870
1746
|
export interface GetApiResponse {
|
|
1871
1747
|
/**
|
|
1872
|
-
* The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The
|
|
1873
|
-
stage name is typically appended to this URI to form a complete path to a deployed
|
|
1874
|
-
API stage.
|
|
1748
|
+
* 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.
|
|
1875
1749
|
*/
|
|
1876
1750
|
ApiEndpoint?: __string;
|
|
1877
1751
|
/**
|
|
@@ -1879,9 +1753,13 @@ declare namespace ApiGatewayV2 {
|
|
|
1879
1753
|
*/
|
|
1880
1754
|
ApiId?: Id;
|
|
1881
1755
|
/**
|
|
1882
|
-
* An API key selection expression. See API Key Selection Expressions.
|
|
1756
|
+
* An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
|
|
1883
1757
|
*/
|
|
1884
1758
|
ApiKeySelectionExpression?: SelectionExpression;
|
|
1759
|
+
/**
|
|
1760
|
+
* A CORS configuration. Supported only for HTTP APIs.
|
|
1761
|
+
*/
|
|
1762
|
+
CorsConfiguration?: Cors;
|
|
1885
1763
|
/**
|
|
1886
1764
|
* The timestamp when the API was created.
|
|
1887
1765
|
*/
|
|
@@ -1891,34 +1769,37 @@ declare namespace ApiGatewayV2 {
|
|
|
1891
1769
|
*/
|
|
1892
1770
|
Description?: StringWithLengthBetween0And1024;
|
|
1893
1771
|
/**
|
|
1894
|
-
* Avoid validating models when creating a deployment.
|
|
1772
|
+
* Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
|
|
1895
1773
|
*/
|
|
1896
1774
|
DisableSchemaValidation?: __boolean;
|
|
1775
|
+
/**
|
|
1776
|
+
* The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
|
|
1777
|
+
*/
|
|
1778
|
+
ImportInfo?: __listOf__string;
|
|
1897
1779
|
/**
|
|
1898
1780
|
* The name of the API.
|
|
1899
1781
|
*/
|
|
1900
1782
|
Name?: StringWithLengthBetween1And128;
|
|
1901
1783
|
/**
|
|
1902
|
-
* The API protocol
|
|
1784
|
+
* The API protocol.
|
|
1903
1785
|
*/
|
|
1904
1786
|
ProtocolType?: ProtocolType;
|
|
1905
1787
|
/**
|
|
1906
|
-
* The route selection expression for the API.
|
|
1788
|
+
* 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.
|
|
1907
1789
|
*/
|
|
1908
1790
|
RouteSelectionExpression?: SelectionExpression;
|
|
1791
|
+
/**
|
|
1792
|
+
* A collection of tags associated with the API.
|
|
1793
|
+
*/
|
|
1794
|
+
Tags?: Tags;
|
|
1909
1795
|
/**
|
|
1910
1796
|
* A version identifier for the API.
|
|
1911
1797
|
*/
|
|
1912
1798
|
Version?: StringWithLengthBetween1And64;
|
|
1913
1799
|
/**
|
|
1914
|
-
* The warning messages reported when failonwarnings is turned on during
|
|
1915
|
-
API import.
|
|
1800
|
+
* The warning messages reported when failonwarnings is turned on during API import.
|
|
1916
1801
|
*/
|
|
1917
1802
|
Warnings?: __listOf__string;
|
|
1918
|
-
/**
|
|
1919
|
-
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
|
|
1920
|
-
*/
|
|
1921
|
-
Tags?: Tags;
|
|
1922
1803
|
}
|
|
1923
1804
|
export interface GetApisRequest {
|
|
1924
1805
|
/**
|
|
@@ -1926,8 +1807,7 @@ declare namespace ApiGatewayV2 {
|
|
|
1926
1807
|
*/
|
|
1927
1808
|
MaxResults?: __string;
|
|
1928
1809
|
/**
|
|
1929
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
1930
|
-
the collection.
|
|
1810
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
1931
1811
|
*/
|
|
1932
1812
|
NextToken?: __string;
|
|
1933
1813
|
}
|
|
@@ -1937,8 +1817,7 @@ declare namespace ApiGatewayV2 {
|
|
|
1937
1817
|
*/
|
|
1938
1818
|
Items?: __listOfApi;
|
|
1939
1819
|
/**
|
|
1940
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
1941
|
-
the collection.
|
|
1820
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
1942
1821
|
*/
|
|
1943
1822
|
NextToken?: NextToken;
|
|
1944
1823
|
}
|
|
@@ -1954,10 +1833,7 @@ declare namespace ApiGatewayV2 {
|
|
|
1954
1833
|
}
|
|
1955
1834
|
export interface GetAuthorizerResponse {
|
|
1956
1835
|
/**
|
|
1957
|
-
* Specifies the required credentials as an IAM role for API Gateway to invoke the
|
|
1958
|
-
authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon
|
|
1959
|
-
Resource Name (ARN). To use resource-based permissions on the Lambda function,
|
|
1960
|
-
specify null.
|
|
1836
|
+
* Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.
|
|
1961
1837
|
*/
|
|
1962
1838
|
AuthorizerCredentialsArn?: Arn;
|
|
1963
1839
|
/**
|
|
@@ -1965,63 +1841,34 @@ declare namespace ApiGatewayV2 {
|
|
|
1965
1841
|
*/
|
|
1966
1842
|
AuthorizerId?: Id;
|
|
1967
1843
|
/**
|
|
1968
|
-
*
|
|
1969
|
-
authorization caching is disabled. If it is greater than 0, API Gateway will cache
|
|
1970
|
-
authorizer responses. If this field is not set, the default value is 300. The maximum
|
|
1971
|
-
value is 3600, or 1 hour.
|
|
1844
|
+
* Authorizer caching is not currently supported. Don't specify this value for authorizers.
|
|
1972
1845
|
*/
|
|
1973
1846
|
AuthorizerResultTtlInSeconds?: IntegerWithLengthBetween0And3600;
|
|
1974
1847
|
/**
|
|
1975
|
-
* The authorizer type.
|
|
1976
|
-
Lambda function using incoming request parameters.
|
|
1848
|
+
* The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
|
|
1977
1849
|
*/
|
|
1978
1850
|
AuthorizerType?: AuthorizerType;
|
|
1979
1851
|
/**
|
|
1980
|
-
* The authorizer's Uniform Resource Identifier (URI).
|
|
1981
|
-
|
|
1982
|
-
well-formed Lambda function URI, for example,
|
|
1983
|
-
arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations.
|
|
1984
|
-
In general, the URI has this form:
|
|
1985
|
-
arn:aws:apigateway:{region}:lambda:path/{service_api}
|
|
1986
|
-
, where {region} is the same as the region hosting the Lambda
|
|
1987
|
-
function, path indicates that the remaining substring in the URI should be treated as
|
|
1988
|
-
the path to the resource, including the initial /. For Lambda functions,
|
|
1989
|
-
this is usually of the form
|
|
1990
|
-
/2015-03-31/functions/[FunctionARN]/invocations.
|
|
1852
|
+
* The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}
|
|
1853
|
+
, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.
|
|
1991
1854
|
*/
|
|
1992
1855
|
AuthorizerUri?: UriWithLengthBetween1And2048;
|
|
1993
1856
|
/**
|
|
1994
|
-
* The identity source for which authorization is requested.For
|
|
1995
|
-
caching is enabled. The value is a comma-separated string of one or more mapping
|
|
1996
|
-
expressions of the specified request parameters. For example, if an Auth
|
|
1997
|
-
header and a Name query string parameters are defined as identity
|
|
1998
|
-
sources, this value is method.request.header.Auth,
|
|
1999
|
-
method.request.querystring.Name. These parameters will be used to
|
|
2000
|
-
derive the authorization caching key and to perform runtime validation of the
|
|
2001
|
-
REQUEST authorizer by verifying all of the identity-related request
|
|
2002
|
-
parameters are present, not null, and non-empty. Only when this is true does the
|
|
2003
|
-
authorizer invoke the authorizer Lambda function, otherwise, it returns a 401
|
|
2004
|
-
Unauthorized response without calling the Lambda function. The valid value
|
|
2005
|
-
is a string of comma-separated mapping expressions of the specified request
|
|
2006
|
-
parameters. When the authorization caching is not enabled, this property is
|
|
2007
|
-
optional.
|
|
1857
|
+
* The identity source for which authorization is requested. For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example "$request.header.Authorization".
|
|
2008
1858
|
*/
|
|
2009
1859
|
IdentitySource?: IdentitySourceList;
|
|
2010
1860
|
/**
|
|
2011
|
-
* The
|
|
2012
|
-
validation expression does not apply to the REQUEST authorizer.
|
|
1861
|
+
* The validation expression does not apply to the REQUEST authorizer.
|
|
2013
1862
|
*/
|
|
2014
1863
|
IdentityValidationExpression?: StringWithLengthBetween0And1024;
|
|
2015
1864
|
/**
|
|
2016
|
-
*
|
|
1865
|
+
* Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
|
|
2017
1866
|
*/
|
|
2018
|
-
|
|
1867
|
+
JwtConfiguration?: JWTConfiguration;
|
|
2019
1868
|
/**
|
|
2020
|
-
*
|
|
2021
|
-
REQUEST authorizer, this is not
|
|
2022
|
-
defined.
|
|
1869
|
+
* The name of the authorizer.
|
|
2023
1870
|
*/
|
|
2024
|
-
|
|
1871
|
+
Name?: StringWithLengthBetween1And128;
|
|
2025
1872
|
}
|
|
2026
1873
|
export interface GetAuthorizersRequest {
|
|
2027
1874
|
/**
|
|
@@ -2033,8 +1880,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2033
1880
|
*/
|
|
2034
1881
|
MaxResults?: __string;
|
|
2035
1882
|
/**
|
|
2036
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
2037
|
-
the collection.
|
|
1883
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
2038
1884
|
*/
|
|
2039
1885
|
NextToken?: __string;
|
|
2040
1886
|
}
|
|
@@ -2044,8 +1890,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2044
1890
|
*/
|
|
2045
1891
|
Items?: __listOfAuthorizer;
|
|
2046
1892
|
/**
|
|
2047
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
2048
|
-
the collection.
|
|
1893
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
2049
1894
|
*/
|
|
2050
1895
|
NextToken?: NextToken;
|
|
2051
1896
|
}
|
|
@@ -2060,6 +1905,10 @@ declare namespace ApiGatewayV2 {
|
|
|
2060
1905
|
DeploymentId: __string;
|
|
2061
1906
|
}
|
|
2062
1907
|
export interface GetDeploymentResponse {
|
|
1908
|
+
/**
|
|
1909
|
+
* Specifies whether a deployment was automatically released.
|
|
1910
|
+
*/
|
|
1911
|
+
AutoDeployed?: __boolean;
|
|
2063
1912
|
/**
|
|
2064
1913
|
* The date and time when the Deployment resource was created.
|
|
2065
1914
|
*/
|
|
@@ -2069,8 +1918,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2069
1918
|
*/
|
|
2070
1919
|
DeploymentId?: Id;
|
|
2071
1920
|
/**
|
|
2072
|
-
* The status of the deployment: PENDING, FAILED, or
|
|
2073
|
-
SUCCEEDED.
|
|
1921
|
+
* The status of the deployment: PENDING, FAILED, or SUCCEEDED.
|
|
2074
1922
|
*/
|
|
2075
1923
|
DeploymentStatus?: DeploymentStatus;
|
|
2076
1924
|
/**
|
|
@@ -2092,8 +1940,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2092
1940
|
*/
|
|
2093
1941
|
MaxResults?: __string;
|
|
2094
1942
|
/**
|
|
2095
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
2096
|
-
the collection.
|
|
1943
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
2097
1944
|
*/
|
|
2098
1945
|
NextToken?: __string;
|
|
2099
1946
|
}
|
|
@@ -2103,8 +1950,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2103
1950
|
*/
|
|
2104
1951
|
Items?: __listOfDeployment;
|
|
2105
1952
|
/**
|
|
2106
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
2107
|
-
the collection.
|
|
1953
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
2108
1954
|
*/
|
|
2109
1955
|
NextToken?: NextToken;
|
|
2110
1956
|
}
|
|
@@ -2128,7 +1974,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2128
1974
|
*/
|
|
2129
1975
|
DomainNameConfigurations?: DomainNameConfigurations;
|
|
2130
1976
|
/**
|
|
2131
|
-
* The
|
|
1977
|
+
* The collection of tags associated with a domain name.
|
|
2132
1978
|
*/
|
|
2133
1979
|
Tags?: Tags;
|
|
2134
1980
|
}
|
|
@@ -2138,8 +1984,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2138
1984
|
*/
|
|
2139
1985
|
MaxResults?: __string;
|
|
2140
1986
|
/**
|
|
2141
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
2142
|
-
the collection.
|
|
1987
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
2143
1988
|
*/
|
|
2144
1989
|
NextToken?: __string;
|
|
2145
1990
|
}
|
|
@@ -2149,8 +1994,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2149
1994
|
*/
|
|
2150
1995
|
Items?: __listOfDomainName;
|
|
2151
1996
|
/**
|
|
2152
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
2153
|
-
the collection.
|
|
1997
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
2154
1998
|
*/
|
|
2155
1999
|
NextToken?: NextToken;
|
|
2156
2000
|
}
|
|
@@ -2164,36 +2008,25 @@ declare namespace ApiGatewayV2 {
|
|
|
2164
2008
|
*/
|
|
2165
2009
|
IntegrationId: __string;
|
|
2166
2010
|
}
|
|
2167
|
-
export interface
|
|
2011
|
+
export interface GetIntegrationResult {
|
|
2012
|
+
/**
|
|
2013
|
+
* 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.
|
|
2014
|
+
*/
|
|
2015
|
+
ApiGatewayManaged?: __boolean;
|
|
2168
2016
|
/**
|
|
2169
2017
|
* The connection ID.
|
|
2170
2018
|
*/
|
|
2171
2019
|
ConnectionId?: StringWithLengthBetween1And1024;
|
|
2172
2020
|
/**
|
|
2173
|
-
* The type of the network connection to the integration endpoint. Currently the only
|
|
2174
|
-
valid value is INTERNET, for connections through the public routable
|
|
2175
|
-
internet.
|
|
2021
|
+
* The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
|
|
2176
2022
|
*/
|
|
2177
2023
|
ConnectionType?: ConnectionType;
|
|
2178
2024
|
/**
|
|
2179
|
-
* Specifies how to handle response payload content type conversions. Supported
|
|
2180
|
-
values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
|
|
2181
|
-
following behaviors:
|
|
2182
|
-
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded
|
|
2183
|
-
string to the corresponding binary blob.
|
|
2184
|
-
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a
|
|
2185
|
-
Base64-encoded string.If this property is not defined, the response payload will be passed through from
|
|
2186
|
-
the integration response to the route response or method response without
|
|
2187
|
-
modification.
|
|
2025
|
+
* 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: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
|
|
2188
2026
|
*/
|
|
2189
2027
|
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
2190
2028
|
/**
|
|
2191
|
-
* Specifies the credentials required for the integration, if any. For AWS
|
|
2192
|
-
integrations, three options are available. To specify an IAM Role for API Gateway to
|
|
2193
|
-
assume, use the role's Amazon Resource Name (ARN). To require that the caller's
|
|
2194
|
-
identity be passed through from the request, specify the string
|
|
2195
|
-
arn:aws:iam::*:user/*. To use resource-based permissions on supported
|
|
2196
|
-
AWS services, specify null.
|
|
2029
|
+
* Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
|
|
2197
2030
|
*/
|
|
2198
2031
|
CredentialsArn?: Arn;
|
|
2199
2032
|
/**
|
|
@@ -2209,27 +2042,11 @@ declare namespace ApiGatewayV2 {
|
|
|
2209
2042
|
*/
|
|
2210
2043
|
IntegrationMethod?: StringWithLengthBetween1And64;
|
|
2211
2044
|
/**
|
|
2212
|
-
* The integration response selection expression for the integration. See Integration Response Selection Expressions.
|
|
2045
|
+
* The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
|
|
2213
2046
|
*/
|
|
2214
2047
|
IntegrationResponseSelectionExpression?: SelectionExpression;
|
|
2215
2048
|
/**
|
|
2216
|
-
* The integration type of an integration. One of the following:
|
|
2217
|
-
AWS: for integrating the route or method request with an AWS service
|
|
2218
|
-
action, including the Lambda function-invoking action. With the Lambda
|
|
2219
|
-
function-invoking action, this is referred to as the Lambda custom integration. With
|
|
2220
|
-
any other AWS service action, this is known as AWS integration.
|
|
2221
|
-
AWS_PROXY: for integrating the route or method request with the Lambda
|
|
2222
|
-
function-invoking action with the client request passed through as-is. This
|
|
2223
|
-
integration is also referred to as Lambda proxy integration.
|
|
2224
|
-
HTTP: for integrating the route or method request with an HTTP
|
|
2225
|
-
endpoint. This
|
|
2226
|
-
integration is also referred to as the HTTP custom integration.
|
|
2227
|
-
HTTP_PROXY: for integrating route or method request with an HTTP
|
|
2228
|
-
endpoint, with the client
|
|
2229
|
-
request passed through as-is. This is also referred to as HTTP proxy
|
|
2230
|
-
integration.
|
|
2231
|
-
MOCK: for integrating the route or method request with API Gateway as a
|
|
2232
|
-
"loopback" endpoint without invoking any backend.
|
|
2049
|
+
* The integration type of an integration. One of the following: AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs. AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration. HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs. HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
|
|
2233
2050
|
*/
|
|
2234
2051
|
IntegrationType?: IntegrationType;
|
|
2235
2052
|
/**
|
|
@@ -2237,49 +2054,32 @@ declare namespace ApiGatewayV2 {
|
|
|
2237
2054
|
*/
|
|
2238
2055
|
IntegrationUri?: UriWithLengthBetween1And2048;
|
|
2239
2056
|
/**
|
|
2240
|
-
* Specifies the pass-through behavior for incoming requests based on the
|
|
2241
|
-
Content-Type header in the request, and the available mapping
|
|
2242
|
-
templates specified as the requestTemplates property on the
|
|
2243
|
-
Integration resource. There are three valid values:
|
|
2244
|
-
WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
|
|
2245
|
-
NEVER.
|
|
2246
|
-
WHEN_NO_MATCH passes the request body for unmapped content types through
|
|
2247
|
-
to the integration backend without transformation.
|
|
2248
|
-
NEVER rejects unmapped content types with an HTTP 415 Unsupported
|
|
2249
|
-
Media Type response.
|
|
2250
|
-
WHEN_NO_TEMPLATES allows pass-through when the integration has no
|
|
2251
|
-
content types mapped to templates. However, if there is at least one content type
|
|
2252
|
-
defined, unmapped content types will be rejected with the same HTTP 415
|
|
2253
|
-
Unsupported Media Type response.
|
|
2057
|
+
* Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation. NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response. WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
|
|
2254
2058
|
*/
|
|
2255
2059
|
PassthroughBehavior?: PassthroughBehavior;
|
|
2256
2060
|
/**
|
|
2257
|
-
*
|
|
2258
|
-
|
|
2259
|
-
|
|
2260
|
-
|
|
2261
|
-
request parameter value must match the pattern of
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
|
|
2265
|
-
|
|
2266
|
-
|
|
2267
|
-
must be a valid and unique method request parameter name.
|
|
2061
|
+
* Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.
|
|
2062
|
+
*/
|
|
2063
|
+
PayloadFormatVersion?: StringWithLengthBetween1And64;
|
|
2064
|
+
/**
|
|
2065
|
+
* 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.{location}.{name}
|
|
2066
|
+
, where
|
|
2067
|
+
{location}
|
|
2068
|
+
is querystring, path, or header; and
|
|
2069
|
+
{name}
|
|
2070
|
+
must be a valid and unique method request parameter name. Supported only for WebSocket APIs.
|
|
2268
2071
|
*/
|
|
2269
2072
|
RequestParameters?: IntegrationParameters;
|
|
2270
2073
|
/**
|
|
2271
|
-
* Represents a map of Velocity templates that are applied on the request payload
|
|
2272
|
-
based on the value of the Content-Type header sent by the client. The content type
|
|
2273
|
-
value is the key in this map, and the template (as a String) is the value.
|
|
2074
|
+
* Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
|
|
2274
2075
|
*/
|
|
2275
2076
|
RequestTemplates?: TemplateMap;
|
|
2276
2077
|
/**
|
|
2277
|
-
* The template selection expression for the integration.
|
|
2078
|
+
* The template selection expression for the integration. Supported only for WebSocket APIs.
|
|
2278
2079
|
*/
|
|
2279
2080
|
TemplateSelectionExpression?: SelectionExpression;
|
|
2280
2081
|
/**
|
|
2281
|
-
* Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000
|
|
2282
|
-
milliseconds or 29 seconds.
|
|
2082
|
+
* Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
|
|
2283
2083
|
*/
|
|
2284
2084
|
TimeoutInMillis?: IntegerWithLengthBetween50And29000;
|
|
2285
2085
|
}
|
|
@@ -2299,15 +2099,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2299
2099
|
}
|
|
2300
2100
|
export interface GetIntegrationResponseResponse {
|
|
2301
2101
|
/**
|
|
2302
|
-
* Specifies how to handle response payload content type conversions. Supported
|
|
2303
|
-
values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
|
|
2304
|
-
following behaviors:
|
|
2305
|
-
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded
|
|
2306
|
-
string to the corresponding binary blob.
|
|
2307
|
-
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a
|
|
2308
|
-
Base64-encoded string.If this property is not defined, the response payload will be passed through from
|
|
2309
|
-
the integration response to the route response or method response without
|
|
2310
|
-
modification.
|
|
2102
|
+
* 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: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
|
|
2311
2103
|
*/
|
|
2312
2104
|
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
2313
2105
|
/**
|
|
@@ -2319,21 +2111,11 @@ declare namespace ApiGatewayV2 {
|
|
|
2319
2111
|
*/
|
|
2320
2112
|
IntegrationResponseKey?: SelectionKey;
|
|
2321
2113
|
/**
|
|
2322
|
-
* A key-value map specifying response parameters that are passed to the method
|
|
2323
|
-
response from the backend. The key is a method response header parameter name and the
|
|
2324
|
-
mapped value is an integration response header value, a static value enclosed within
|
|
2325
|
-
a pair of single quotes, or a JSON expression from the integration response body. The
|
|
2326
|
-
mapping key must match the pattern of method.response.header.{name}, where name is a
|
|
2327
|
-
valid and unique header name. The mapped non-static value must match the pattern of
|
|
2328
|
-
integration.response.header.{name} or integration.response.body.{JSON-expression},
|
|
2329
|
-
where name is a valid and unique response header name and JSON-expression is a valid
|
|
2330
|
-
JSON expression without the $ prefix.
|
|
2114
|
+
* 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.
|
|
2331
2115
|
*/
|
|
2332
2116
|
ResponseParameters?: IntegrationParameters;
|
|
2333
2117
|
/**
|
|
2334
|
-
* The collection of response templates for the integration response as a
|
|
2335
|
-
string-to-string map of key-value pairs. Response templates are represented as a
|
|
2336
|
-
key/value map, with a content-type as the key and a template as the value.
|
|
2118
|
+
* The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
|
|
2337
2119
|
*/
|
|
2338
2120
|
ResponseTemplates?: TemplateMap;
|
|
2339
2121
|
/**
|
|
@@ -2355,8 +2137,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2355
2137
|
*/
|
|
2356
2138
|
MaxResults?: __string;
|
|
2357
2139
|
/**
|
|
2358
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
2359
|
-
the collection.
|
|
2140
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
2360
2141
|
*/
|
|
2361
2142
|
NextToken?: __string;
|
|
2362
2143
|
}
|
|
@@ -2366,8 +2147,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2366
2147
|
*/
|
|
2367
2148
|
Items?: __listOfIntegrationResponse;
|
|
2368
2149
|
/**
|
|
2369
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
2370
|
-
the collection.
|
|
2150
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
2371
2151
|
*/
|
|
2372
2152
|
NextToken?: NextToken;
|
|
2373
2153
|
}
|
|
@@ -2381,8 +2161,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2381
2161
|
*/
|
|
2382
2162
|
MaxResults?: __string;
|
|
2383
2163
|
/**
|
|
2384
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
2385
|
-
the collection.
|
|
2164
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
2386
2165
|
*/
|
|
2387
2166
|
NextToken?: __string;
|
|
2388
2167
|
}
|
|
@@ -2392,8 +2171,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2392
2171
|
*/
|
|
2393
2172
|
Items?: __listOfIntegration;
|
|
2394
2173
|
/**
|
|
2395
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
2396
|
-
the collection.
|
|
2174
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
2397
2175
|
*/
|
|
2398
2176
|
NextToken?: NextToken;
|
|
2399
2177
|
}
|
|
@@ -2425,8 +2203,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2425
2203
|
*/
|
|
2426
2204
|
Name?: StringWithLengthBetween1And128;
|
|
2427
2205
|
/**
|
|
2428
|
-
* The schema for the model. For application/json models, this should be JSON schema
|
|
2429
|
-
draft 4 model.
|
|
2206
|
+
* The schema for the model. For application/json models, this should be JSON schema draft 4 model.
|
|
2430
2207
|
*/
|
|
2431
2208
|
Schema?: StringWithLengthBetween0And32K;
|
|
2432
2209
|
}
|
|
@@ -2456,8 +2233,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2456
2233
|
*/
|
|
2457
2234
|
MaxResults?: __string;
|
|
2458
2235
|
/**
|
|
2459
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
2460
|
-
the collection.
|
|
2236
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
2461
2237
|
*/
|
|
2462
2238
|
NextToken?: __string;
|
|
2463
2239
|
}
|
|
@@ -2467,8 +2243,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2467
2243
|
*/
|
|
2468
2244
|
Items?: __listOfModel;
|
|
2469
2245
|
/**
|
|
2470
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
2471
|
-
the collection.
|
|
2246
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
2472
2247
|
*/
|
|
2473
2248
|
NextToken?: NextToken;
|
|
2474
2249
|
}
|
|
@@ -2482,37 +2257,29 @@ declare namespace ApiGatewayV2 {
|
|
|
2482
2257
|
*/
|
|
2483
2258
|
RouteId: __string;
|
|
2484
2259
|
}
|
|
2485
|
-
export interface
|
|
2260
|
+
export interface GetRouteResult {
|
|
2486
2261
|
/**
|
|
2487
|
-
* Specifies whether an API
|
|
2262
|
+
* 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.
|
|
2263
|
+
*/
|
|
2264
|
+
ApiGatewayManaged?: __boolean;
|
|
2265
|
+
/**
|
|
2266
|
+
* Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
|
|
2488
2267
|
*/
|
|
2489
2268
|
ApiKeyRequired?: __boolean;
|
|
2490
2269
|
/**
|
|
2491
|
-
* A list of authorization scopes configured on a route. The scopes are used with a
|
|
2492
|
-
COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization
|
|
2493
|
-
works by matching the route scopes against the scopes parsed from the access token in
|
|
2494
|
-
the incoming request. The method invocation is authorized if any route scope matches
|
|
2495
|
-
a claimed scope in the access token. Otherwise, the invocation is not authorized.
|
|
2496
|
-
When the route scope is configured, the client must provide an access token instead
|
|
2497
|
-
of an identity token for authorization purposes.
|
|
2270
|
+
* A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
|
|
2498
2271
|
*/
|
|
2499
2272
|
AuthorizationScopes?: AuthorizationScopes;
|
|
2500
2273
|
/**
|
|
2501
|
-
* The authorization type for the route.
|
|
2502
|
-
access, AWS_IAM for using AWS IAM permissions, and CUSTOM
|
|
2503
|
-
for using a Lambda
|
|
2504
|
-
authorizer
|
|
2274
|
+
* The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.
|
|
2505
2275
|
*/
|
|
2506
2276
|
AuthorizationType?: AuthorizationType;
|
|
2507
2277
|
/**
|
|
2508
|
-
* The identifier of the Authorizer resource to be associated with this
|
|
2509
|
-
route, if the authorizationType is CUSTOM
|
|
2510
|
-
. The authorizer identifier is generated by API Gateway
|
|
2511
|
-
when you created the authorizer.
|
|
2278
|
+
* The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
|
|
2512
2279
|
*/
|
|
2513
2280
|
AuthorizerId?: Id;
|
|
2514
2281
|
/**
|
|
2515
|
-
* The model selection expression for the route.
|
|
2282
|
+
* The model selection expression for the route. Supported only for WebSocket APIs.
|
|
2516
2283
|
*/
|
|
2517
2284
|
ModelSelectionExpression?: SelectionExpression;
|
|
2518
2285
|
/**
|
|
@@ -2520,11 +2287,11 @@ declare namespace ApiGatewayV2 {
|
|
|
2520
2287
|
*/
|
|
2521
2288
|
OperationName?: StringWithLengthBetween1And64;
|
|
2522
2289
|
/**
|
|
2523
|
-
* The request models for the route.
|
|
2290
|
+
* The request models for the route. Supported only for WebSocket APIs.
|
|
2524
2291
|
*/
|
|
2525
2292
|
RequestModels?: RouteModels;
|
|
2526
2293
|
/**
|
|
2527
|
-
* The request parameters for the route.
|
|
2294
|
+
* The request parameters for the route. Supported only for WebSocket APIs.
|
|
2528
2295
|
*/
|
|
2529
2296
|
RequestParameters?: RouteParameters;
|
|
2530
2297
|
/**
|
|
@@ -2536,7 +2303,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2536
2303
|
*/
|
|
2537
2304
|
RouteKey?: SelectionKey;
|
|
2538
2305
|
/**
|
|
2539
|
-
* The route response selection expression for the route.
|
|
2306
|
+
* The route response selection expression for the route. Supported only for WebSocket APIs.
|
|
2540
2307
|
*/
|
|
2541
2308
|
RouteResponseSelectionExpression?: SelectionExpression;
|
|
2542
2309
|
/**
|
|
@@ -2560,7 +2327,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2560
2327
|
}
|
|
2561
2328
|
export interface GetRouteResponseResponse {
|
|
2562
2329
|
/**
|
|
2563
|
-
* Represents the model selection expression of a route response.
|
|
2330
|
+
* Represents the model selection expression of a route response. Supported only for WebSocket APIs.
|
|
2564
2331
|
*/
|
|
2565
2332
|
ModelSelectionExpression?: SelectionExpression;
|
|
2566
2333
|
/**
|
|
@@ -2590,8 +2357,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2590
2357
|
*/
|
|
2591
2358
|
MaxResults?: __string;
|
|
2592
2359
|
/**
|
|
2593
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
2594
|
-
the collection.
|
|
2360
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
2595
2361
|
*/
|
|
2596
2362
|
NextToken?: __string;
|
|
2597
2363
|
/**
|
|
@@ -2605,8 +2371,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2605
2371
|
*/
|
|
2606
2372
|
Items?: __listOfRouteResponse;
|
|
2607
2373
|
/**
|
|
2608
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
2609
|
-
the collection.
|
|
2374
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
2610
2375
|
*/
|
|
2611
2376
|
NextToken?: NextToken;
|
|
2612
2377
|
}
|
|
@@ -2620,8 +2385,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2620
2385
|
*/
|
|
2621
2386
|
MaxResults?: __string;
|
|
2622
2387
|
/**
|
|
2623
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
2624
|
-
the collection.
|
|
2388
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
2625
2389
|
*/
|
|
2626
2390
|
NextToken?: __string;
|
|
2627
2391
|
}
|
|
@@ -2631,8 +2395,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2631
2395
|
*/
|
|
2632
2396
|
Items?: __listOfRoute;
|
|
2633
2397
|
/**
|
|
2634
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
2635
|
-
the collection.
|
|
2398
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
2636
2399
|
*/
|
|
2637
2400
|
NextToken?: NextToken;
|
|
2638
2401
|
}
|
|
@@ -2642,7 +2405,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2642
2405
|
*/
|
|
2643
2406
|
ApiId: __string;
|
|
2644
2407
|
/**
|
|
2645
|
-
* The stage name.
|
|
2408
|
+
* The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
|
|
2646
2409
|
*/
|
|
2647
2410
|
StageName: __string;
|
|
2648
2411
|
}
|
|
@@ -2652,7 +2415,15 @@ declare namespace ApiGatewayV2 {
|
|
|
2652
2415
|
*/
|
|
2653
2416
|
AccessLogSettings?: AccessLogSettings;
|
|
2654
2417
|
/**
|
|
2655
|
-
*
|
|
2418
|
+
* Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
|
|
2419
|
+
*/
|
|
2420
|
+
ApiGatewayManaged?: __boolean;
|
|
2421
|
+
/**
|
|
2422
|
+
* Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
|
|
2423
|
+
*/
|
|
2424
|
+
AutoDeploy?: __boolean;
|
|
2425
|
+
/**
|
|
2426
|
+
* The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
|
|
2656
2427
|
*/
|
|
2657
2428
|
ClientCertificateId?: Id;
|
|
2658
2429
|
/**
|
|
@@ -2664,20 +2435,23 @@ declare namespace ApiGatewayV2 {
|
|
|
2664
2435
|
*/
|
|
2665
2436
|
DefaultRouteSettings?: RouteSettings;
|
|
2666
2437
|
/**
|
|
2667
|
-
* The identifier of the Deployment that the Stage is
|
|
2668
|
-
associated with.
|
|
2438
|
+
* The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
|
|
2669
2439
|
*/
|
|
2670
2440
|
DeploymentId?: Id;
|
|
2671
2441
|
/**
|
|
2672
2442
|
* The description of the stage.
|
|
2673
2443
|
*/
|
|
2674
2444
|
Description?: StringWithLengthBetween0And1024;
|
|
2445
|
+
/**
|
|
2446
|
+
* Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
|
|
2447
|
+
*/
|
|
2448
|
+
LastDeploymentStatusMessage?: __string;
|
|
2675
2449
|
/**
|
|
2676
2450
|
* The timestamp when the stage was last updated.
|
|
2677
2451
|
*/
|
|
2678
2452
|
LastUpdatedDate?: __timestampIso8601;
|
|
2679
2453
|
/**
|
|
2680
|
-
* Route settings for the stage.
|
|
2454
|
+
* Route settings for the stage, by routeKey.
|
|
2681
2455
|
*/
|
|
2682
2456
|
RouteSettings?: RouteSettingsMap;
|
|
2683
2457
|
/**
|
|
@@ -2685,13 +2459,11 @@ declare namespace ApiGatewayV2 {
|
|
|
2685
2459
|
*/
|
|
2686
2460
|
StageName?: StringWithLengthBetween1And128;
|
|
2687
2461
|
/**
|
|
2688
|
-
* A map that defines the stage variables for a stage resource. Variable names can
|
|
2689
|
-
have alphanumeric and underscore characters, and the values must match
|
|
2690
|
-
[A-Za-z0-9-._~:/?#&=,]+.
|
|
2462
|
+
* A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. Supported only for WebSocket APIs.
|
|
2691
2463
|
*/
|
|
2692
2464
|
StageVariables?: StageVariablesMap;
|
|
2693
2465
|
/**
|
|
2694
|
-
* The
|
|
2466
|
+
* The collection of tags. Each tag element is associated with a given resource.
|
|
2695
2467
|
*/
|
|
2696
2468
|
Tags?: Tags;
|
|
2697
2469
|
}
|
|
@@ -2705,8 +2477,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2705
2477
|
*/
|
|
2706
2478
|
MaxResults?: __string;
|
|
2707
2479
|
/**
|
|
2708
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
2709
|
-
the collection.
|
|
2480
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
2710
2481
|
*/
|
|
2711
2482
|
NextToken?: __string;
|
|
2712
2483
|
}
|
|
@@ -2716,45 +2487,115 @@ declare namespace ApiGatewayV2 {
|
|
|
2716
2487
|
*/
|
|
2717
2488
|
Items?: __listOfStage;
|
|
2718
2489
|
/**
|
|
2719
|
-
* The next page of elements from this collection. Not valid for the last element of
|
|
2720
|
-
the collection.
|
|
2490
|
+
* The next page of elements from this collection. Not valid for the last element of the collection.
|
|
2721
2491
|
*/
|
|
2722
2492
|
NextToken?: NextToken;
|
|
2723
2493
|
}
|
|
2494
|
+
export interface GetTagsRequest {
|
|
2495
|
+
/**
|
|
2496
|
+
* The resource ARN for the tag.
|
|
2497
|
+
*/
|
|
2498
|
+
ResourceArn: __string;
|
|
2499
|
+
}
|
|
2500
|
+
export interface GetTagsResponse {
|
|
2501
|
+
Tags: Tags;
|
|
2502
|
+
}
|
|
2724
2503
|
export type Id = string;
|
|
2725
2504
|
export type IdentitySourceList = __string[];
|
|
2505
|
+
export interface ImportApiRequest {
|
|
2506
|
+
/**
|
|
2507
|
+
* Represents the base path of the imported API. Supported only for HTTP APIs.
|
|
2508
|
+
*/
|
|
2509
|
+
Basepath?: __string;
|
|
2510
|
+
/**
|
|
2511
|
+
* The OpenAPI definition. Supported only for HTTP APIs.
|
|
2512
|
+
*/
|
|
2513
|
+
Body: __string;
|
|
2514
|
+
/**
|
|
2515
|
+
* Specifies whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.
|
|
2516
|
+
*/
|
|
2517
|
+
FailOnWarnings?: __boolean;
|
|
2518
|
+
}
|
|
2519
|
+
export interface ImportApiResponse {
|
|
2520
|
+
/**
|
|
2521
|
+
* 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.
|
|
2522
|
+
*/
|
|
2523
|
+
ApiEndpoint?: __string;
|
|
2524
|
+
/**
|
|
2525
|
+
* The API ID.
|
|
2526
|
+
*/
|
|
2527
|
+
ApiId?: Id;
|
|
2528
|
+
/**
|
|
2529
|
+
* An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
|
|
2530
|
+
*/
|
|
2531
|
+
ApiKeySelectionExpression?: SelectionExpression;
|
|
2532
|
+
/**
|
|
2533
|
+
* A CORS configuration. Supported only for HTTP APIs.
|
|
2534
|
+
*/
|
|
2535
|
+
CorsConfiguration?: Cors;
|
|
2536
|
+
/**
|
|
2537
|
+
* The timestamp when the API was created.
|
|
2538
|
+
*/
|
|
2539
|
+
CreatedDate?: __timestampIso8601;
|
|
2540
|
+
/**
|
|
2541
|
+
* The description of the API.
|
|
2542
|
+
*/
|
|
2543
|
+
Description?: StringWithLengthBetween0And1024;
|
|
2544
|
+
/**
|
|
2545
|
+
* Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
|
|
2546
|
+
*/
|
|
2547
|
+
DisableSchemaValidation?: __boolean;
|
|
2548
|
+
/**
|
|
2549
|
+
* The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
|
|
2550
|
+
*/
|
|
2551
|
+
ImportInfo?: __listOf__string;
|
|
2552
|
+
/**
|
|
2553
|
+
* The name of the API.
|
|
2554
|
+
*/
|
|
2555
|
+
Name?: StringWithLengthBetween1And128;
|
|
2556
|
+
/**
|
|
2557
|
+
* The API protocol.
|
|
2558
|
+
*/
|
|
2559
|
+
ProtocolType?: ProtocolType;
|
|
2560
|
+
/**
|
|
2561
|
+
* 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.
|
|
2562
|
+
*/
|
|
2563
|
+
RouteSelectionExpression?: SelectionExpression;
|
|
2564
|
+
/**
|
|
2565
|
+
* A collection of tags associated with the API.
|
|
2566
|
+
*/
|
|
2567
|
+
Tags?: Tags;
|
|
2568
|
+
/**
|
|
2569
|
+
* A version identifier for the API.
|
|
2570
|
+
*/
|
|
2571
|
+
Version?: StringWithLengthBetween1And64;
|
|
2572
|
+
/**
|
|
2573
|
+
* The warning messages reported when failonwarnings is turned on during API import.
|
|
2574
|
+
*/
|
|
2575
|
+
Warnings?: __listOf__string;
|
|
2576
|
+
}
|
|
2726
2577
|
export type IntegerWithLengthBetween0And3600 = number;
|
|
2727
2578
|
export type IntegerWithLengthBetween50And29000 = number;
|
|
2579
|
+
export type IntegerWithLengthBetweenMinus1And86400 = number;
|
|
2728
2580
|
export interface Integration {
|
|
2581
|
+
/**
|
|
2582
|
+
* 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.
|
|
2583
|
+
*/
|
|
2584
|
+
ApiGatewayManaged?: __boolean;
|
|
2729
2585
|
/**
|
|
2730
2586
|
* The connection ID.
|
|
2731
2587
|
*/
|
|
2732
2588
|
ConnectionId?: StringWithLengthBetween1And1024;
|
|
2733
2589
|
/**
|
|
2734
|
-
* The type of the network connection to the integration endpoint. Currently the only
|
|
2735
|
-
valid value is INTERNET, for connections through the public routable
|
|
2736
|
-
internet.
|
|
2590
|
+
* The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
|
|
2737
2591
|
*/
|
|
2738
2592
|
ConnectionType?: ConnectionType;
|
|
2739
2593
|
/**
|
|
2740
|
-
* Specifies how to handle response payload content type conversions. Supported
|
|
2741
|
-
values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
|
|
2742
|
-
following behaviors:
|
|
2743
|
-
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded
|
|
2744
|
-
string to the corresponding binary blob.
|
|
2745
|
-
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a
|
|
2746
|
-
Base64-encoded string.If this property is not defined, the response payload will be passed through from
|
|
2747
|
-
the integration response to the route response or method response without
|
|
2748
|
-
modification.
|
|
2594
|
+
* 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: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
|
|
2749
2595
|
*/
|
|
2750
2596
|
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
2751
2597
|
/**
|
|
2752
|
-
* Specifies the credentials required for the integration, if any. For AWS
|
|
2753
|
-
integrations, three options are available. To specify an IAM Role for API Gateway to
|
|
2754
|
-
assume, use the role's Amazon Resource Name (ARN). To require that the caller's
|
|
2755
|
-
identity be passed through from the request, specify the string
|
|
2756
|
-
arn:aws:iam::*:user/*. To use resource-based permissions on supported
|
|
2757
|
-
AWS services, specify null.
|
|
2598
|
+
* Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
|
|
2758
2599
|
*/
|
|
2759
2600
|
CredentialsArn?: Arn;
|
|
2760
2601
|
/**
|
|
@@ -2770,27 +2611,11 @@ declare namespace ApiGatewayV2 {
|
|
|
2770
2611
|
*/
|
|
2771
2612
|
IntegrationMethod?: StringWithLengthBetween1And64;
|
|
2772
2613
|
/**
|
|
2773
|
-
* The integration response selection expression for the integration. See Integration Response Selection Expressions.
|
|
2614
|
+
* The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
|
|
2774
2615
|
*/
|
|
2775
2616
|
IntegrationResponseSelectionExpression?: SelectionExpression;
|
|
2776
2617
|
/**
|
|
2777
|
-
* The integration type of an integration. One of the following:
|
|
2778
|
-
AWS: for integrating the route or method request with an AWS service
|
|
2779
|
-
action, including the Lambda function-invoking action. With the Lambda
|
|
2780
|
-
function-invoking action, this is referred to as the Lambda custom integration. With
|
|
2781
|
-
any other AWS service action, this is known as AWS integration.
|
|
2782
|
-
AWS_PROXY: for integrating the route or method request with the Lambda
|
|
2783
|
-
function-invoking action with the client request passed through as-is. This
|
|
2784
|
-
integration is also referred to as Lambda proxy integration.
|
|
2785
|
-
HTTP: for integrating the route or method request with an HTTP
|
|
2786
|
-
endpoint. This
|
|
2787
|
-
integration is also referred to as the HTTP custom integration.
|
|
2788
|
-
HTTP_PROXY: for integrating route or method request with an HTTP
|
|
2789
|
-
endpoint, with the client
|
|
2790
|
-
request passed through as-is. This is also referred to as HTTP proxy
|
|
2791
|
-
integration.
|
|
2792
|
-
MOCK: for integrating the route or method request with API Gateway as a
|
|
2793
|
-
"loopback" endpoint without invoking any backend.
|
|
2618
|
+
* The integration type of an integration. One of the following: AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs. AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration. HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs. HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
|
|
2794
2619
|
*/
|
|
2795
2620
|
IntegrationType?: IntegrationType;
|
|
2796
2621
|
/**
|
|
@@ -2798,64 +2623,39 @@ declare namespace ApiGatewayV2 {
|
|
|
2798
2623
|
*/
|
|
2799
2624
|
IntegrationUri?: UriWithLengthBetween1And2048;
|
|
2800
2625
|
/**
|
|
2801
|
-
* Specifies the pass-through behavior for incoming requests based on the
|
|
2802
|
-
Content-Type header in the request, and the available mapping
|
|
2803
|
-
templates specified as the requestTemplates property on the
|
|
2804
|
-
Integration resource. There are three valid values:
|
|
2805
|
-
WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
|
|
2806
|
-
NEVER.
|
|
2807
|
-
WHEN_NO_MATCH passes the request body for unmapped content types through
|
|
2808
|
-
to the integration backend without transformation.
|
|
2809
|
-
NEVER rejects unmapped content types with an HTTP 415 Unsupported
|
|
2810
|
-
Media Type response.
|
|
2811
|
-
WHEN_NO_TEMPLATES allows pass-through when the integration has no
|
|
2812
|
-
content types mapped to templates. However, if there is at least one content type
|
|
2813
|
-
defined, unmapped content types will be rejected with the same HTTP 415
|
|
2814
|
-
Unsupported Media Type response.
|
|
2626
|
+
* Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation. NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response. WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
|
|
2815
2627
|
*/
|
|
2816
2628
|
PassthroughBehavior?: PassthroughBehavior;
|
|
2817
2629
|
/**
|
|
2818
|
-
*
|
|
2819
|
-
|
|
2820
|
-
|
|
2821
|
-
|
|
2822
|
-
request parameter value must match the pattern of
|
|
2823
|
-
|
|
2824
|
-
|
|
2825
|
-
|
|
2826
|
-
|
|
2827
|
-
|
|
2828
|
-
must be a valid and unique method request parameter name.
|
|
2630
|
+
* Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.
|
|
2631
|
+
*/
|
|
2632
|
+
PayloadFormatVersion?: StringWithLengthBetween1And64;
|
|
2633
|
+
/**
|
|
2634
|
+
* 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.{location}.{name}
|
|
2635
|
+
, where
|
|
2636
|
+
{location}
|
|
2637
|
+
is querystring, path, or header; and
|
|
2638
|
+
{name}
|
|
2639
|
+
must be a valid and unique method request parameter name. Supported only for WebSocket APIs.
|
|
2829
2640
|
*/
|
|
2830
2641
|
RequestParameters?: IntegrationParameters;
|
|
2831
2642
|
/**
|
|
2832
|
-
* Represents a map of Velocity templates that are applied on the request payload
|
|
2833
|
-
based on the value of the Content-Type header sent by the client. The content type
|
|
2834
|
-
value is the key in this map, and the template (as a String) is the value.
|
|
2643
|
+
* Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
|
|
2835
2644
|
*/
|
|
2836
2645
|
RequestTemplates?: TemplateMap;
|
|
2837
2646
|
/**
|
|
2838
|
-
* The template selection expression for the integration.
|
|
2647
|
+
* The template selection expression for the integration. Supported only for WebSocket APIs.
|
|
2839
2648
|
*/
|
|
2840
2649
|
TemplateSelectionExpression?: SelectionExpression;
|
|
2841
2650
|
/**
|
|
2842
|
-
* Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000
|
|
2843
|
-
milliseconds or 29 seconds.
|
|
2651
|
+
* Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
|
|
2844
2652
|
*/
|
|
2845
2653
|
TimeoutInMillis?: IntegerWithLengthBetween50And29000;
|
|
2846
2654
|
}
|
|
2847
2655
|
export type IntegrationParameters = {[key: string]: StringWithLengthBetween1And512};
|
|
2848
2656
|
export interface IntegrationResponse {
|
|
2849
2657
|
/**
|
|
2850
|
-
* Specifies how to handle response payload content type conversions. Supported
|
|
2851
|
-
values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
|
|
2852
|
-
following behaviors:
|
|
2853
|
-
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded
|
|
2854
|
-
string to the corresponding binary blob.
|
|
2855
|
-
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a
|
|
2856
|
-
Base64-encoded string.If this property is not defined, the response payload will be passed through from
|
|
2857
|
-
the integration response to the route response or method response without
|
|
2858
|
-
modification.
|
|
2658
|
+
* 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: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
|
|
2859
2659
|
*/
|
|
2860
2660
|
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
2861
2661
|
/**
|
|
@@ -2867,21 +2667,11 @@ declare namespace ApiGatewayV2 {
|
|
|
2867
2667
|
*/
|
|
2868
2668
|
IntegrationResponseKey: SelectionKey;
|
|
2869
2669
|
/**
|
|
2870
|
-
* A key-value map specifying response parameters that are passed to the method
|
|
2871
|
-
response from the backend. The key is a method response header parameter name and the
|
|
2872
|
-
mapped value is an integration response header value, a static value enclosed within
|
|
2873
|
-
a pair of single quotes, or a JSON expression from the integration response body. The
|
|
2874
|
-
mapping key must match the pattern of method.response.header.{name}, where name is a
|
|
2875
|
-
valid and unique header name. The mapped non-static value must match the pattern of
|
|
2876
|
-
integration.response.header.{name} or integration.response.body.{JSON-expression},
|
|
2877
|
-
where name is a valid and unique response header name and JSON-expression is a valid
|
|
2878
|
-
JSON expression without the $ prefix.
|
|
2670
|
+
* 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.
|
|
2879
2671
|
*/
|
|
2880
2672
|
ResponseParameters?: IntegrationParameters;
|
|
2881
2673
|
/**
|
|
2882
|
-
* The collection of response templates for the integration response as a
|
|
2883
|
-
string-to-string map of key-value pairs. Response templates are represented as a
|
|
2884
|
-
key/value map, with a content-type as the key and a template as the value.
|
|
2674
|
+
* The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
|
|
2885
2675
|
*/
|
|
2886
2676
|
ResponseTemplates?: TemplateMap;
|
|
2887
2677
|
/**
|
|
@@ -2890,11 +2680,16 @@ declare namespace ApiGatewayV2 {
|
|
|
2890
2680
|
TemplateSelectionExpression?: SelectionExpression;
|
|
2891
2681
|
}
|
|
2892
2682
|
export type IntegrationType = "AWS"|"HTTP"|"MOCK"|"HTTP_PROXY"|"AWS_PROXY"|string;
|
|
2893
|
-
export interface
|
|
2894
|
-
|
|
2895
|
-
|
|
2896
|
-
|
|
2897
|
-
|
|
2683
|
+
export interface JWTConfiguration {
|
|
2684
|
+
/**
|
|
2685
|
+
* A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.
|
|
2686
|
+
*/
|
|
2687
|
+
Audience?: __listOf__string;
|
|
2688
|
+
/**
|
|
2689
|
+
* 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.{region}.amazonaws.com/{userPoolId}
|
|
2690
|
+
. Required for the JWT authorizer type. Supported only for HTTP APIs.
|
|
2691
|
+
*/
|
|
2692
|
+
Issuer?: UriWithLengthBetween1And2048;
|
|
2898
2693
|
}
|
|
2899
2694
|
export type LoggingLevel = "ERROR"|"INFO"|"false"|string;
|
|
2900
2695
|
export interface Model {
|
|
@@ -2915,8 +2710,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2915
2710
|
*/
|
|
2916
2711
|
Name: StringWithLengthBetween1And128;
|
|
2917
2712
|
/**
|
|
2918
|
-
* The schema for the model. For application/json models, this should be JSON schema
|
|
2919
|
-
draft 4 model.
|
|
2713
|
+
* The schema for the model. For application/json models, this should be JSON schema draft 4 model.
|
|
2920
2714
|
*/
|
|
2921
2715
|
Schema?: StringWithLengthBetween0And32K;
|
|
2922
2716
|
}
|
|
@@ -2928,39 +2722,106 @@ declare namespace ApiGatewayV2 {
|
|
|
2928
2722
|
Required?: __boolean;
|
|
2929
2723
|
}
|
|
2930
2724
|
export type PassthroughBehavior = "WHEN_NO_MATCH"|"NEVER"|"WHEN_NO_TEMPLATES"|string;
|
|
2931
|
-
export type ProtocolType = "WEBSOCKET"|string;
|
|
2932
|
-
export
|
|
2725
|
+
export type ProtocolType = "WEBSOCKET"|"HTTP"|string;
|
|
2726
|
+
export interface ReimportApiRequest {
|
|
2727
|
+
/**
|
|
2728
|
+
* The API identifier.
|
|
2729
|
+
*/
|
|
2730
|
+
ApiId: __string;
|
|
2731
|
+
/**
|
|
2732
|
+
* Represents the base path of the imported API. Supported only for HTTP APIs.
|
|
2733
|
+
*/
|
|
2734
|
+
Basepath?: __string;
|
|
2735
|
+
/**
|
|
2736
|
+
* The OpenAPI definition. Supported only for HTTP APIs.
|
|
2737
|
+
*/
|
|
2738
|
+
Body: __string;
|
|
2739
|
+
/**
|
|
2740
|
+
* Specifies whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.
|
|
2741
|
+
*/
|
|
2742
|
+
FailOnWarnings?: __boolean;
|
|
2743
|
+
}
|
|
2744
|
+
export interface ReimportApiResponse {
|
|
2745
|
+
/**
|
|
2746
|
+
* 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.
|
|
2747
|
+
*/
|
|
2748
|
+
ApiEndpoint?: __string;
|
|
2749
|
+
/**
|
|
2750
|
+
* The API ID.
|
|
2751
|
+
*/
|
|
2752
|
+
ApiId?: Id;
|
|
2753
|
+
/**
|
|
2754
|
+
* An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
|
|
2755
|
+
*/
|
|
2756
|
+
ApiKeySelectionExpression?: SelectionExpression;
|
|
2757
|
+
/**
|
|
2758
|
+
* A CORS configuration. Supported only for HTTP APIs.
|
|
2759
|
+
*/
|
|
2760
|
+
CorsConfiguration?: Cors;
|
|
2761
|
+
/**
|
|
2762
|
+
* The timestamp when the API was created.
|
|
2763
|
+
*/
|
|
2764
|
+
CreatedDate?: __timestampIso8601;
|
|
2765
|
+
/**
|
|
2766
|
+
* The description of the API.
|
|
2767
|
+
*/
|
|
2768
|
+
Description?: StringWithLengthBetween0And1024;
|
|
2769
|
+
/**
|
|
2770
|
+
* Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
|
|
2771
|
+
*/
|
|
2772
|
+
DisableSchemaValidation?: __boolean;
|
|
2773
|
+
/**
|
|
2774
|
+
* The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
|
|
2775
|
+
*/
|
|
2776
|
+
ImportInfo?: __listOf__string;
|
|
2777
|
+
/**
|
|
2778
|
+
* The name of the API.
|
|
2779
|
+
*/
|
|
2780
|
+
Name?: StringWithLengthBetween1And128;
|
|
2781
|
+
/**
|
|
2782
|
+
* The API protocol.
|
|
2783
|
+
*/
|
|
2784
|
+
ProtocolType?: ProtocolType;
|
|
2785
|
+
/**
|
|
2786
|
+
* 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.
|
|
2787
|
+
*/
|
|
2788
|
+
RouteSelectionExpression?: SelectionExpression;
|
|
2789
|
+
/**
|
|
2790
|
+
* A collection of tags associated with the API.
|
|
2791
|
+
*/
|
|
2792
|
+
Tags?: Tags;
|
|
2793
|
+
/**
|
|
2794
|
+
* A version identifier for the API.
|
|
2795
|
+
*/
|
|
2796
|
+
Version?: StringWithLengthBetween1And64;
|
|
2797
|
+
/**
|
|
2798
|
+
* The warning messages reported when failonwarnings is turned on during API import.
|
|
2799
|
+
*/
|
|
2800
|
+
Warnings?: __listOf__string;
|
|
2801
|
+
}
|
|
2933
2802
|
export interface Route {
|
|
2934
2803
|
/**
|
|
2935
|
-
* Specifies whether an API
|
|
2804
|
+
* 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.
|
|
2805
|
+
*/
|
|
2806
|
+
ApiGatewayManaged?: __boolean;
|
|
2807
|
+
/**
|
|
2808
|
+
* Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
|
|
2936
2809
|
*/
|
|
2937
2810
|
ApiKeyRequired?: __boolean;
|
|
2938
2811
|
/**
|
|
2939
|
-
* A list of authorization scopes configured on a route. The scopes are used with a
|
|
2940
|
-
COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization
|
|
2941
|
-
works by matching the route scopes against the scopes parsed from the access token in
|
|
2942
|
-
the incoming request. The method invocation is authorized if any route scope matches
|
|
2943
|
-
a claimed scope in the access token. Otherwise, the invocation is not authorized.
|
|
2944
|
-
When the route scope is configured, the client must provide an access token instead
|
|
2945
|
-
of an identity token for authorization purposes.
|
|
2812
|
+
* A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
|
|
2946
2813
|
*/
|
|
2947
2814
|
AuthorizationScopes?: AuthorizationScopes;
|
|
2948
2815
|
/**
|
|
2949
|
-
* The authorization type for the route.
|
|
2950
|
-
access, AWS_IAM for using AWS IAM permissions, and CUSTOM
|
|
2951
|
-
for using a Lambda
|
|
2952
|
-
authorizer
|
|
2816
|
+
* The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.
|
|
2953
2817
|
*/
|
|
2954
2818
|
AuthorizationType?: AuthorizationType;
|
|
2955
2819
|
/**
|
|
2956
|
-
* The identifier of the Authorizer resource to be associated with this
|
|
2957
|
-
route, if the authorizationType is CUSTOM
|
|
2958
|
-
. The authorizer identifier is generated by API Gateway
|
|
2959
|
-
when you created the authorizer.
|
|
2820
|
+
* The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
|
|
2960
2821
|
*/
|
|
2961
2822
|
AuthorizerId?: Id;
|
|
2962
2823
|
/**
|
|
2963
|
-
* The model selection expression for the route.
|
|
2824
|
+
* The model selection expression for the route. Supported only for WebSocket APIs.
|
|
2964
2825
|
*/
|
|
2965
2826
|
ModelSelectionExpression?: SelectionExpression;
|
|
2966
2827
|
/**
|
|
@@ -2968,11 +2829,11 @@ declare namespace ApiGatewayV2 {
|
|
|
2968
2829
|
*/
|
|
2969
2830
|
OperationName?: StringWithLengthBetween1And64;
|
|
2970
2831
|
/**
|
|
2971
|
-
* The request models for the route.
|
|
2832
|
+
* The request models for the route. Supported only for WebSocket APIs.
|
|
2972
2833
|
*/
|
|
2973
2834
|
RequestModels?: RouteModels;
|
|
2974
2835
|
/**
|
|
2975
|
-
* The request parameters for the route.
|
|
2836
|
+
* The request parameters for the route. Supported only for WebSocket APIs.
|
|
2976
2837
|
*/
|
|
2977
2838
|
RequestParameters?: RouteParameters;
|
|
2978
2839
|
/**
|
|
@@ -2984,7 +2845,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2984
2845
|
*/
|
|
2985
2846
|
RouteKey: SelectionKey;
|
|
2986
2847
|
/**
|
|
2987
|
-
* The route response selection expression for the route.
|
|
2848
|
+
* The route response selection expression for the route. Supported only for WebSocket APIs.
|
|
2988
2849
|
*/
|
|
2989
2850
|
RouteResponseSelectionExpression?: SelectionExpression;
|
|
2990
2851
|
/**
|
|
@@ -2996,7 +2857,7 @@ declare namespace ApiGatewayV2 {
|
|
|
2996
2857
|
export type RouteParameters = {[key: string]: ParameterConstraints};
|
|
2997
2858
|
export interface RouteResponse {
|
|
2998
2859
|
/**
|
|
2999
|
-
* Represents the model selection expression of a route response.
|
|
2860
|
+
* Represents the model selection expression of a route response. Supported only for WebSocket APIs.
|
|
3000
2861
|
*/
|
|
3001
2862
|
ModelSelectionExpression?: SelectionExpression;
|
|
3002
2863
|
/**
|
|
@@ -3018,9 +2879,7 @@ declare namespace ApiGatewayV2 {
|
|
|
3018
2879
|
}
|
|
3019
2880
|
export interface RouteSettings {
|
|
3020
2881
|
/**
|
|
3021
|
-
* Specifies whether (true) or not (false) data trace
|
|
3022
|
-
logging is enabled for this route. This property affects the log entries pushed to
|
|
3023
|
-
Amazon CloudWatch Logs.
|
|
2882
|
+
* Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
|
|
3024
2883
|
*/
|
|
3025
2884
|
DataTraceEnabled?: __boolean;
|
|
3026
2885
|
/**
|
|
@@ -3028,21 +2887,20 @@ declare namespace ApiGatewayV2 {
|
|
|
3028
2887
|
*/
|
|
3029
2888
|
DetailedMetricsEnabled?: __boolean;
|
|
3030
2889
|
/**
|
|
3031
|
-
* Specifies the logging level for this route:
|
|
3032
|
-
or WARN. This property affects the log entries pushed to Amazon
|
|
3033
|
-
CloudWatch Logs.
|
|
2890
|
+
* Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
|
|
3034
2891
|
*/
|
|
3035
2892
|
LoggingLevel?: LoggingLevel;
|
|
3036
2893
|
/**
|
|
3037
|
-
* Specifies the throttling burst limit.
|
|
2894
|
+
* Specifies the throttling burst limit. Supported only for WebSocket APIs.
|
|
3038
2895
|
*/
|
|
3039
2896
|
ThrottlingBurstLimit?: __integer;
|
|
3040
2897
|
/**
|
|
3041
|
-
* Specifies the throttling rate limit.
|
|
2898
|
+
* Specifies the throttling rate limit. Supported only for WebSocket APIs.
|
|
3042
2899
|
*/
|
|
3043
2900
|
ThrottlingRateLimit?: __double;
|
|
3044
2901
|
}
|
|
3045
2902
|
export type RouteSettingsMap = {[key: string]: RouteSettings};
|
|
2903
|
+
export type SecurityPolicy = "TLS_1_0"|"TLS_1_2"|string;
|
|
3046
2904
|
export type SelectionExpression = string;
|
|
3047
2905
|
export type SelectionKey = string;
|
|
3048
2906
|
export interface Stage {
|
|
@@ -3051,7 +2909,15 @@ declare namespace ApiGatewayV2 {
|
|
|
3051
2909
|
*/
|
|
3052
2910
|
AccessLogSettings?: AccessLogSettings;
|
|
3053
2911
|
/**
|
|
3054
|
-
*
|
|
2912
|
+
* Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
|
|
2913
|
+
*/
|
|
2914
|
+
ApiGatewayManaged?: __boolean;
|
|
2915
|
+
/**
|
|
2916
|
+
* Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
|
|
2917
|
+
*/
|
|
2918
|
+
AutoDeploy?: __boolean;
|
|
2919
|
+
/**
|
|
2920
|
+
* The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
|
|
3055
2921
|
*/
|
|
3056
2922
|
ClientCertificateId?: Id;
|
|
3057
2923
|
/**
|
|
@@ -3063,20 +2929,23 @@ declare namespace ApiGatewayV2 {
|
|
|
3063
2929
|
*/
|
|
3064
2930
|
DefaultRouteSettings?: RouteSettings;
|
|
3065
2931
|
/**
|
|
3066
|
-
* The identifier of the Deployment that the Stage is
|
|
3067
|
-
associated with.
|
|
2932
|
+
* The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
|
|
3068
2933
|
*/
|
|
3069
2934
|
DeploymentId?: Id;
|
|
3070
2935
|
/**
|
|
3071
2936
|
* The description of the stage.
|
|
3072
2937
|
*/
|
|
3073
2938
|
Description?: StringWithLengthBetween0And1024;
|
|
2939
|
+
/**
|
|
2940
|
+
* Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
|
|
2941
|
+
*/
|
|
2942
|
+
LastDeploymentStatusMessage?: __string;
|
|
3074
2943
|
/**
|
|
3075
2944
|
* The timestamp when the stage was last updated.
|
|
3076
2945
|
*/
|
|
3077
2946
|
LastUpdatedDate?: __timestampIso8601;
|
|
3078
2947
|
/**
|
|
3079
|
-
* Route settings for the stage.
|
|
2948
|
+
* Route settings for the stage, by routeKey.
|
|
3080
2949
|
*/
|
|
3081
2950
|
RouteSettings?: RouteSettingsMap;
|
|
3082
2951
|
/**
|
|
@@ -3084,13 +2953,11 @@ declare namespace ApiGatewayV2 {
|
|
|
3084
2953
|
*/
|
|
3085
2954
|
StageName: StringWithLengthBetween1And128;
|
|
3086
2955
|
/**
|
|
3087
|
-
* A map that defines the stage variables for a stage resource. Variable names can
|
|
3088
|
-
have alphanumeric and underscore characters, and the values must match
|
|
3089
|
-
[A-Za-z0-9-._~:/?#&=,]+.
|
|
2956
|
+
* A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. Supported only for WebSocket APIs.
|
|
3090
2957
|
*/
|
|
3091
2958
|
StageVariables?: StageVariablesMap;
|
|
3092
2959
|
/**
|
|
3093
|
-
* The
|
|
2960
|
+
* The collection of tags. Each tag element is associated with a given resource.
|
|
3094
2961
|
*/
|
|
3095
2962
|
Tags?: Tags;
|
|
3096
2963
|
}
|
|
@@ -3100,34 +2967,36 @@ declare namespace ApiGatewayV2 {
|
|
|
3100
2967
|
export type StringWithLengthBetween0And32K = string;
|
|
3101
2968
|
export type StringWithLengthBetween1And1024 = string;
|
|
3102
2969
|
export type StringWithLengthBetween1And128 = string;
|
|
2970
|
+
export type StringWithLengthBetween1And1600 = string;
|
|
3103
2971
|
export type StringWithLengthBetween1And256 = string;
|
|
3104
2972
|
export type StringWithLengthBetween1And512 = string;
|
|
3105
2973
|
export type StringWithLengthBetween1And64 = string;
|
|
3106
|
-
export type StringWithLengthBetween1And1600 = string;
|
|
3107
2974
|
export interface TagResourceRequest {
|
|
3108
2975
|
/**
|
|
3109
|
-
*
|
|
2976
|
+
* The resource ARN for the tag.
|
|
3110
2977
|
*/
|
|
3111
2978
|
ResourceArn: __string;
|
|
3112
2979
|
/**
|
|
3113
|
-
* The
|
|
2980
|
+
* The collection of tags. Each tag element is associated with a given resource.
|
|
3114
2981
|
*/
|
|
3115
2982
|
Tags?: Tags;
|
|
3116
2983
|
}
|
|
3117
2984
|
export interface TagResourceResponse {
|
|
3118
2985
|
}
|
|
3119
2986
|
export type Tags = {[key: string]: StringWithLengthBetween1And1600};
|
|
2987
|
+
export type TemplateMap = {[key: string]: StringWithLengthBetween0And32K};
|
|
3120
2988
|
export interface UntagResourceRequest {
|
|
3121
2989
|
/**
|
|
3122
|
-
*
|
|
2990
|
+
* The resource ARN for the tag.
|
|
3123
2991
|
*/
|
|
3124
2992
|
ResourceArn: __string;
|
|
3125
2993
|
/**
|
|
3126
|
-
*
|
|
2994
|
+
*
|
|
2995
|
+
The Tag keys to delete.
|
|
2996
|
+
|
|
3127
2997
|
*/
|
|
3128
2998
|
TagKeys: __listOf__string;
|
|
3129
2999
|
}
|
|
3130
|
-
export type TemplateMap = {[key: string]: StringWithLengthBetween0And32K};
|
|
3131
3000
|
export interface UpdateApiMappingRequest {
|
|
3132
3001
|
/**
|
|
3133
3002
|
* The API identifier.
|
|
@@ -3174,15 +3043,23 @@ declare namespace ApiGatewayV2 {
|
|
|
3174
3043
|
*/
|
|
3175
3044
|
ApiId: __string;
|
|
3176
3045
|
/**
|
|
3177
|
-
* An API key selection expression. See API Key Selection Expressions.
|
|
3046
|
+
* An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
|
|
3178
3047
|
*/
|
|
3179
3048
|
ApiKeySelectionExpression?: SelectionExpression;
|
|
3049
|
+
/**
|
|
3050
|
+
* A CORS configuration. Supported only for HTTP APIs.
|
|
3051
|
+
*/
|
|
3052
|
+
CorsConfiguration?: Cors;
|
|
3053
|
+
/**
|
|
3054
|
+
* This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.
|
|
3055
|
+
*/
|
|
3056
|
+
CredentialsArn?: Arn;
|
|
3180
3057
|
/**
|
|
3181
3058
|
* The description of the API.
|
|
3182
3059
|
*/
|
|
3183
3060
|
Description?: StringWithLengthBetween0And1024;
|
|
3184
3061
|
/**
|
|
3185
|
-
* Avoid validating models when creating a deployment.
|
|
3062
|
+
* Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
|
|
3186
3063
|
*/
|
|
3187
3064
|
DisableSchemaValidation?: __boolean;
|
|
3188
3065
|
/**
|
|
@@ -3190,9 +3067,17 @@ declare namespace ApiGatewayV2 {
|
|
|
3190
3067
|
*/
|
|
3191
3068
|
Name?: StringWithLengthBetween1And128;
|
|
3192
3069
|
/**
|
|
3193
|
-
*
|
|
3070
|
+
* This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.
|
|
3071
|
+
*/
|
|
3072
|
+
RouteKey?: SelectionKey;
|
|
3073
|
+
/**
|
|
3074
|
+
* 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.
|
|
3194
3075
|
*/
|
|
3195
3076
|
RouteSelectionExpression?: SelectionExpression;
|
|
3077
|
+
/**
|
|
3078
|
+
* This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.
|
|
3079
|
+
*/
|
|
3080
|
+
Target?: UriWithLengthBetween1And2048;
|
|
3196
3081
|
/**
|
|
3197
3082
|
* A version identifier for the API.
|
|
3198
3083
|
*/
|
|
@@ -3200,9 +3085,7 @@ declare namespace ApiGatewayV2 {
|
|
|
3200
3085
|
}
|
|
3201
3086
|
export interface UpdateApiResponse {
|
|
3202
3087
|
/**
|
|
3203
|
-
* The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The
|
|
3204
|
-
stage name is typically appended to this URI to form a complete path to a deployed
|
|
3205
|
-
API stage.
|
|
3088
|
+
* 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.
|
|
3206
3089
|
*/
|
|
3207
3090
|
ApiEndpoint?: __string;
|
|
3208
3091
|
/**
|
|
@@ -3210,9 +3093,13 @@ declare namespace ApiGatewayV2 {
|
|
|
3210
3093
|
*/
|
|
3211
3094
|
ApiId?: Id;
|
|
3212
3095
|
/**
|
|
3213
|
-
* An API key selection expression. See API Key Selection Expressions.
|
|
3096
|
+
* An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
|
|
3214
3097
|
*/
|
|
3215
3098
|
ApiKeySelectionExpression?: SelectionExpression;
|
|
3099
|
+
/**
|
|
3100
|
+
* A CORS configuration. Supported only for HTTP APIs.
|
|
3101
|
+
*/
|
|
3102
|
+
CorsConfiguration?: Cors;
|
|
3216
3103
|
/**
|
|
3217
3104
|
* The timestamp when the API was created.
|
|
3218
3105
|
*/
|
|
@@ -3222,34 +3109,37 @@ declare namespace ApiGatewayV2 {
|
|
|
3222
3109
|
*/
|
|
3223
3110
|
Description?: StringWithLengthBetween0And1024;
|
|
3224
3111
|
/**
|
|
3225
|
-
* Avoid validating models when creating a deployment.
|
|
3112
|
+
* Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
|
|
3226
3113
|
*/
|
|
3227
3114
|
DisableSchemaValidation?: __boolean;
|
|
3115
|
+
/**
|
|
3116
|
+
* The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
|
|
3117
|
+
*/
|
|
3118
|
+
ImportInfo?: __listOf__string;
|
|
3228
3119
|
/**
|
|
3229
3120
|
* The name of the API.
|
|
3230
3121
|
*/
|
|
3231
3122
|
Name?: StringWithLengthBetween1And128;
|
|
3232
3123
|
/**
|
|
3233
|
-
* The API protocol
|
|
3124
|
+
* The API protocol.
|
|
3234
3125
|
*/
|
|
3235
3126
|
ProtocolType?: ProtocolType;
|
|
3236
3127
|
/**
|
|
3237
|
-
* The route selection expression for the API.
|
|
3128
|
+
* 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.
|
|
3238
3129
|
*/
|
|
3239
3130
|
RouteSelectionExpression?: SelectionExpression;
|
|
3131
|
+
/**
|
|
3132
|
+
* A collection of tags associated with the API.
|
|
3133
|
+
*/
|
|
3134
|
+
Tags?: Tags;
|
|
3240
3135
|
/**
|
|
3241
3136
|
* A version identifier for the API.
|
|
3242
3137
|
*/
|
|
3243
3138
|
Version?: StringWithLengthBetween1And64;
|
|
3244
3139
|
/**
|
|
3245
|
-
* The warning messages reported when failonwarnings is turned on during
|
|
3246
|
-
API import.
|
|
3140
|
+
* The warning messages reported when failonwarnings is turned on during API import.
|
|
3247
3141
|
*/
|
|
3248
3142
|
Warnings?: __listOf__string;
|
|
3249
|
-
/**
|
|
3250
|
-
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
|
|
3251
|
-
*/
|
|
3252
|
-
Tags?: Tags;
|
|
3253
3143
|
}
|
|
3254
3144
|
export interface UpdateAuthorizerRequest {
|
|
3255
3145
|
/**
|
|
@@ -3257,10 +3147,7 @@ declare namespace ApiGatewayV2 {
|
|
|
3257
3147
|
*/
|
|
3258
3148
|
ApiId: __string;
|
|
3259
3149
|
/**
|
|
3260
|
-
* Specifies the required credentials as an IAM role for API Gateway to invoke the
|
|
3261
|
-
authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon
|
|
3262
|
-
Resource Name (ARN). To use resource-based permissions on the Lambda function,
|
|
3263
|
-
specify null.
|
|
3150
|
+
* Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
|
|
3264
3151
|
*/
|
|
3265
3152
|
AuthorizerCredentialsArn?: Arn;
|
|
3266
3153
|
/**
|
|
@@ -3268,69 +3155,38 @@ declare namespace ApiGatewayV2 {
|
|
|
3268
3155
|
*/
|
|
3269
3156
|
AuthorizerId: __string;
|
|
3270
3157
|
/**
|
|
3271
|
-
*
|
|
3272
|
-
authorization caching is disabled. If it is greater than zero, API Gateway will cache
|
|
3273
|
-
authorizer responses. If this field is not set, the default value is 300. The maximum
|
|
3274
|
-
value is 3600, or 1 hour.
|
|
3158
|
+
* Authorizer caching is not currently supported. Don't specify this value for authorizers.
|
|
3275
3159
|
*/
|
|
3276
3160
|
AuthorizerResultTtlInSeconds?: IntegerWithLengthBetween0And3600;
|
|
3277
3161
|
/**
|
|
3278
|
-
* The authorizer type.
|
|
3279
|
-
Lambda function using incoming request parameters.
|
|
3162
|
+
* The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
|
|
3280
3163
|
*/
|
|
3281
3164
|
AuthorizerType?: AuthorizerType;
|
|
3282
3165
|
/**
|
|
3283
|
-
* The authorizer's Uniform Resource Identifier (URI). For
|
|
3284
|
-
|
|
3285
|
-
well-formed Lambda function URI, for example,
|
|
3286
|
-
arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations.
|
|
3287
|
-
In general, the URI has this form:
|
|
3288
|
-
arn:aws:apigateway:{region}:lambda:path/{service_api}
|
|
3289
|
-
, where {region} is the same as the region hosting the Lambda
|
|
3290
|
-
function, path indicates that the remaining substring in the URI should be treated as
|
|
3291
|
-
the path to the resource, including the initial /. For Lambda functions,
|
|
3292
|
-
this is usually of the form
|
|
3293
|
-
/2015-03-31/functions/[FunctionARN]/invocations.
|
|
3166
|
+
* 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:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}
|
|
3167
|
+
, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.
|
|
3294
3168
|
*/
|
|
3295
3169
|
AuthorizerUri?: UriWithLengthBetween1And2048;
|
|
3296
3170
|
/**
|
|
3297
|
-
* The identity source for which authorization is requested.For
|
|
3298
|
-
caching is enabled. The value is a comma-separated string of one or more mapping
|
|
3299
|
-
expressions of the specified request parameters. For example, if an Auth header, a
|
|
3300
|
-
Name query string parameter are defined as identity sources, this value is
|
|
3301
|
-
$method.request.header.Auth, $method.request.querystring.Name. These
|
|
3302
|
-
parameters will be used to derive the authorization caching key and to perform
|
|
3303
|
-
runtime validation of the REQUEST authorizer by verifying all of the
|
|
3304
|
-
identity-related request parameters are present, not null and non-empty. Only when
|
|
3305
|
-
this is true does the authorizer invoke the authorizer Lambda function, otherwise, it
|
|
3306
|
-
returns a 401 Unauthorized response without calling the Lambda function.
|
|
3307
|
-
The valid value is a string of comma-separated mapping expressions of the specified
|
|
3308
|
-
request parameters. When the authorization caching is not enabled, this property is
|
|
3309
|
-
optional.
|
|
3171
|
+
* The identity source for which authorization is requested. For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example "$request.header.Authorization".
|
|
3310
3172
|
*/
|
|
3311
3173
|
IdentitySource?: IdentitySourceList;
|
|
3312
3174
|
/**
|
|
3313
|
-
*
|
|
3314
|
-
validation expression does not apply to the REQUEST authorizer.
|
|
3175
|
+
* This parameter is not used.
|
|
3315
3176
|
*/
|
|
3316
3177
|
IdentityValidationExpression?: StringWithLengthBetween0And1024;
|
|
3317
3178
|
/**
|
|
3318
|
-
*
|
|
3179
|
+
* Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
|
|
3319
3180
|
*/
|
|
3320
|
-
|
|
3181
|
+
JwtConfiguration?: JWTConfiguration;
|
|
3321
3182
|
/**
|
|
3322
|
-
*
|
|
3323
|
-
REQUEST authorizer, this is not
|
|
3324
|
-
defined.
|
|
3183
|
+
* The name of the authorizer.
|
|
3325
3184
|
*/
|
|
3326
|
-
|
|
3185
|
+
Name?: StringWithLengthBetween1And128;
|
|
3327
3186
|
}
|
|
3328
3187
|
export interface UpdateAuthorizerResponse {
|
|
3329
3188
|
/**
|
|
3330
|
-
* Specifies the required credentials as an IAM role for API Gateway to invoke the
|
|
3331
|
-
authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon
|
|
3332
|
-
Resource Name (ARN). To use resource-based permissions on the Lambda function,
|
|
3333
|
-
specify null.
|
|
3189
|
+
* Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.
|
|
3334
3190
|
*/
|
|
3335
3191
|
AuthorizerCredentialsArn?: Arn;
|
|
3336
3192
|
/**
|
|
@@ -3338,63 +3194,34 @@ declare namespace ApiGatewayV2 {
|
|
|
3338
3194
|
*/
|
|
3339
3195
|
AuthorizerId?: Id;
|
|
3340
3196
|
/**
|
|
3341
|
-
*
|
|
3342
|
-
authorization caching is disabled. If it is greater than 0, API Gateway will cache
|
|
3343
|
-
authorizer responses. If this field is not set, the default value is 300. The maximum
|
|
3344
|
-
value is 3600, or 1 hour.
|
|
3197
|
+
* Authorizer caching is not currently supported. Don't specify this value for authorizers.
|
|
3345
3198
|
*/
|
|
3346
3199
|
AuthorizerResultTtlInSeconds?: IntegerWithLengthBetween0And3600;
|
|
3347
3200
|
/**
|
|
3348
|
-
* The authorizer type.
|
|
3349
|
-
Lambda function using incoming request parameters.
|
|
3201
|
+
* The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
|
|
3350
3202
|
*/
|
|
3351
3203
|
AuthorizerType?: AuthorizerType;
|
|
3352
3204
|
/**
|
|
3353
|
-
* The authorizer's Uniform Resource Identifier (URI).
|
|
3354
|
-
|
|
3355
|
-
well-formed Lambda function URI, for example,
|
|
3356
|
-
arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations.
|
|
3357
|
-
In general, the URI has this form:
|
|
3358
|
-
arn:aws:apigateway:{region}:lambda:path/{service_api}
|
|
3359
|
-
, where {region} is the same as the region hosting the Lambda
|
|
3360
|
-
function, path indicates that the remaining substring in the URI should be treated as
|
|
3361
|
-
the path to the resource, including the initial /. For Lambda functions,
|
|
3362
|
-
this is usually of the form
|
|
3363
|
-
/2015-03-31/functions/[FunctionARN]/invocations.
|
|
3205
|
+
* The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}
|
|
3206
|
+
, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.
|
|
3364
3207
|
*/
|
|
3365
3208
|
AuthorizerUri?: UriWithLengthBetween1And2048;
|
|
3366
3209
|
/**
|
|
3367
|
-
* The identity source for which authorization is requested.For
|
|
3368
|
-
caching is enabled. The value is a comma-separated string of one or more mapping
|
|
3369
|
-
expressions of the specified request parameters. For example, if an Auth
|
|
3370
|
-
header and a Name query string parameters are defined as identity
|
|
3371
|
-
sources, this value is method.request.header.Auth,
|
|
3372
|
-
method.request.querystring.Name. These parameters will be used to
|
|
3373
|
-
derive the authorization caching key and to perform runtime validation of the
|
|
3374
|
-
REQUEST authorizer by verifying all of the identity-related request
|
|
3375
|
-
parameters are present, not null, and non-empty. Only when this is true does the
|
|
3376
|
-
authorizer invoke the authorizer Lambda function, otherwise, it returns a 401
|
|
3377
|
-
Unauthorized response without calling the Lambda function. The valid value
|
|
3378
|
-
is a string of comma-separated mapping expressions of the specified request
|
|
3379
|
-
parameters. When the authorization caching is not enabled, this property is
|
|
3380
|
-
optional.
|
|
3210
|
+
* The identity source for which authorization is requested. For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example "$request.header.Authorization".
|
|
3381
3211
|
*/
|
|
3382
3212
|
IdentitySource?: IdentitySourceList;
|
|
3383
3213
|
/**
|
|
3384
|
-
* The
|
|
3385
|
-
validation expression does not apply to the REQUEST authorizer.
|
|
3214
|
+
* The validation expression does not apply to the REQUEST authorizer.
|
|
3386
3215
|
*/
|
|
3387
3216
|
IdentityValidationExpression?: StringWithLengthBetween0And1024;
|
|
3388
3217
|
/**
|
|
3389
|
-
*
|
|
3218
|
+
* Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
|
|
3390
3219
|
*/
|
|
3391
|
-
|
|
3220
|
+
JwtConfiguration?: JWTConfiguration;
|
|
3392
3221
|
/**
|
|
3393
|
-
*
|
|
3394
|
-
REQUEST authorizer, this is not
|
|
3395
|
-
defined.
|
|
3222
|
+
* The name of the authorizer.
|
|
3396
3223
|
*/
|
|
3397
|
-
|
|
3224
|
+
Name?: StringWithLengthBetween1And128;
|
|
3398
3225
|
}
|
|
3399
3226
|
export interface UpdateDeploymentRequest {
|
|
3400
3227
|
/**
|
|
@@ -3411,6 +3238,10 @@ declare namespace ApiGatewayV2 {
|
|
|
3411
3238
|
Description?: StringWithLengthBetween0And1024;
|
|
3412
3239
|
}
|
|
3413
3240
|
export interface UpdateDeploymentResponse {
|
|
3241
|
+
/**
|
|
3242
|
+
* Specifies whether a deployment was automatically released.
|
|
3243
|
+
*/
|
|
3244
|
+
AutoDeployed?: __boolean;
|
|
3414
3245
|
/**
|
|
3415
3246
|
* The date and time when the Deployment resource was created.
|
|
3416
3247
|
*/
|
|
@@ -3420,8 +3251,7 @@ declare namespace ApiGatewayV2 {
|
|
|
3420
3251
|
*/
|
|
3421
3252
|
DeploymentId?: Id;
|
|
3422
3253
|
/**
|
|
3423
|
-
* The status of the deployment: PENDING, FAILED, or
|
|
3424
|
-
SUCCEEDED.
|
|
3254
|
+
* The status of the deployment: PENDING, FAILED, or SUCCEEDED.
|
|
3425
3255
|
*/
|
|
3426
3256
|
DeploymentStatus?: DeploymentStatus;
|
|
3427
3257
|
/**
|
|
@@ -3457,7 +3287,7 @@ declare namespace ApiGatewayV2 {
|
|
|
3457
3287
|
*/
|
|
3458
3288
|
DomainNameConfigurations?: DomainNameConfigurations;
|
|
3459
3289
|
/**
|
|
3460
|
-
* The
|
|
3290
|
+
* The collection of tags associated with a domain name.
|
|
3461
3291
|
*/
|
|
3462
3292
|
Tags?: Tags;
|
|
3463
3293
|
}
|
|
@@ -3471,30 +3301,15 @@ declare namespace ApiGatewayV2 {
|
|
|
3471
3301
|
*/
|
|
3472
3302
|
ConnectionId?: StringWithLengthBetween1And1024;
|
|
3473
3303
|
/**
|
|
3474
|
-
* The type of the network connection to the integration endpoint. Currently the only
|
|
3475
|
-
valid value is INTERNET, for connections through the public routable
|
|
3476
|
-
internet.
|
|
3304
|
+
* The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
|
|
3477
3305
|
*/
|
|
3478
3306
|
ConnectionType?: ConnectionType;
|
|
3479
3307
|
/**
|
|
3480
|
-
* Specifies how to handle response payload content type conversions. Supported
|
|
3481
|
-
values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
|
|
3482
|
-
following behaviors:
|
|
3483
|
-
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded
|
|
3484
|
-
string to the corresponding binary blob.
|
|
3485
|
-
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a
|
|
3486
|
-
Base64-encoded string.If this property is not defined, the response payload will be passed through from
|
|
3487
|
-
the integration response to the route response or method response without
|
|
3488
|
-
modification.
|
|
3308
|
+
* 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: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
|
|
3489
3309
|
*/
|
|
3490
3310
|
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
3491
3311
|
/**
|
|
3492
|
-
* Specifies the credentials required for the integration, if any. For AWS
|
|
3493
|
-
integrations, three options are available. To specify an IAM Role for API Gateway to
|
|
3494
|
-
assume, use the role's Amazon Resource Name (ARN). To require that the caller's
|
|
3495
|
-
identity be passed through from the request, specify the string
|
|
3496
|
-
arn:aws:iam::*:user/*. To use resource-based permissions on supported
|
|
3497
|
-
AWS services, specify null.
|
|
3312
|
+
* Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
|
|
3498
3313
|
*/
|
|
3499
3314
|
CredentialsArn?: Arn;
|
|
3500
3315
|
/**
|
|
@@ -3510,23 +3325,7 @@ declare namespace ApiGatewayV2 {
|
|
|
3510
3325
|
*/
|
|
3511
3326
|
IntegrationMethod?: StringWithLengthBetween1And64;
|
|
3512
3327
|
/**
|
|
3513
|
-
* The integration type of an integration. One of the following:
|
|
3514
|
-
AWS: for integrating the route or method request with an AWS service
|
|
3515
|
-
action, including the Lambda function-invoking action. With the Lambda
|
|
3516
|
-
function-invoking action, this is referred to as the Lambda custom integration. With
|
|
3517
|
-
any other AWS service action, this is known as AWS integration.
|
|
3518
|
-
AWS_PROXY: for integrating the route or method request with the Lambda
|
|
3519
|
-
function-invoking action with the client request passed through as-is. This
|
|
3520
|
-
integration is also referred to as Lambda proxy integration.
|
|
3521
|
-
HTTP: for integrating the route or method request with an HTTP
|
|
3522
|
-
endpoint. This
|
|
3523
|
-
integration is also referred to as the HTTP custom integration.
|
|
3524
|
-
HTTP_PROXY: for integrating route or method request with an HTTP
|
|
3525
|
-
endpoint, with the client
|
|
3526
|
-
request passed through as-is. This is also referred to as HTTP proxy
|
|
3527
|
-
integration.
|
|
3528
|
-
MOCK: for integrating the route or method request with API Gateway as a
|
|
3529
|
-
"loopback" endpoint without invoking any backend.
|
|
3328
|
+
* The integration type of an integration. One of the following: AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs. AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration. HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs. HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
|
|
3530
3329
|
*/
|
|
3531
3330
|
IntegrationType?: IntegrationType;
|
|
3532
3331
|
/**
|
|
@@ -3534,40 +3333,24 @@ declare namespace ApiGatewayV2 {
|
|
|
3534
3333
|
*/
|
|
3535
3334
|
IntegrationUri?: UriWithLengthBetween1And2048;
|
|
3536
3335
|
/**
|
|
3537
|
-
* Specifies the pass-through behavior for incoming requests based on the
|
|
3538
|
-
Content-Type header in the request, and the available mapping
|
|
3539
|
-
templates specified as the requestTemplates property on the
|
|
3540
|
-
Integration resource. There are three valid values:
|
|
3541
|
-
WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
|
|
3542
|
-
NEVER.
|
|
3543
|
-
WHEN_NO_MATCH passes the request body for unmapped content types through
|
|
3544
|
-
to the integration backend without transformation.
|
|
3545
|
-
NEVER rejects unmapped content types with an HTTP 415 Unsupported
|
|
3546
|
-
Media Type response.
|
|
3547
|
-
WHEN_NO_TEMPLATES allows pass-through when the integration has no
|
|
3548
|
-
content types mapped to templates. However, if there is at least one content type
|
|
3549
|
-
defined, unmapped content types will be rejected with the same HTTP 415
|
|
3550
|
-
Unsupported Media Type response.
|
|
3336
|
+
* Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation. NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response. WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
|
|
3551
3337
|
*/
|
|
3552
3338
|
PassthroughBehavior?: PassthroughBehavior;
|
|
3553
3339
|
/**
|
|
3554
|
-
*
|
|
3555
|
-
|
|
3556
|
-
|
|
3557
|
-
|
|
3558
|
-
request parameter value must match the pattern of
|
|
3559
|
-
|
|
3560
|
-
|
|
3561
|
-
|
|
3562
|
-
|
|
3563
|
-
|
|
3564
|
-
must be a valid and unique method request parameter name.
|
|
3340
|
+
* Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.
|
|
3341
|
+
*/
|
|
3342
|
+
PayloadFormatVersion?: StringWithLengthBetween1And64;
|
|
3343
|
+
/**
|
|
3344
|
+
* 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.{location}.{name}
|
|
3345
|
+
, where
|
|
3346
|
+
{location}
|
|
3347
|
+
is querystring, path, or header; and
|
|
3348
|
+
{name}
|
|
3349
|
+
must be a valid and unique method request parameter name. Supported only for WebSocket APIs.
|
|
3565
3350
|
*/
|
|
3566
3351
|
RequestParameters?: IntegrationParameters;
|
|
3567
3352
|
/**
|
|
3568
|
-
* Represents a map of Velocity templates that are applied on the request payload
|
|
3569
|
-
based on the value of the Content-Type header sent by the client. The content type
|
|
3570
|
-
value is the key in this map, and the template (as a String) is the value.
|
|
3353
|
+
* Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
|
|
3571
3354
|
*/
|
|
3572
3355
|
RequestTemplates?: TemplateMap;
|
|
3573
3356
|
/**
|
|
@@ -3575,41 +3358,29 @@ declare namespace ApiGatewayV2 {
|
|
|
3575
3358
|
*/
|
|
3576
3359
|
TemplateSelectionExpression?: SelectionExpression;
|
|
3577
3360
|
/**
|
|
3578
|
-
* Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000
|
|
3579
|
-
milliseconds or 29 seconds.
|
|
3361
|
+
* Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
|
|
3580
3362
|
*/
|
|
3581
3363
|
TimeoutInMillis?: IntegerWithLengthBetween50And29000;
|
|
3582
3364
|
}
|
|
3583
|
-
export interface
|
|
3365
|
+
export interface UpdateIntegrationResult {
|
|
3366
|
+
/**
|
|
3367
|
+
* 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.
|
|
3368
|
+
*/
|
|
3369
|
+
ApiGatewayManaged?: __boolean;
|
|
3584
3370
|
/**
|
|
3585
3371
|
* The connection ID.
|
|
3586
3372
|
*/
|
|
3587
3373
|
ConnectionId?: StringWithLengthBetween1And1024;
|
|
3588
3374
|
/**
|
|
3589
|
-
* The type of the network connection to the integration endpoint. Currently the only
|
|
3590
|
-
valid value is INTERNET, for connections through the public routable
|
|
3591
|
-
internet.
|
|
3375
|
+
* The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
|
|
3592
3376
|
*/
|
|
3593
3377
|
ConnectionType?: ConnectionType;
|
|
3594
3378
|
/**
|
|
3595
|
-
* Specifies how to handle response payload content type conversions. Supported
|
|
3596
|
-
values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
|
|
3597
|
-
following behaviors:
|
|
3598
|
-
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded
|
|
3599
|
-
string to the corresponding binary blob.
|
|
3600
|
-
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a
|
|
3601
|
-
Base64-encoded string.If this property is not defined, the response payload will be passed through from
|
|
3602
|
-
the integration response to the route response or method response without
|
|
3603
|
-
modification.
|
|
3379
|
+
* 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: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
|
|
3604
3380
|
*/
|
|
3605
3381
|
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
3606
3382
|
/**
|
|
3607
|
-
* Specifies the credentials required for the integration, if any. For AWS
|
|
3608
|
-
integrations, three options are available. To specify an IAM Role for API Gateway to
|
|
3609
|
-
assume, use the role's Amazon Resource Name (ARN). To require that the caller's
|
|
3610
|
-
identity be passed through from the request, specify the string
|
|
3611
|
-
arn:aws:iam::*:user/*. To use resource-based permissions on supported
|
|
3612
|
-
AWS services, specify null.
|
|
3383
|
+
* Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
|
|
3613
3384
|
*/
|
|
3614
3385
|
CredentialsArn?: Arn;
|
|
3615
3386
|
/**
|
|
@@ -3625,27 +3396,11 @@ declare namespace ApiGatewayV2 {
|
|
|
3625
3396
|
*/
|
|
3626
3397
|
IntegrationMethod?: StringWithLengthBetween1And64;
|
|
3627
3398
|
/**
|
|
3628
|
-
* The integration response selection expression for the integration. See Integration Response Selection Expressions.
|
|
3399
|
+
* The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
|
|
3629
3400
|
*/
|
|
3630
3401
|
IntegrationResponseSelectionExpression?: SelectionExpression;
|
|
3631
3402
|
/**
|
|
3632
|
-
* The integration type of an integration. One of the following:
|
|
3633
|
-
AWS: for integrating the route or method request with an AWS service
|
|
3634
|
-
action, including the Lambda function-invoking action. With the Lambda
|
|
3635
|
-
function-invoking action, this is referred to as the Lambda custom integration. With
|
|
3636
|
-
any other AWS service action, this is known as AWS integration.
|
|
3637
|
-
AWS_PROXY: for integrating the route or method request with the Lambda
|
|
3638
|
-
function-invoking action with the client request passed through as-is. This
|
|
3639
|
-
integration is also referred to as Lambda proxy integration.
|
|
3640
|
-
HTTP: for integrating the route or method request with an HTTP
|
|
3641
|
-
endpoint. This
|
|
3642
|
-
integration is also referred to as the HTTP custom integration.
|
|
3643
|
-
HTTP_PROXY: for integrating route or method request with an HTTP
|
|
3644
|
-
endpoint, with the client
|
|
3645
|
-
request passed through as-is. This is also referred to as HTTP proxy
|
|
3646
|
-
integration.
|
|
3647
|
-
MOCK: for integrating the route or method request with API Gateway as a
|
|
3648
|
-
"loopback" endpoint without invoking any backend.
|
|
3403
|
+
* The integration type of an integration. One of the following: AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs. AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration. HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs. HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
|
|
3649
3404
|
*/
|
|
3650
3405
|
IntegrationType?: IntegrationType;
|
|
3651
3406
|
/**
|
|
@@ -3653,49 +3408,32 @@ declare namespace ApiGatewayV2 {
|
|
|
3653
3408
|
*/
|
|
3654
3409
|
IntegrationUri?: UriWithLengthBetween1And2048;
|
|
3655
3410
|
/**
|
|
3656
|
-
* Specifies the pass-through behavior for incoming requests based on the
|
|
3657
|
-
Content-Type header in the request, and the available mapping
|
|
3658
|
-
templates specified as the requestTemplates property on the
|
|
3659
|
-
Integration resource. There are three valid values:
|
|
3660
|
-
WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
|
|
3661
|
-
NEVER.
|
|
3662
|
-
WHEN_NO_MATCH passes the request body for unmapped content types through
|
|
3663
|
-
to the integration backend without transformation.
|
|
3664
|
-
NEVER rejects unmapped content types with an HTTP 415 Unsupported
|
|
3665
|
-
Media Type response.
|
|
3666
|
-
WHEN_NO_TEMPLATES allows pass-through when the integration has no
|
|
3667
|
-
content types mapped to templates. However, if there is at least one content type
|
|
3668
|
-
defined, unmapped content types will be rejected with the same HTTP 415
|
|
3669
|
-
Unsupported Media Type response.
|
|
3411
|
+
* Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation. NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response. WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
|
|
3670
3412
|
*/
|
|
3671
3413
|
PassthroughBehavior?: PassthroughBehavior;
|
|
3672
3414
|
/**
|
|
3673
|
-
*
|
|
3674
|
-
|
|
3675
|
-
|
|
3676
|
-
|
|
3677
|
-
request parameter value must match the pattern of
|
|
3678
|
-
|
|
3679
|
-
|
|
3680
|
-
|
|
3681
|
-
|
|
3682
|
-
|
|
3683
|
-
must be a valid and unique method request parameter name.
|
|
3415
|
+
* Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.
|
|
3416
|
+
*/
|
|
3417
|
+
PayloadFormatVersion?: StringWithLengthBetween1And64;
|
|
3418
|
+
/**
|
|
3419
|
+
* 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.{location}.{name}
|
|
3420
|
+
, where
|
|
3421
|
+
{location}
|
|
3422
|
+
is querystring, path, or header; and
|
|
3423
|
+
{name}
|
|
3424
|
+
must be a valid and unique method request parameter name. Supported only for WebSocket APIs.
|
|
3684
3425
|
*/
|
|
3685
3426
|
RequestParameters?: IntegrationParameters;
|
|
3686
3427
|
/**
|
|
3687
|
-
* Represents a map of Velocity templates that are applied on the request payload
|
|
3688
|
-
based on the value of the Content-Type header sent by the client. The content type
|
|
3689
|
-
value is the key in this map, and the template (as a String) is the value.
|
|
3428
|
+
* Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
|
|
3690
3429
|
*/
|
|
3691
3430
|
RequestTemplates?: TemplateMap;
|
|
3692
3431
|
/**
|
|
3693
|
-
* The template selection expression for the integration.
|
|
3432
|
+
* The template selection expression for the integration. Supported only for WebSocket APIs.
|
|
3694
3433
|
*/
|
|
3695
3434
|
TemplateSelectionExpression?: SelectionExpression;
|
|
3696
3435
|
/**
|
|
3697
|
-
* Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000
|
|
3698
|
-
milliseconds or 29 seconds.
|
|
3436
|
+
* Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
|
|
3699
3437
|
*/
|
|
3700
3438
|
TimeoutInMillis?: IntegerWithLengthBetween50And29000;
|
|
3701
3439
|
}
|
|
@@ -3705,15 +3443,7 @@ declare namespace ApiGatewayV2 {
|
|
|
3705
3443
|
*/
|
|
3706
3444
|
ApiId: __string;
|
|
3707
3445
|
/**
|
|
3708
|
-
* Specifies how to handle response payload content type conversions. Supported
|
|
3709
|
-
values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
|
|
3710
|
-
following behaviors:
|
|
3711
|
-
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded
|
|
3712
|
-
string to the corresponding binary blob.
|
|
3713
|
-
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a
|
|
3714
|
-
Base64-encoded string.If this property is not defined, the response payload will be passed through from
|
|
3715
|
-
the integration response to the route response or method response without
|
|
3716
|
-
modification.
|
|
3446
|
+
* 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: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
|
|
3717
3447
|
*/
|
|
3718
3448
|
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
3719
3449
|
/**
|
|
@@ -3729,46 +3459,28 @@ declare namespace ApiGatewayV2 {
|
|
|
3729
3459
|
*/
|
|
3730
3460
|
IntegrationResponseKey?: SelectionKey;
|
|
3731
3461
|
/**
|
|
3732
|
-
* A key-value map specifying response parameters that are passed to the method
|
|
3733
|
-
|
|
3734
|
-
|
|
3735
|
-
|
|
3736
|
-
|
|
3737
|
-
|
|
3738
|
-
|
|
3739
|
-
|
|
3740
|
-
integration.response.header.{name}
|
|
3741
|
-
or
|
|
3742
|
-
integration.response.body.{JSON-expression}
|
|
3743
|
-
, where
|
|
3744
|
-
{name}
|
|
3745
|
-
is a valid and unique response header name and
|
|
3746
|
-
{JSON-expression}
|
|
3747
|
-
is a valid JSON expression without the $ prefix.
|
|
3462
|
+
* 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}
|
|
3463
|
+
, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name}
|
|
3464
|
+
or integration.response.body.{JSON-expression}
|
|
3465
|
+
, where
|
|
3466
|
+
{name}
|
|
3467
|
+
is a valid and unique response header name and
|
|
3468
|
+
{JSON-expression}
|
|
3469
|
+
is a valid JSON expression without the $ prefix.
|
|
3748
3470
|
*/
|
|
3749
3471
|
ResponseParameters?: IntegrationParameters;
|
|
3750
3472
|
/**
|
|
3751
|
-
* The collection of response templates for the integration response as a
|
|
3752
|
-
string-to-string map of key-value pairs. Response templates are represented as a
|
|
3753
|
-
key/value map, with a content-type as the key and a template as the value.
|
|
3473
|
+
* The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
|
|
3754
3474
|
*/
|
|
3755
3475
|
ResponseTemplates?: TemplateMap;
|
|
3756
3476
|
/**
|
|
3757
|
-
* The template selection expression for the integration response.
|
|
3477
|
+
* The template selection expression for the integration response. Supported only for WebSocket APIs.
|
|
3758
3478
|
*/
|
|
3759
3479
|
TemplateSelectionExpression?: SelectionExpression;
|
|
3760
3480
|
}
|
|
3761
3481
|
export interface UpdateIntegrationResponseResponse {
|
|
3762
3482
|
/**
|
|
3763
|
-
* Specifies how to handle response payload content type conversions. Supported
|
|
3764
|
-
values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
|
|
3765
|
-
following behaviors:
|
|
3766
|
-
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded
|
|
3767
|
-
string to the corresponding binary blob.
|
|
3768
|
-
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a
|
|
3769
|
-
Base64-encoded string.If this property is not defined, the response payload will be passed through from
|
|
3770
|
-
the integration response to the route response or method response without
|
|
3771
|
-
modification.
|
|
3483
|
+
* 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: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
|
|
3772
3484
|
*/
|
|
3773
3485
|
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
3774
3486
|
/**
|
|
@@ -3780,21 +3492,11 @@ declare namespace ApiGatewayV2 {
|
|
|
3780
3492
|
*/
|
|
3781
3493
|
IntegrationResponseKey?: SelectionKey;
|
|
3782
3494
|
/**
|
|
3783
|
-
* A key-value map specifying response parameters that are passed to the method
|
|
3784
|
-
response from the backend. The key is a method response header parameter name and the
|
|
3785
|
-
mapped value is an integration response header value, a static value enclosed within
|
|
3786
|
-
a pair of single quotes, or a JSON expression from the integration response body. The
|
|
3787
|
-
mapping key must match the pattern of method.response.header.{name}, where name is a
|
|
3788
|
-
valid and unique header name. The mapped non-static value must match the pattern of
|
|
3789
|
-
integration.response.header.{name} or integration.response.body.{JSON-expression},
|
|
3790
|
-
where name is a valid and unique response header name and JSON-expression is a valid
|
|
3791
|
-
JSON expression without the $ prefix.
|
|
3495
|
+
* 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.
|
|
3792
3496
|
*/
|
|
3793
3497
|
ResponseParameters?: IntegrationParameters;
|
|
3794
3498
|
/**
|
|
3795
|
-
* The collection of response templates for the integration response as a
|
|
3796
|
-
string-to-string map of key-value pairs. Response templates are represented as a
|
|
3797
|
-
key/value map, with a content-type as the key and a template as the value.
|
|
3499
|
+
* The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
|
|
3798
3500
|
*/
|
|
3799
3501
|
ResponseTemplates?: TemplateMap;
|
|
3800
3502
|
/**
|
|
@@ -3824,8 +3526,7 @@ declare namespace ApiGatewayV2 {
|
|
|
3824
3526
|
*/
|
|
3825
3527
|
Name?: StringWithLengthBetween1And128;
|
|
3826
3528
|
/**
|
|
3827
|
-
* The schema for the model. For application/json models, this should be JSON schema
|
|
3828
|
-
draft 4 model.
|
|
3529
|
+
* The schema for the model. For application/json models, this should be JSON schema draft 4 model.
|
|
3829
3530
|
*/
|
|
3830
3531
|
Schema?: StringWithLengthBetween0And32K;
|
|
3831
3532
|
}
|
|
@@ -3847,8 +3548,7 @@ declare namespace ApiGatewayV2 {
|
|
|
3847
3548
|
*/
|
|
3848
3549
|
Name?: StringWithLengthBetween1And128;
|
|
3849
3550
|
/**
|
|
3850
|
-
* The schema for the model. For application/json models, this should be JSON schema
|
|
3851
|
-
draft 4 model.
|
|
3551
|
+
* The schema for the model. For application/json models, this should be JSON schema draft 4 model.
|
|
3852
3552
|
*/
|
|
3853
3553
|
Schema?: StringWithLengthBetween0And32K;
|
|
3854
3554
|
}
|
|
@@ -3858,30 +3558,23 @@ declare namespace ApiGatewayV2 {
|
|
|
3858
3558
|
*/
|
|
3859
3559
|
ApiId: __string;
|
|
3860
3560
|
/**
|
|
3861
|
-
* Specifies whether an API key is required for the route.
|
|
3561
|
+
* Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
|
|
3862
3562
|
*/
|
|
3863
3563
|
ApiKeyRequired?: __boolean;
|
|
3864
3564
|
/**
|
|
3865
|
-
* The authorization scopes supported by this
|
|
3866
|
-
route.
|
|
3565
|
+
* The authorization scopes supported by this route.
|
|
3867
3566
|
*/
|
|
3868
3567
|
AuthorizationScopes?: AuthorizationScopes;
|
|
3869
3568
|
/**
|
|
3870
|
-
* The authorization type for the route.
|
|
3871
|
-
access, AWS_IAM for using AWS IAM permissions, and CUSTOM
|
|
3872
|
-
for using a Lambda
|
|
3873
|
-
authorizer.
|
|
3569
|
+
* The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.
|
|
3874
3570
|
*/
|
|
3875
3571
|
AuthorizationType?: AuthorizationType;
|
|
3876
3572
|
/**
|
|
3877
|
-
* The identifier of the Authorizer resource to be associated with this
|
|
3878
|
-
route, if the authorizationType is CUSTOM
|
|
3879
|
-
. The authorizer identifier is generated by API Gateway
|
|
3880
|
-
when you created the authorizer.
|
|
3573
|
+
* The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
|
|
3881
3574
|
*/
|
|
3882
3575
|
AuthorizerId?: Id;
|
|
3883
3576
|
/**
|
|
3884
|
-
* The model selection expression for the route.
|
|
3577
|
+
* The model selection expression for the route. Supported only for WebSocket APIs.
|
|
3885
3578
|
*/
|
|
3886
3579
|
ModelSelectionExpression?: SelectionExpression;
|
|
3887
3580
|
/**
|
|
@@ -3889,11 +3582,11 @@ declare namespace ApiGatewayV2 {
|
|
|
3889
3582
|
*/
|
|
3890
3583
|
OperationName?: StringWithLengthBetween1And64;
|
|
3891
3584
|
/**
|
|
3892
|
-
* The request models for the route.
|
|
3585
|
+
* The request models for the route. Supported only for WebSocket APIs.
|
|
3893
3586
|
*/
|
|
3894
3587
|
RequestModels?: RouteModels;
|
|
3895
3588
|
/**
|
|
3896
|
-
* The request parameters for the route.
|
|
3589
|
+
* The request parameters for the route. Supported only for WebSocket APIs.
|
|
3897
3590
|
*/
|
|
3898
3591
|
RequestParameters?: RouteParameters;
|
|
3899
3592
|
/**
|
|
@@ -3905,7 +3598,7 @@ declare namespace ApiGatewayV2 {
|
|
|
3905
3598
|
*/
|
|
3906
3599
|
RouteKey?: SelectionKey;
|
|
3907
3600
|
/**
|
|
3908
|
-
* The route response selection expression for the route.
|
|
3601
|
+
* The route response selection expression for the route. Supported only for WebSocket APIs.
|
|
3909
3602
|
*/
|
|
3910
3603
|
RouteResponseSelectionExpression?: SelectionExpression;
|
|
3911
3604
|
/**
|
|
@@ -3913,37 +3606,29 @@ declare namespace ApiGatewayV2 {
|
|
|
3913
3606
|
*/
|
|
3914
3607
|
Target?: StringWithLengthBetween1And128;
|
|
3915
3608
|
}
|
|
3916
|
-
export interface
|
|
3609
|
+
export interface UpdateRouteResult {
|
|
3917
3610
|
/**
|
|
3918
|
-
* Specifies whether an API
|
|
3611
|
+
* 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.
|
|
3612
|
+
*/
|
|
3613
|
+
ApiGatewayManaged?: __boolean;
|
|
3614
|
+
/**
|
|
3615
|
+
* Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
|
|
3919
3616
|
*/
|
|
3920
3617
|
ApiKeyRequired?: __boolean;
|
|
3921
3618
|
/**
|
|
3922
|
-
* A list of authorization scopes configured on a route. The scopes are used with a
|
|
3923
|
-
COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization
|
|
3924
|
-
works by matching the route scopes against the scopes parsed from the access token in
|
|
3925
|
-
the incoming request. The method invocation is authorized if any route scope matches
|
|
3926
|
-
a claimed scope in the access token. Otherwise, the invocation is not authorized.
|
|
3927
|
-
When the route scope is configured, the client must provide an access token instead
|
|
3928
|
-
of an identity token for authorization purposes.
|
|
3619
|
+
* A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
|
|
3929
3620
|
*/
|
|
3930
3621
|
AuthorizationScopes?: AuthorizationScopes;
|
|
3931
3622
|
/**
|
|
3932
|
-
* The authorization type for the route.
|
|
3933
|
-
access, AWS_IAM for using AWS IAM permissions, and CUSTOM
|
|
3934
|
-
for using a Lambda
|
|
3935
|
-
authorizer
|
|
3623
|
+
* The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.
|
|
3936
3624
|
*/
|
|
3937
3625
|
AuthorizationType?: AuthorizationType;
|
|
3938
3626
|
/**
|
|
3939
|
-
* The identifier of the Authorizer resource to be associated with this
|
|
3940
|
-
route, if the authorizationType is CUSTOM
|
|
3941
|
-
. The authorizer identifier is generated by API Gateway
|
|
3942
|
-
when you created the authorizer.
|
|
3627
|
+
* The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
|
|
3943
3628
|
*/
|
|
3944
3629
|
AuthorizerId?: Id;
|
|
3945
3630
|
/**
|
|
3946
|
-
* The model selection expression for the route.
|
|
3631
|
+
* The model selection expression for the route. Supported only for WebSocket APIs.
|
|
3947
3632
|
*/
|
|
3948
3633
|
ModelSelectionExpression?: SelectionExpression;
|
|
3949
3634
|
/**
|
|
@@ -3951,11 +3636,11 @@ declare namespace ApiGatewayV2 {
|
|
|
3951
3636
|
*/
|
|
3952
3637
|
OperationName?: StringWithLengthBetween1And64;
|
|
3953
3638
|
/**
|
|
3954
|
-
* The request models for the route.
|
|
3639
|
+
* The request models for the route. Supported only for WebSocket APIs.
|
|
3955
3640
|
*/
|
|
3956
3641
|
RequestModels?: RouteModels;
|
|
3957
3642
|
/**
|
|
3958
|
-
* The request parameters for the route.
|
|
3643
|
+
* The request parameters for the route. Supported only for WebSocket APIs.
|
|
3959
3644
|
*/
|
|
3960
3645
|
RequestParameters?: RouteParameters;
|
|
3961
3646
|
/**
|
|
@@ -3967,7 +3652,7 @@ declare namespace ApiGatewayV2 {
|
|
|
3967
3652
|
*/
|
|
3968
3653
|
RouteKey?: SelectionKey;
|
|
3969
3654
|
/**
|
|
3970
|
-
* The route response selection expression for the route.
|
|
3655
|
+
* The route response selection expression for the route. Supported only for WebSocket APIs.
|
|
3971
3656
|
*/
|
|
3972
3657
|
RouteResponseSelectionExpression?: SelectionExpression;
|
|
3973
3658
|
/**
|
|
@@ -3981,7 +3666,7 @@ declare namespace ApiGatewayV2 {
|
|
|
3981
3666
|
*/
|
|
3982
3667
|
ApiId: __string;
|
|
3983
3668
|
/**
|
|
3984
|
-
* The model selection expression for the route response.
|
|
3669
|
+
* The model selection expression for the route response. Supported only for WebSocket APIs.
|
|
3985
3670
|
*/
|
|
3986
3671
|
ModelSelectionExpression?: SelectionExpression;
|
|
3987
3672
|
/**
|
|
@@ -4007,7 +3692,7 @@ declare namespace ApiGatewayV2 {
|
|
|
4007
3692
|
}
|
|
4008
3693
|
export interface UpdateRouteResponseResponse {
|
|
4009
3694
|
/**
|
|
4010
|
-
* Represents the model selection expression of a route response.
|
|
3695
|
+
* Represents the model selection expression of a route response. Supported only for WebSocket APIs.
|
|
4011
3696
|
*/
|
|
4012
3697
|
ModelSelectionExpression?: SelectionExpression;
|
|
4013
3698
|
/**
|
|
@@ -4036,6 +3721,10 @@ declare namespace ApiGatewayV2 {
|
|
|
4036
3721
|
* The API identifier.
|
|
4037
3722
|
*/
|
|
4038
3723
|
ApiId: __string;
|
|
3724
|
+
/**
|
|
3725
|
+
* Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
|
|
3726
|
+
*/
|
|
3727
|
+
AutoDeploy?: __boolean;
|
|
4039
3728
|
/**
|
|
4040
3729
|
* The identifier of a client certificate for a Stage.
|
|
4041
3730
|
*/
|
|
@@ -4045,7 +3734,7 @@ declare namespace ApiGatewayV2 {
|
|
|
4045
3734
|
*/
|
|
4046
3735
|
DefaultRouteSettings?: RouteSettings;
|
|
4047
3736
|
/**
|
|
4048
|
-
* The deployment identifier for the API stage.
|
|
3737
|
+
* The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
|
|
4049
3738
|
*/
|
|
4050
3739
|
DeploymentId?: Id;
|
|
4051
3740
|
/**
|
|
@@ -4057,13 +3746,11 @@ declare namespace ApiGatewayV2 {
|
|
|
4057
3746
|
*/
|
|
4058
3747
|
RouteSettings?: RouteSettingsMap;
|
|
4059
3748
|
/**
|
|
4060
|
-
* The stage name.
|
|
3749
|
+
* The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
|
|
4061
3750
|
*/
|
|
4062
3751
|
StageName: __string;
|
|
4063
3752
|
/**
|
|
4064
|
-
* A map that defines the stage variables for a Stage. Variable names
|
|
4065
|
-
can have alphanumeric and underscore characters, and the values must match
|
|
4066
|
-
[A-Za-z0-9-._~:/?#&=,]+.
|
|
3753
|
+
* A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. Supported only for WebSocket APIs.
|
|
4067
3754
|
*/
|
|
4068
3755
|
StageVariables?: StageVariablesMap;
|
|
4069
3756
|
}
|
|
@@ -4073,7 +3760,15 @@ declare namespace ApiGatewayV2 {
|
|
|
4073
3760
|
*/
|
|
4074
3761
|
AccessLogSettings?: AccessLogSettings;
|
|
4075
3762
|
/**
|
|
4076
|
-
*
|
|
3763
|
+
* Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
|
|
3764
|
+
*/
|
|
3765
|
+
ApiGatewayManaged?: __boolean;
|
|
3766
|
+
/**
|
|
3767
|
+
* Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
|
|
3768
|
+
*/
|
|
3769
|
+
AutoDeploy?: __boolean;
|
|
3770
|
+
/**
|
|
3771
|
+
* The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
|
|
4077
3772
|
*/
|
|
4078
3773
|
ClientCertificateId?: Id;
|
|
4079
3774
|
/**
|
|
@@ -4085,20 +3780,23 @@ declare namespace ApiGatewayV2 {
|
|
|
4085
3780
|
*/
|
|
4086
3781
|
DefaultRouteSettings?: RouteSettings;
|
|
4087
3782
|
/**
|
|
4088
|
-
* The identifier of the Deployment that the Stage is
|
|
4089
|
-
associated with.
|
|
3783
|
+
* The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
|
|
4090
3784
|
*/
|
|
4091
3785
|
DeploymentId?: Id;
|
|
4092
3786
|
/**
|
|
4093
3787
|
* The description of the stage.
|
|
4094
3788
|
*/
|
|
4095
3789
|
Description?: StringWithLengthBetween0And1024;
|
|
3790
|
+
/**
|
|
3791
|
+
* Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
|
|
3792
|
+
*/
|
|
3793
|
+
LastDeploymentStatusMessage?: __string;
|
|
4096
3794
|
/**
|
|
4097
3795
|
* The timestamp when the stage was last updated.
|
|
4098
3796
|
*/
|
|
4099
3797
|
LastUpdatedDate?: __timestampIso8601;
|
|
4100
3798
|
/**
|
|
4101
|
-
* Route settings for the stage.
|
|
3799
|
+
* Route settings for the stage, by routeKey.
|
|
4102
3800
|
*/
|
|
4103
3801
|
RouteSettings?: RouteSettingsMap;
|
|
4104
3802
|
/**
|
|
@@ -4106,13 +3804,11 @@ declare namespace ApiGatewayV2 {
|
|
|
4106
3804
|
*/
|
|
4107
3805
|
StageName?: StringWithLengthBetween1And128;
|
|
4108
3806
|
/**
|
|
4109
|
-
* A map that defines the stage variables for a stage resource. Variable names can
|
|
4110
|
-
have alphanumeric and underscore characters, and the values must match
|
|
4111
|
-
[A-Za-z0-9-._~:/?#&=,]+.
|
|
3807
|
+
* A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. Supported only for WebSocket APIs.
|
|
4112
3808
|
*/
|
|
4113
3809
|
StageVariables?: StageVariablesMap;
|
|
4114
3810
|
/**
|
|
4115
|
-
* The
|
|
3811
|
+
* The collection of tags. Each tag element is associated with a given resource.
|
|
4116
3812
|
*/
|
|
4117
3813
|
Tags?: Tags;
|
|
4118
3814
|
}
|
|
@@ -4133,7 +3829,6 @@ declare namespace ApiGatewayV2 {
|
|
|
4133
3829
|
export type __listOfStage = Stage[];
|
|
4134
3830
|
export type __listOf__string = __string[];
|
|
4135
3831
|
export type __string = string;
|
|
4136
|
-
export type __mapOf__string = {[key: string]: __string};
|
|
4137
3832
|
export type __timestampIso8601 = Date;
|
|
4138
3833
|
/**
|
|
4139
3834
|
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
|