@aws-sdk/client-apigatewayv2 3.428.0 → 3.430.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +65 -65
- package/dist-types/ts3.4/models/models_0.d.ts +65 -65
- package/package.json +11 -11
|
@@ -112,7 +112,7 @@ export interface Api {
|
|
|
112
112
|
* @public
|
|
113
113
|
* <p>The API protocol.</p>
|
|
114
114
|
*/
|
|
115
|
-
ProtocolType: ProtocolType |
|
|
115
|
+
ProtocolType: ProtocolType | undefined;
|
|
116
116
|
/**
|
|
117
117
|
* @public
|
|
118
118
|
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
@@ -218,7 +218,7 @@ export interface Authorizer {
|
|
|
218
218
|
* @public
|
|
219
219
|
* <p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>
|
|
220
220
|
*/
|
|
221
|
-
AuthorizerType?: AuthorizerType
|
|
221
|
+
AuthorizerType?: AuthorizerType;
|
|
222
222
|
/**
|
|
223
223
|
* @public
|
|
224
224
|
* <p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>\{account_id\}</replaceable>:function:<replaceable>\{lambda_function_name\}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>\{region\}</replaceable>:lambda:path/<replaceable>\{service_api\}</replaceable>
|
|
@@ -288,7 +288,7 @@ export interface Deployment {
|
|
|
288
288
|
* @public
|
|
289
289
|
* <p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>
|
|
290
290
|
*/
|
|
291
|
-
DeploymentStatus?: DeploymentStatus
|
|
291
|
+
DeploymentStatus?: DeploymentStatus;
|
|
292
292
|
/**
|
|
293
293
|
* @public
|
|
294
294
|
* <p>May contain additional feedback on the status of an API deployment.</p>
|
|
@@ -367,7 +367,7 @@ export interface DomainNameConfiguration {
|
|
|
367
367
|
* @public
|
|
368
368
|
* <p>The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. 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.</p>
|
|
369
369
|
*/
|
|
370
|
-
DomainNameStatus?: DomainNameStatus
|
|
370
|
+
DomainNameStatus?: DomainNameStatus;
|
|
371
371
|
/**
|
|
372
372
|
* @public
|
|
373
373
|
* <p>An optional text message containing detailed information about status of the domain name migration.</p>
|
|
@@ -377,7 +377,7 @@ export interface DomainNameConfiguration {
|
|
|
377
377
|
* @public
|
|
378
378
|
* <p>The endpoint type.</p>
|
|
379
379
|
*/
|
|
380
|
-
EndpointType?: EndpointType
|
|
380
|
+
EndpointType?: EndpointType;
|
|
381
381
|
/**
|
|
382
382
|
* @public
|
|
383
383
|
* <p>The Amazon Route 53 Hosted Zone ID of the endpoint.</p>
|
|
@@ -387,7 +387,7 @@ export interface DomainNameConfiguration {
|
|
|
387
387
|
* @public
|
|
388
388
|
* <p>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.</p>
|
|
389
389
|
*/
|
|
390
|
-
SecurityPolicy?: SecurityPolicy
|
|
390
|
+
SecurityPolicy?: SecurityPolicy;
|
|
391
391
|
/**
|
|
392
392
|
* @public
|
|
393
393
|
* <p>The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn</p>
|
|
@@ -527,12 +527,12 @@ export interface Integration {
|
|
|
527
527
|
* @public
|
|
528
528
|
* <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
|
|
529
529
|
*/
|
|
530
|
-
ConnectionType?: ConnectionType
|
|
530
|
+
ConnectionType?: ConnectionType;
|
|
531
531
|
/**
|
|
532
532
|
* @public
|
|
533
533
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
534
534
|
*/
|
|
535
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
535
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
536
536
|
/**
|
|
537
537
|
* @public
|
|
538
538
|
* <p>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.</p>
|
|
@@ -567,7 +567,7 @@ export interface Integration {
|
|
|
567
567
|
* @public
|
|
568
568
|
* <p>The integration type of an integration. One of the following:</p> <p>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.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>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.</p> <p>HTTP_PROXY: for integrating the 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.</p> <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
|
|
569
569
|
*/
|
|
570
|
-
IntegrationType?: IntegrationType
|
|
570
|
+
IntegrationType?: IntegrationType;
|
|
571
571
|
/**
|
|
572
572
|
* @public
|
|
573
573
|
* <p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
|
|
@@ -577,7 +577,7 @@ export interface Integration {
|
|
|
577
577
|
* @public
|
|
578
578
|
* <p>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.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>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.</p>
|
|
579
579
|
*/
|
|
580
|
-
PassthroughBehavior?: PassthroughBehavior
|
|
580
|
+
PassthroughBehavior?: PassthroughBehavior;
|
|
581
581
|
/**
|
|
582
582
|
* @public
|
|
583
583
|
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
|
|
@@ -628,7 +628,7 @@ export interface IntegrationResponse {
|
|
|
628
628
|
* @public
|
|
629
629
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
630
630
|
*/
|
|
631
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
631
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
632
632
|
/**
|
|
633
633
|
* @public
|
|
634
634
|
* <p>The integration response ID.</p>
|
|
@@ -735,7 +735,7 @@ export interface Route {
|
|
|
735
735
|
* @public
|
|
736
736
|
* <p>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, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>
|
|
737
737
|
*/
|
|
738
|
-
AuthorizationType?: AuthorizationType
|
|
738
|
+
AuthorizationType?: AuthorizationType;
|
|
739
739
|
/**
|
|
740
740
|
* @public
|
|
741
741
|
* <p>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.</p>
|
|
@@ -861,7 +861,7 @@ export interface RouteSettings {
|
|
|
861
861
|
* @public
|
|
862
862
|
* <p>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.</p>
|
|
863
863
|
*/
|
|
864
|
-
LoggingLevel?: LoggingLevel
|
|
864
|
+
LoggingLevel?: LoggingLevel;
|
|
865
865
|
/**
|
|
866
866
|
* @public
|
|
867
867
|
* <p>Specifies the throttling burst limit.</p>
|
|
@@ -1014,7 +1014,7 @@ export interface VpcLink {
|
|
|
1014
1014
|
* @public
|
|
1015
1015
|
* <p>The status of the VPC link.</p>
|
|
1016
1016
|
*/
|
|
1017
|
-
VpcLinkStatus?: VpcLinkStatus
|
|
1017
|
+
VpcLinkStatus?: VpcLinkStatus;
|
|
1018
1018
|
/**
|
|
1019
1019
|
* @public
|
|
1020
1020
|
* <p>A message summarizing the cause of the status of the VPC link.</p>
|
|
@@ -1024,7 +1024,7 @@ export interface VpcLink {
|
|
|
1024
1024
|
* @public
|
|
1025
1025
|
* <p>The version of the VPC link.</p>
|
|
1026
1026
|
*/
|
|
1027
|
-
VpcLinkVersion?: VpcLinkVersion
|
|
1027
|
+
VpcLinkVersion?: VpcLinkVersion;
|
|
1028
1028
|
}
|
|
1029
1029
|
/**
|
|
1030
1030
|
* @public
|
|
@@ -1116,7 +1116,7 @@ export interface CreateApiRequest {
|
|
|
1116
1116
|
* @public
|
|
1117
1117
|
* <p>The API protocol.</p>
|
|
1118
1118
|
*/
|
|
1119
|
-
ProtocolType: ProtocolType |
|
|
1119
|
+
ProtocolType: ProtocolType | undefined;
|
|
1120
1120
|
/**
|
|
1121
1121
|
* @public
|
|
1122
1122
|
* <p>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.</p>
|
|
@@ -1206,7 +1206,7 @@ export interface CreateApiResponse {
|
|
|
1206
1206
|
* @public
|
|
1207
1207
|
* <p>The API protocol.</p>
|
|
1208
1208
|
*/
|
|
1209
|
-
ProtocolType?: ProtocolType
|
|
1209
|
+
ProtocolType?: ProtocolType;
|
|
1210
1210
|
/**
|
|
1211
1211
|
* @public
|
|
1212
1212
|
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
@@ -1352,7 +1352,7 @@ export interface CreateAuthorizerRequest {
|
|
|
1352
1352
|
* @public
|
|
1353
1353
|
* <p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>
|
|
1354
1354
|
*/
|
|
1355
|
-
AuthorizerType: AuthorizerType |
|
|
1355
|
+
AuthorizerType: AuthorizerType | undefined;
|
|
1356
1356
|
/**
|
|
1357
1357
|
* @public
|
|
1358
1358
|
* <p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>\{account_id\}</replaceable>:function:<replaceable>\{lambda_function_name\}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>\{region\}</replaceable>:lambda:path/<replaceable>\{service_api\}</replaceable>
|
|
@@ -1413,7 +1413,7 @@ export interface CreateAuthorizerResponse {
|
|
|
1413
1413
|
* @public
|
|
1414
1414
|
* <p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>
|
|
1415
1415
|
*/
|
|
1416
|
-
AuthorizerType?: AuthorizerType
|
|
1416
|
+
AuthorizerType?: AuthorizerType;
|
|
1417
1417
|
/**
|
|
1418
1418
|
* @public
|
|
1419
1419
|
* <p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>\{account_id\}</replaceable>:function:<replaceable>\{lambda_function_name\}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>\{region\}</replaceable>:lambda:path/<replaceable>\{service_api\}</replaceable>
|
|
@@ -1490,7 +1490,7 @@ export interface CreateDeploymentResponse {
|
|
|
1490
1490
|
* @public
|
|
1491
1491
|
* <p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>
|
|
1492
1492
|
*/
|
|
1493
|
-
DeploymentStatus?: DeploymentStatus
|
|
1493
|
+
DeploymentStatus?: DeploymentStatus;
|
|
1494
1494
|
/**
|
|
1495
1495
|
* @public
|
|
1496
1496
|
* <p>May contain additional feedback on the status of an API deployment.</p>
|
|
@@ -1603,12 +1603,12 @@ export interface CreateIntegrationRequest {
|
|
|
1603
1603
|
* @public
|
|
1604
1604
|
* <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
|
|
1605
1605
|
*/
|
|
1606
|
-
ConnectionType?: ConnectionType
|
|
1606
|
+
ConnectionType?: ConnectionType;
|
|
1607
1607
|
/**
|
|
1608
1608
|
* @public
|
|
1609
1609
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
1610
1610
|
*/
|
|
1611
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
1611
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
1612
1612
|
/**
|
|
1613
1613
|
* @public
|
|
1614
1614
|
* <p>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.</p>
|
|
@@ -1633,7 +1633,7 @@ export interface CreateIntegrationRequest {
|
|
|
1633
1633
|
* @public
|
|
1634
1634
|
* <p>The integration type of an integration. One of the following:</p> <p>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.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>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.</p> <p>HTTP_PROXY: for integrating the 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. For HTTP API private integrations, use an HTTP_PROXY integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
|
|
1635
1635
|
*/
|
|
1636
|
-
IntegrationType: IntegrationType |
|
|
1636
|
+
IntegrationType: IntegrationType | undefined;
|
|
1637
1637
|
/**
|
|
1638
1638
|
* @public
|
|
1639
1639
|
* <p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
|
|
@@ -1643,7 +1643,7 @@ export interface CreateIntegrationRequest {
|
|
|
1643
1643
|
* @public
|
|
1644
1644
|
* <p>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.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>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.</p>
|
|
1645
1645
|
*/
|
|
1646
|
-
PassthroughBehavior?: PassthroughBehavior
|
|
1646
|
+
PassthroughBehavior?: PassthroughBehavior;
|
|
1647
1647
|
/**
|
|
1648
1648
|
* @public
|
|
1649
1649
|
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
|
|
@@ -1703,12 +1703,12 @@ export interface CreateIntegrationResult {
|
|
|
1703
1703
|
* @public
|
|
1704
1704
|
* <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
|
|
1705
1705
|
*/
|
|
1706
|
-
ConnectionType?: ConnectionType
|
|
1706
|
+
ConnectionType?: ConnectionType;
|
|
1707
1707
|
/**
|
|
1708
1708
|
* @public
|
|
1709
1709
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
1710
1710
|
*/
|
|
1711
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
1711
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
1712
1712
|
/**
|
|
1713
1713
|
* @public
|
|
1714
1714
|
* <p>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.</p>
|
|
@@ -1743,7 +1743,7 @@ export interface CreateIntegrationResult {
|
|
|
1743
1743
|
* @public
|
|
1744
1744
|
* <p>The integration type of an integration. One of the following:</p> <p>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.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>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.</p> <p>HTTP_PROXY: for integrating the 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.</p> <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
|
|
1745
1745
|
*/
|
|
1746
|
-
IntegrationType?: IntegrationType
|
|
1746
|
+
IntegrationType?: IntegrationType;
|
|
1747
1747
|
/**
|
|
1748
1748
|
* @public
|
|
1749
1749
|
* <p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
|
|
@@ -1753,7 +1753,7 @@ export interface CreateIntegrationResult {
|
|
|
1753
1753
|
* @public
|
|
1754
1754
|
* <p>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.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>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.</p>
|
|
1755
1755
|
*/
|
|
1756
|
-
PassthroughBehavior?: PassthroughBehavior
|
|
1756
|
+
PassthroughBehavior?: PassthroughBehavior;
|
|
1757
1757
|
/**
|
|
1758
1758
|
* @public
|
|
1759
1759
|
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
|
|
@@ -1809,7 +1809,7 @@ export interface CreateIntegrationResponseRequest {
|
|
|
1809
1809
|
* @public
|
|
1810
1810
|
* <p>Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
1811
1811
|
*/
|
|
1812
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
1812
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
1813
1813
|
/**
|
|
1814
1814
|
* @public
|
|
1815
1815
|
* <p>The integration ID.</p>
|
|
@@ -1844,7 +1844,7 @@ export interface CreateIntegrationResponseResponse {
|
|
|
1844
1844
|
* @public
|
|
1845
1845
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
1846
1846
|
*/
|
|
1847
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
1847
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
1848
1848
|
/**
|
|
1849
1849
|
* @public
|
|
1850
1850
|
* <p>The integration response ID.</p>
|
|
@@ -1956,7 +1956,7 @@ export interface CreateRouteRequest {
|
|
|
1956
1956
|
* @public
|
|
1957
1957
|
* <p>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, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>
|
|
1958
1958
|
*/
|
|
1959
|
-
AuthorizationType?: AuthorizationType
|
|
1959
|
+
AuthorizationType?: AuthorizationType;
|
|
1960
1960
|
/**
|
|
1961
1961
|
* @public
|
|
1962
1962
|
* <p>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.</p>
|
|
@@ -2021,7 +2021,7 @@ export interface CreateRouteResult {
|
|
|
2021
2021
|
* @public
|
|
2022
2022
|
* <p>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, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>
|
|
2023
2023
|
*/
|
|
2024
|
-
AuthorizationType?: AuthorizationType
|
|
2024
|
+
AuthorizationType?: AuthorizationType;
|
|
2025
2025
|
/**
|
|
2026
2026
|
* @public
|
|
2027
2027
|
* <p>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.</p>
|
|
@@ -2334,7 +2334,7 @@ export interface CreateVpcLinkResponse {
|
|
|
2334
2334
|
* @public
|
|
2335
2335
|
* <p>The status of the VPC link.</p>
|
|
2336
2336
|
*/
|
|
2337
|
-
VpcLinkStatus?: VpcLinkStatus
|
|
2337
|
+
VpcLinkStatus?: VpcLinkStatus;
|
|
2338
2338
|
/**
|
|
2339
2339
|
* @public
|
|
2340
2340
|
* <p>A message summarizing the cause of the status of the VPC link.</p>
|
|
@@ -2344,7 +2344,7 @@ export interface CreateVpcLinkResponse {
|
|
|
2344
2344
|
* @public
|
|
2345
2345
|
* <p>The version of the VPC link.</p>
|
|
2346
2346
|
*/
|
|
2347
|
-
VpcLinkVersion?: VpcLinkVersion
|
|
2347
|
+
VpcLinkVersion?: VpcLinkVersion;
|
|
2348
2348
|
}
|
|
2349
2349
|
/**
|
|
2350
2350
|
* @public
|
|
@@ -2709,7 +2709,7 @@ export interface GetApiResponse {
|
|
|
2709
2709
|
* @public
|
|
2710
2710
|
* <p>The API protocol.</p>
|
|
2711
2711
|
*/
|
|
2712
|
-
ProtocolType?: ProtocolType
|
|
2712
|
+
ProtocolType?: ProtocolType;
|
|
2713
2713
|
/**
|
|
2714
2714
|
* @public
|
|
2715
2715
|
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
@@ -2879,7 +2879,7 @@ export interface GetAuthorizerResponse {
|
|
|
2879
2879
|
* @public
|
|
2880
2880
|
* <p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>
|
|
2881
2881
|
*/
|
|
2882
|
-
AuthorizerType?: AuthorizerType
|
|
2882
|
+
AuthorizerType?: AuthorizerType;
|
|
2883
2883
|
/**
|
|
2884
2884
|
* @public
|
|
2885
2885
|
* <p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>\{account_id\}</replaceable>:function:<replaceable>\{lambda_function_name\}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>\{region\}</replaceable>:lambda:path/<replaceable>\{service_api\}</replaceable>
|
|
@@ -2985,7 +2985,7 @@ export interface GetDeploymentResponse {
|
|
|
2985
2985
|
* @public
|
|
2986
2986
|
* <p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>
|
|
2987
2987
|
*/
|
|
2988
|
-
DeploymentStatus?: DeploymentStatus
|
|
2988
|
+
DeploymentStatus?: DeploymentStatus;
|
|
2989
2989
|
/**
|
|
2990
2990
|
* @public
|
|
2991
2991
|
* <p>May contain additional feedback on the status of an API deployment.</p>
|
|
@@ -3135,12 +3135,12 @@ export interface GetIntegrationResult {
|
|
|
3135
3135
|
* @public
|
|
3136
3136
|
* <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
|
|
3137
3137
|
*/
|
|
3138
|
-
ConnectionType?: ConnectionType
|
|
3138
|
+
ConnectionType?: ConnectionType;
|
|
3139
3139
|
/**
|
|
3140
3140
|
* @public
|
|
3141
3141
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
3142
3142
|
*/
|
|
3143
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
3143
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
3144
3144
|
/**
|
|
3145
3145
|
* @public
|
|
3146
3146
|
* <p>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.</p>
|
|
@@ -3175,7 +3175,7 @@ export interface GetIntegrationResult {
|
|
|
3175
3175
|
* @public
|
|
3176
3176
|
* <p>The integration type of an integration. One of the following:</p> <p>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.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>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.</p> <p>HTTP_PROXY: for integrating the 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.</p> <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
|
|
3177
3177
|
*/
|
|
3178
|
-
IntegrationType?: IntegrationType
|
|
3178
|
+
IntegrationType?: IntegrationType;
|
|
3179
3179
|
/**
|
|
3180
3180
|
* @public
|
|
3181
3181
|
* <p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
|
|
@@ -3185,7 +3185,7 @@ export interface GetIntegrationResult {
|
|
|
3185
3185
|
* @public
|
|
3186
3186
|
* <p>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.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>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.</p>
|
|
3187
3187
|
*/
|
|
3188
|
-
PassthroughBehavior?: PassthroughBehavior
|
|
3188
|
+
PassthroughBehavior?: PassthroughBehavior;
|
|
3189
3189
|
/**
|
|
3190
3190
|
* @public
|
|
3191
3191
|
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
|
|
@@ -3255,7 +3255,7 @@ export interface GetIntegrationResponseResponse {
|
|
|
3255
3255
|
* @public
|
|
3256
3256
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
3257
3257
|
*/
|
|
3258
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
3258
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
3259
3259
|
/**
|
|
3260
3260
|
* @public
|
|
3261
3261
|
* <p>The integration response ID.</p>
|
|
@@ -3500,7 +3500,7 @@ export interface GetRouteResult {
|
|
|
3500
3500
|
* @public
|
|
3501
3501
|
* <p>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, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>
|
|
3502
3502
|
*/
|
|
3503
|
-
AuthorizationType?: AuthorizationType
|
|
3503
|
+
AuthorizationType?: AuthorizationType;
|
|
3504
3504
|
/**
|
|
3505
3505
|
* @public
|
|
3506
3506
|
* <p>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.</p>
|
|
@@ -3865,7 +3865,7 @@ export interface GetVpcLinkResponse {
|
|
|
3865
3865
|
* @public
|
|
3866
3866
|
* <p>The status of the VPC link.</p>
|
|
3867
3867
|
*/
|
|
3868
|
-
VpcLinkStatus?: VpcLinkStatus
|
|
3868
|
+
VpcLinkStatus?: VpcLinkStatus;
|
|
3869
3869
|
/**
|
|
3870
3870
|
* @public
|
|
3871
3871
|
* <p>A message summarizing the cause of the status of the VPC link.</p>
|
|
@@ -3875,7 +3875,7 @@ export interface GetVpcLinkResponse {
|
|
|
3875
3875
|
* @public
|
|
3876
3876
|
* <p>The version of the VPC link.</p>
|
|
3877
3877
|
*/
|
|
3878
|
-
VpcLinkVersion?: VpcLinkVersion
|
|
3878
|
+
VpcLinkVersion?: VpcLinkVersion;
|
|
3879
3879
|
}
|
|
3880
3880
|
/**
|
|
3881
3881
|
* @public
|
|
@@ -3991,7 +3991,7 @@ export interface ImportApiResponse {
|
|
|
3991
3991
|
* @public
|
|
3992
3992
|
* <p>The API protocol.</p>
|
|
3993
3993
|
*/
|
|
3994
|
-
ProtocolType?: ProtocolType
|
|
3994
|
+
ProtocolType?: ProtocolType;
|
|
3995
3995
|
/**
|
|
3996
3996
|
* @public
|
|
3997
3997
|
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
@@ -4102,7 +4102,7 @@ export interface ReimportApiResponse {
|
|
|
4102
4102
|
* @public
|
|
4103
4103
|
* <p>The API protocol.</p>
|
|
4104
4104
|
*/
|
|
4105
|
-
ProtocolType?: ProtocolType
|
|
4105
|
+
ProtocolType?: ProtocolType;
|
|
4106
4106
|
/**
|
|
4107
4107
|
* @public
|
|
4108
4108
|
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
@@ -4304,7 +4304,7 @@ export interface UpdateApiResponse {
|
|
|
4304
4304
|
* @public
|
|
4305
4305
|
* <p>The API protocol.</p>
|
|
4306
4306
|
*/
|
|
4307
|
-
ProtocolType?: ProtocolType
|
|
4307
|
+
ProtocolType?: ProtocolType;
|
|
4308
4308
|
/**
|
|
4309
4309
|
* @public
|
|
4310
4310
|
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
@@ -4416,7 +4416,7 @@ export interface UpdateAuthorizerRequest {
|
|
|
4416
4416
|
* @public
|
|
4417
4417
|
* <p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>
|
|
4418
4418
|
*/
|
|
4419
|
-
AuthorizerType?: AuthorizerType
|
|
4419
|
+
AuthorizerType?: AuthorizerType;
|
|
4420
4420
|
/**
|
|
4421
4421
|
* @public
|
|
4422
4422
|
* <p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>\{account_id\}</replaceable>:function:<replaceable>\{lambda_function_name\}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>\{region\}</replaceable>:lambda:path/<replaceable>\{service_api\}</replaceable>
|
|
@@ -4477,7 +4477,7 @@ export interface UpdateAuthorizerResponse {
|
|
|
4477
4477
|
* @public
|
|
4478
4478
|
* <p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>
|
|
4479
4479
|
*/
|
|
4480
|
-
AuthorizerType?: AuthorizerType
|
|
4480
|
+
AuthorizerType?: AuthorizerType;
|
|
4481
4481
|
/**
|
|
4482
4482
|
* @public
|
|
4483
4483
|
* <p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>\{account_id\}</replaceable>:function:<replaceable>\{lambda_function_name\}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>\{region\}</replaceable>:lambda:path/<replaceable>\{service_api\}</replaceable>
|
|
@@ -4554,7 +4554,7 @@ export interface UpdateDeploymentResponse {
|
|
|
4554
4554
|
* @public
|
|
4555
4555
|
* <p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>
|
|
4556
4556
|
*/
|
|
4557
|
-
DeploymentStatus?: DeploymentStatus
|
|
4557
|
+
DeploymentStatus?: DeploymentStatus;
|
|
4558
4558
|
/**
|
|
4559
4559
|
* @public
|
|
4560
4560
|
* <p>May contain additional feedback on the status of an API deployment.</p>
|
|
@@ -4636,12 +4636,12 @@ export interface UpdateIntegrationRequest {
|
|
|
4636
4636
|
* @public
|
|
4637
4637
|
* <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
|
|
4638
4638
|
*/
|
|
4639
|
-
ConnectionType?: ConnectionType
|
|
4639
|
+
ConnectionType?: ConnectionType;
|
|
4640
4640
|
/**
|
|
4641
4641
|
* @public
|
|
4642
4642
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
4643
4643
|
*/
|
|
4644
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
4644
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
4645
4645
|
/**
|
|
4646
4646
|
* @public
|
|
4647
4647
|
* <p>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.</p>
|
|
@@ -4671,7 +4671,7 @@ export interface UpdateIntegrationRequest {
|
|
|
4671
4671
|
* @public
|
|
4672
4672
|
* <p>The integration type of an integration. One of the following:</p> <p>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.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>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.</p> <p>HTTP_PROXY: for integrating the 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. For HTTP API private integrations, use an HTTP_PROXY integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
|
|
4673
4673
|
*/
|
|
4674
|
-
IntegrationType?: IntegrationType
|
|
4674
|
+
IntegrationType?: IntegrationType;
|
|
4675
4675
|
/**
|
|
4676
4676
|
* @public
|
|
4677
4677
|
* <p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
|
|
@@ -4681,7 +4681,7 @@ export interface UpdateIntegrationRequest {
|
|
|
4681
4681
|
* @public
|
|
4682
4682
|
* <p>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.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>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.</p>
|
|
4683
4683
|
*/
|
|
4684
|
-
PassthroughBehavior?: PassthroughBehavior
|
|
4684
|
+
PassthroughBehavior?: PassthroughBehavior;
|
|
4685
4685
|
/**
|
|
4686
4686
|
* @public
|
|
4687
4687
|
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
|
|
@@ -4741,12 +4741,12 @@ export interface UpdateIntegrationResult {
|
|
|
4741
4741
|
* @public
|
|
4742
4742
|
* <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
|
|
4743
4743
|
*/
|
|
4744
|
-
ConnectionType?: ConnectionType
|
|
4744
|
+
ConnectionType?: ConnectionType;
|
|
4745
4745
|
/**
|
|
4746
4746
|
* @public
|
|
4747
4747
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
4748
4748
|
*/
|
|
4749
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
4749
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
4750
4750
|
/**
|
|
4751
4751
|
* @public
|
|
4752
4752
|
* <p>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.</p>
|
|
@@ -4781,7 +4781,7 @@ export interface UpdateIntegrationResult {
|
|
|
4781
4781
|
* @public
|
|
4782
4782
|
* <p>The integration type of an integration. One of the following:</p> <p>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.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>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.</p> <p>HTTP_PROXY: for integrating the 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.</p> <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
|
|
4783
4783
|
*/
|
|
4784
|
-
IntegrationType?: IntegrationType
|
|
4784
|
+
IntegrationType?: IntegrationType;
|
|
4785
4785
|
/**
|
|
4786
4786
|
* @public
|
|
4787
4787
|
* <p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
|
|
@@ -4791,7 +4791,7 @@ export interface UpdateIntegrationResult {
|
|
|
4791
4791
|
* @public
|
|
4792
4792
|
* <p>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.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>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.</p>
|
|
4793
4793
|
*/
|
|
4794
|
-
PassthroughBehavior?: PassthroughBehavior
|
|
4794
|
+
PassthroughBehavior?: PassthroughBehavior;
|
|
4795
4795
|
/**
|
|
4796
4796
|
* @public
|
|
4797
4797
|
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
|
|
@@ -4847,7 +4847,7 @@ export interface UpdateIntegrationResponseRequest {
|
|
|
4847
4847
|
* @public
|
|
4848
4848
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
4849
4849
|
*/
|
|
4850
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
4850
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
4851
4851
|
/**
|
|
4852
4852
|
* @public
|
|
4853
4853
|
* <p>The integration ID.</p>
|
|
@@ -4894,7 +4894,7 @@ export interface UpdateIntegrationResponseResponse {
|
|
|
4894
4894
|
* @public
|
|
4895
4895
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
4896
4896
|
*/
|
|
4897
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
4897
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
4898
4898
|
/**
|
|
4899
4899
|
* @public
|
|
4900
4900
|
* <p>The integration response ID.</p>
|
|
@@ -5011,7 +5011,7 @@ export interface UpdateRouteRequest {
|
|
|
5011
5011
|
* @public
|
|
5012
5012
|
* <p>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, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>
|
|
5013
5013
|
*/
|
|
5014
|
-
AuthorizationType?: AuthorizationType
|
|
5014
|
+
AuthorizationType?: AuthorizationType;
|
|
5015
5015
|
/**
|
|
5016
5016
|
* @public
|
|
5017
5017
|
* <p>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.</p>
|
|
@@ -5081,7 +5081,7 @@ export interface UpdateRouteResult {
|
|
|
5081
5081
|
* @public
|
|
5082
5082
|
* <p>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, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>
|
|
5083
5083
|
*/
|
|
5084
|
-
AuthorizationType?: AuthorizationType
|
|
5084
|
+
AuthorizationType?: AuthorizationType;
|
|
5085
5085
|
/**
|
|
5086
5086
|
* @public
|
|
5087
5087
|
* <p>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.</p>
|
|
@@ -5384,7 +5384,7 @@ export interface UpdateVpcLinkResponse {
|
|
|
5384
5384
|
* @public
|
|
5385
5385
|
* <p>The status of the VPC link.</p>
|
|
5386
5386
|
*/
|
|
5387
|
-
VpcLinkStatus?: VpcLinkStatus
|
|
5387
|
+
VpcLinkStatus?: VpcLinkStatus;
|
|
5388
5388
|
/**
|
|
5389
5389
|
* @public
|
|
5390
5390
|
* <p>A message summarizing the cause of the status of the VPC link.</p>
|
|
@@ -5394,5 +5394,5 @@ export interface UpdateVpcLinkResponse {
|
|
|
5394
5394
|
* @public
|
|
5395
5395
|
* <p>The version of the VPC link.</p>
|
|
5396
5396
|
*/
|
|
5397
|
-
VpcLinkVersion?: VpcLinkVersion
|
|
5397
|
+
VpcLinkVersion?: VpcLinkVersion;
|
|
5398
5398
|
}
|
|
@@ -25,7 +25,7 @@ export interface Api {
|
|
|
25
25
|
DisableExecuteApiEndpoint?: boolean;
|
|
26
26
|
ImportInfo?: string[];
|
|
27
27
|
Name: string | undefined;
|
|
28
|
-
ProtocolType: ProtocolType |
|
|
28
|
+
ProtocolType: ProtocolType | undefined;
|
|
29
29
|
RouteSelectionExpression: string | undefined;
|
|
30
30
|
Tags?: Record<string, string>;
|
|
31
31
|
Version?: string;
|
|
@@ -52,7 +52,7 @@ export interface Authorizer {
|
|
|
52
52
|
AuthorizerId?: string;
|
|
53
53
|
AuthorizerPayloadFormatVersion?: string;
|
|
54
54
|
AuthorizerResultTtlInSeconds?: number;
|
|
55
|
-
AuthorizerType?: AuthorizerType
|
|
55
|
+
AuthorizerType?: AuthorizerType;
|
|
56
56
|
AuthorizerUri?: string;
|
|
57
57
|
EnableSimpleResponses?: boolean;
|
|
58
58
|
IdentitySource?: string[];
|
|
@@ -71,7 +71,7 @@ export interface Deployment {
|
|
|
71
71
|
AutoDeployed?: boolean;
|
|
72
72
|
CreatedDate?: Date;
|
|
73
73
|
DeploymentId?: string;
|
|
74
|
-
DeploymentStatus?: DeploymentStatus
|
|
74
|
+
DeploymentStatus?: DeploymentStatus;
|
|
75
75
|
DeploymentStatusMessage?: string;
|
|
76
76
|
Description?: string;
|
|
77
77
|
}
|
|
@@ -99,11 +99,11 @@ export interface DomainNameConfiguration {
|
|
|
99
99
|
CertificateArn?: string;
|
|
100
100
|
CertificateName?: string;
|
|
101
101
|
CertificateUploadDate?: Date;
|
|
102
|
-
DomainNameStatus?: DomainNameStatus
|
|
102
|
+
DomainNameStatus?: DomainNameStatus;
|
|
103
103
|
DomainNameStatusMessage?: string;
|
|
104
|
-
EndpointType?: EndpointType
|
|
104
|
+
EndpointType?: EndpointType;
|
|
105
105
|
HostedZoneId?: string;
|
|
106
|
-
SecurityPolicy?: SecurityPolicy
|
|
106
|
+
SecurityPolicy?: SecurityPolicy;
|
|
107
107
|
OwnershipVerificationCertificateArn?: string;
|
|
108
108
|
}
|
|
109
109
|
export interface MutualTlsAuthentication {
|
|
@@ -152,17 +152,17 @@ export interface TlsConfig {
|
|
|
152
152
|
export interface Integration {
|
|
153
153
|
ApiGatewayManaged?: boolean;
|
|
154
154
|
ConnectionId?: string;
|
|
155
|
-
ConnectionType?: ConnectionType
|
|
156
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
155
|
+
ConnectionType?: ConnectionType;
|
|
156
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
157
157
|
CredentialsArn?: string;
|
|
158
158
|
Description?: string;
|
|
159
159
|
IntegrationId?: string;
|
|
160
160
|
IntegrationMethod?: string;
|
|
161
161
|
IntegrationResponseSelectionExpression?: string;
|
|
162
162
|
IntegrationSubtype?: string;
|
|
163
|
-
IntegrationType?: IntegrationType
|
|
163
|
+
IntegrationType?: IntegrationType;
|
|
164
164
|
IntegrationUri?: string;
|
|
165
|
-
PassthroughBehavior?: PassthroughBehavior
|
|
165
|
+
PassthroughBehavior?: PassthroughBehavior;
|
|
166
166
|
PayloadFormatVersion?: string;
|
|
167
167
|
RequestParameters?: Record<string, string>;
|
|
168
168
|
RequestTemplates?: Record<string, string>;
|
|
@@ -172,7 +172,7 @@ export interface Integration {
|
|
|
172
172
|
TlsConfig?: TlsConfig;
|
|
173
173
|
}
|
|
174
174
|
export interface IntegrationResponse {
|
|
175
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
175
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
176
176
|
IntegrationResponseId?: string;
|
|
177
177
|
IntegrationResponseKey: string | undefined;
|
|
178
178
|
ResponseParameters?: Record<string, string>;
|
|
@@ -201,7 +201,7 @@ export interface Route {
|
|
|
201
201
|
ApiGatewayManaged?: boolean;
|
|
202
202
|
ApiKeyRequired?: boolean;
|
|
203
203
|
AuthorizationScopes?: string[];
|
|
204
|
-
AuthorizationType?: AuthorizationType
|
|
204
|
+
AuthorizationType?: AuthorizationType;
|
|
205
205
|
AuthorizerId?: string;
|
|
206
206
|
ModelSelectionExpression?: string;
|
|
207
207
|
OperationName?: string;
|
|
@@ -232,7 +232,7 @@ export type LoggingLevel = (typeof LoggingLevel)[keyof typeof LoggingLevel];
|
|
|
232
232
|
export interface RouteSettings {
|
|
233
233
|
DataTraceEnabled?: boolean;
|
|
234
234
|
DetailedMetricsEnabled?: boolean;
|
|
235
|
-
LoggingLevel?: LoggingLevel
|
|
235
|
+
LoggingLevel?: LoggingLevel;
|
|
236
236
|
ThrottlingBurstLimit?: number;
|
|
237
237
|
ThrottlingRateLimit?: number;
|
|
238
238
|
}
|
|
@@ -272,9 +272,9 @@ export interface VpcLink {
|
|
|
272
272
|
SubnetIds: string[] | undefined;
|
|
273
273
|
Tags?: Record<string, string>;
|
|
274
274
|
VpcLinkId: string | undefined;
|
|
275
|
-
VpcLinkStatus?: VpcLinkStatus
|
|
275
|
+
VpcLinkStatus?: VpcLinkStatus;
|
|
276
276
|
VpcLinkStatusMessage?: string;
|
|
277
|
-
VpcLinkVersion?: VpcLinkVersion
|
|
277
|
+
VpcLinkVersion?: VpcLinkVersion;
|
|
278
278
|
}
|
|
279
279
|
export declare class AccessDeniedException extends __BaseException {
|
|
280
280
|
readonly name: "AccessDeniedException";
|
|
@@ -306,7 +306,7 @@ export interface CreateApiRequest {
|
|
|
306
306
|
DisableSchemaValidation?: boolean;
|
|
307
307
|
DisableExecuteApiEndpoint?: boolean;
|
|
308
308
|
Name: string | undefined;
|
|
309
|
-
ProtocolType: ProtocolType |
|
|
309
|
+
ProtocolType: ProtocolType | undefined;
|
|
310
310
|
RouteKey?: string;
|
|
311
311
|
RouteSelectionExpression?: string;
|
|
312
312
|
Tags?: Record<string, string>;
|
|
@@ -325,7 +325,7 @@ export interface CreateApiResponse {
|
|
|
325
325
|
DisableExecuteApiEndpoint?: boolean;
|
|
326
326
|
ImportInfo?: string[];
|
|
327
327
|
Name?: string;
|
|
328
|
-
ProtocolType?: ProtocolType
|
|
328
|
+
ProtocolType?: ProtocolType;
|
|
329
329
|
RouteSelectionExpression?: string;
|
|
330
330
|
Tags?: Record<string, string>;
|
|
331
331
|
Version?: string;
|
|
@@ -364,7 +364,7 @@ export interface CreateAuthorizerRequest {
|
|
|
364
364
|
AuthorizerCredentialsArn?: string;
|
|
365
365
|
AuthorizerPayloadFormatVersion?: string;
|
|
366
366
|
AuthorizerResultTtlInSeconds?: number;
|
|
367
|
-
AuthorizerType: AuthorizerType |
|
|
367
|
+
AuthorizerType: AuthorizerType | undefined;
|
|
368
368
|
AuthorizerUri?: string;
|
|
369
369
|
EnableSimpleResponses?: boolean;
|
|
370
370
|
IdentitySource: string[] | undefined;
|
|
@@ -377,7 +377,7 @@ export interface CreateAuthorizerResponse {
|
|
|
377
377
|
AuthorizerId?: string;
|
|
378
378
|
AuthorizerPayloadFormatVersion?: string;
|
|
379
379
|
AuthorizerResultTtlInSeconds?: number;
|
|
380
|
-
AuthorizerType?: AuthorizerType
|
|
380
|
+
AuthorizerType?: AuthorizerType;
|
|
381
381
|
AuthorizerUri?: string;
|
|
382
382
|
EnableSimpleResponses?: boolean;
|
|
383
383
|
IdentitySource?: string[];
|
|
@@ -394,7 +394,7 @@ export interface CreateDeploymentResponse {
|
|
|
394
394
|
AutoDeployed?: boolean;
|
|
395
395
|
CreatedDate?: Date;
|
|
396
396
|
DeploymentId?: string;
|
|
397
|
-
DeploymentStatus?: DeploymentStatus
|
|
397
|
+
DeploymentStatus?: DeploymentStatus;
|
|
398
398
|
DeploymentStatusMessage?: string;
|
|
399
399
|
Description?: string;
|
|
400
400
|
}
|
|
@@ -421,15 +421,15 @@ export interface TlsConfigInput {
|
|
|
421
421
|
export interface CreateIntegrationRequest {
|
|
422
422
|
ApiId: string | undefined;
|
|
423
423
|
ConnectionId?: string;
|
|
424
|
-
ConnectionType?: ConnectionType
|
|
425
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
424
|
+
ConnectionType?: ConnectionType;
|
|
425
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
426
426
|
CredentialsArn?: string;
|
|
427
427
|
Description?: string;
|
|
428
428
|
IntegrationMethod?: string;
|
|
429
429
|
IntegrationSubtype?: string;
|
|
430
|
-
IntegrationType: IntegrationType |
|
|
430
|
+
IntegrationType: IntegrationType | undefined;
|
|
431
431
|
IntegrationUri?: string;
|
|
432
|
-
PassthroughBehavior?: PassthroughBehavior
|
|
432
|
+
PassthroughBehavior?: PassthroughBehavior;
|
|
433
433
|
PayloadFormatVersion?: string;
|
|
434
434
|
RequestParameters?: Record<string, string>;
|
|
435
435
|
RequestTemplates?: Record<string, string>;
|
|
@@ -441,17 +441,17 @@ export interface CreateIntegrationRequest {
|
|
|
441
441
|
export interface CreateIntegrationResult {
|
|
442
442
|
ApiGatewayManaged?: boolean;
|
|
443
443
|
ConnectionId?: string;
|
|
444
|
-
ConnectionType?: ConnectionType
|
|
445
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
444
|
+
ConnectionType?: ConnectionType;
|
|
445
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
446
446
|
CredentialsArn?: string;
|
|
447
447
|
Description?: string;
|
|
448
448
|
IntegrationId?: string;
|
|
449
449
|
IntegrationMethod?: string;
|
|
450
450
|
IntegrationResponseSelectionExpression?: string;
|
|
451
451
|
IntegrationSubtype?: string;
|
|
452
|
-
IntegrationType?: IntegrationType
|
|
452
|
+
IntegrationType?: IntegrationType;
|
|
453
453
|
IntegrationUri?: string;
|
|
454
|
-
PassthroughBehavior?: PassthroughBehavior
|
|
454
|
+
PassthroughBehavior?: PassthroughBehavior;
|
|
455
455
|
PayloadFormatVersion?: string;
|
|
456
456
|
RequestParameters?: Record<string, string>;
|
|
457
457
|
RequestTemplates?: Record<string, string>;
|
|
@@ -462,7 +462,7 @@ export interface CreateIntegrationResult {
|
|
|
462
462
|
}
|
|
463
463
|
export interface CreateIntegrationResponseRequest {
|
|
464
464
|
ApiId: string | undefined;
|
|
465
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
465
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
466
466
|
IntegrationId: string | undefined;
|
|
467
467
|
IntegrationResponseKey: string | undefined;
|
|
468
468
|
ResponseParameters?: Record<string, string>;
|
|
@@ -470,7 +470,7 @@ export interface CreateIntegrationResponseRequest {
|
|
|
470
470
|
TemplateSelectionExpression?: string;
|
|
471
471
|
}
|
|
472
472
|
export interface CreateIntegrationResponseResponse {
|
|
473
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
473
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
474
474
|
IntegrationResponseId?: string;
|
|
475
475
|
IntegrationResponseKey?: string;
|
|
476
476
|
ResponseParameters?: Record<string, string>;
|
|
@@ -495,7 +495,7 @@ export interface CreateRouteRequest {
|
|
|
495
495
|
ApiId: string | undefined;
|
|
496
496
|
ApiKeyRequired?: boolean;
|
|
497
497
|
AuthorizationScopes?: string[];
|
|
498
|
-
AuthorizationType?: AuthorizationType
|
|
498
|
+
AuthorizationType?: AuthorizationType;
|
|
499
499
|
AuthorizerId?: string;
|
|
500
500
|
ModelSelectionExpression?: string;
|
|
501
501
|
OperationName?: string;
|
|
@@ -509,7 +509,7 @@ export interface CreateRouteResult {
|
|
|
509
509
|
ApiGatewayManaged?: boolean;
|
|
510
510
|
ApiKeyRequired?: boolean;
|
|
511
511
|
AuthorizationScopes?: string[];
|
|
512
|
-
AuthorizationType?: AuthorizationType
|
|
512
|
+
AuthorizationType?: AuthorizationType;
|
|
513
513
|
AuthorizerId?: string;
|
|
514
514
|
ModelSelectionExpression?: string;
|
|
515
515
|
OperationName?: string;
|
|
@@ -577,9 +577,9 @@ export interface CreateVpcLinkResponse {
|
|
|
577
577
|
SubnetIds?: string[];
|
|
578
578
|
Tags?: Record<string, string>;
|
|
579
579
|
VpcLinkId?: string;
|
|
580
|
-
VpcLinkStatus?: VpcLinkStatus
|
|
580
|
+
VpcLinkStatus?: VpcLinkStatus;
|
|
581
581
|
VpcLinkStatusMessage?: string;
|
|
582
|
-
VpcLinkVersion?: VpcLinkVersion
|
|
582
|
+
VpcLinkVersion?: VpcLinkVersion;
|
|
583
583
|
}
|
|
584
584
|
export interface DeleteAccessLogSettingsRequest {
|
|
585
585
|
ApiId: string | undefined;
|
|
@@ -672,7 +672,7 @@ export interface GetApiResponse {
|
|
|
672
672
|
DisableExecuteApiEndpoint?: boolean;
|
|
673
673
|
ImportInfo?: string[];
|
|
674
674
|
Name?: string;
|
|
675
|
-
ProtocolType?: ProtocolType
|
|
675
|
+
ProtocolType?: ProtocolType;
|
|
676
676
|
RouteSelectionExpression?: string;
|
|
677
677
|
Tags?: Record<string, string>;
|
|
678
678
|
Version?: string;
|
|
@@ -714,7 +714,7 @@ export interface GetAuthorizerResponse {
|
|
|
714
714
|
AuthorizerId?: string;
|
|
715
715
|
AuthorizerPayloadFormatVersion?: string;
|
|
716
716
|
AuthorizerResultTtlInSeconds?: number;
|
|
717
|
-
AuthorizerType?: AuthorizerType
|
|
717
|
+
AuthorizerType?: AuthorizerType;
|
|
718
718
|
AuthorizerUri?: string;
|
|
719
719
|
EnableSimpleResponses?: boolean;
|
|
720
720
|
IdentitySource?: string[];
|
|
@@ -739,7 +739,7 @@ export interface GetDeploymentResponse {
|
|
|
739
739
|
AutoDeployed?: boolean;
|
|
740
740
|
CreatedDate?: Date;
|
|
741
741
|
DeploymentId?: string;
|
|
742
|
-
DeploymentStatus?: DeploymentStatus
|
|
742
|
+
DeploymentStatus?: DeploymentStatus;
|
|
743
743
|
DeploymentStatusMessage?: string;
|
|
744
744
|
Description?: string;
|
|
745
745
|
}
|
|
@@ -777,17 +777,17 @@ export interface GetIntegrationRequest {
|
|
|
777
777
|
export interface GetIntegrationResult {
|
|
778
778
|
ApiGatewayManaged?: boolean;
|
|
779
779
|
ConnectionId?: string;
|
|
780
|
-
ConnectionType?: ConnectionType
|
|
781
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
780
|
+
ConnectionType?: ConnectionType;
|
|
781
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
782
782
|
CredentialsArn?: string;
|
|
783
783
|
Description?: string;
|
|
784
784
|
IntegrationId?: string;
|
|
785
785
|
IntegrationMethod?: string;
|
|
786
786
|
IntegrationResponseSelectionExpression?: string;
|
|
787
787
|
IntegrationSubtype?: string;
|
|
788
|
-
IntegrationType?: IntegrationType
|
|
788
|
+
IntegrationType?: IntegrationType;
|
|
789
789
|
IntegrationUri?: string;
|
|
790
|
-
PassthroughBehavior?: PassthroughBehavior
|
|
790
|
+
PassthroughBehavior?: PassthroughBehavior;
|
|
791
791
|
PayloadFormatVersion?: string;
|
|
792
792
|
RequestParameters?: Record<string, string>;
|
|
793
793
|
RequestTemplates?: Record<string, string>;
|
|
@@ -802,7 +802,7 @@ export interface GetIntegrationResponseRequest {
|
|
|
802
802
|
IntegrationResponseId: string | undefined;
|
|
803
803
|
}
|
|
804
804
|
export interface GetIntegrationResponseResponse {
|
|
805
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
805
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
806
806
|
IntegrationResponseId?: string;
|
|
807
807
|
IntegrationResponseKey?: string;
|
|
808
808
|
ResponseParameters?: Record<string, string>;
|
|
@@ -863,7 +863,7 @@ export interface GetRouteResult {
|
|
|
863
863
|
ApiGatewayManaged?: boolean;
|
|
864
864
|
ApiKeyRequired?: boolean;
|
|
865
865
|
AuthorizationScopes?: string[];
|
|
866
|
-
AuthorizationType?: AuthorizationType
|
|
866
|
+
AuthorizationType?: AuthorizationType;
|
|
867
867
|
AuthorizerId?: string;
|
|
868
868
|
ModelSelectionExpression?: string;
|
|
869
869
|
OperationName?: string;
|
|
@@ -950,9 +950,9 @@ export interface GetVpcLinkResponse {
|
|
|
950
950
|
SubnetIds?: string[];
|
|
951
951
|
Tags?: Record<string, string>;
|
|
952
952
|
VpcLinkId?: string;
|
|
953
|
-
VpcLinkStatus?: VpcLinkStatus
|
|
953
|
+
VpcLinkStatus?: VpcLinkStatus;
|
|
954
954
|
VpcLinkStatusMessage?: string;
|
|
955
|
-
VpcLinkVersion?: VpcLinkVersion
|
|
955
|
+
VpcLinkVersion?: VpcLinkVersion;
|
|
956
956
|
}
|
|
957
957
|
export interface GetVpcLinksRequest {
|
|
958
958
|
MaxResults?: string;
|
|
@@ -979,7 +979,7 @@ export interface ImportApiResponse {
|
|
|
979
979
|
DisableExecuteApiEndpoint?: boolean;
|
|
980
980
|
ImportInfo?: string[];
|
|
981
981
|
Name?: string;
|
|
982
|
-
ProtocolType?: ProtocolType
|
|
982
|
+
ProtocolType?: ProtocolType;
|
|
983
983
|
RouteSelectionExpression?: string;
|
|
984
984
|
Tags?: Record<string, string>;
|
|
985
985
|
Version?: string;
|
|
@@ -1003,7 +1003,7 @@ export interface ReimportApiResponse {
|
|
|
1003
1003
|
DisableExecuteApiEndpoint?: boolean;
|
|
1004
1004
|
ImportInfo?: string[];
|
|
1005
1005
|
Name?: string;
|
|
1006
|
-
ProtocolType?: ProtocolType
|
|
1006
|
+
ProtocolType?: ProtocolType;
|
|
1007
1007
|
RouteSelectionExpression?: string;
|
|
1008
1008
|
Tags?: Record<string, string>;
|
|
1009
1009
|
Version?: string;
|
|
@@ -1048,7 +1048,7 @@ export interface UpdateApiResponse {
|
|
|
1048
1048
|
DisableExecuteApiEndpoint?: boolean;
|
|
1049
1049
|
ImportInfo?: string[];
|
|
1050
1050
|
Name?: string;
|
|
1051
|
-
ProtocolType?: ProtocolType
|
|
1051
|
+
ProtocolType?: ProtocolType;
|
|
1052
1052
|
RouteSelectionExpression?: string;
|
|
1053
1053
|
Tags?: Record<string, string>;
|
|
1054
1054
|
Version?: string;
|
|
@@ -1073,7 +1073,7 @@ export interface UpdateAuthorizerRequest {
|
|
|
1073
1073
|
AuthorizerId: string | undefined;
|
|
1074
1074
|
AuthorizerPayloadFormatVersion?: string;
|
|
1075
1075
|
AuthorizerResultTtlInSeconds?: number;
|
|
1076
|
-
AuthorizerType?: AuthorizerType
|
|
1076
|
+
AuthorizerType?: AuthorizerType;
|
|
1077
1077
|
AuthorizerUri?: string;
|
|
1078
1078
|
EnableSimpleResponses?: boolean;
|
|
1079
1079
|
IdentitySource?: string[];
|
|
@@ -1086,7 +1086,7 @@ export interface UpdateAuthorizerResponse {
|
|
|
1086
1086
|
AuthorizerId?: string;
|
|
1087
1087
|
AuthorizerPayloadFormatVersion?: string;
|
|
1088
1088
|
AuthorizerResultTtlInSeconds?: number;
|
|
1089
|
-
AuthorizerType?: AuthorizerType
|
|
1089
|
+
AuthorizerType?: AuthorizerType;
|
|
1090
1090
|
AuthorizerUri?: string;
|
|
1091
1091
|
EnableSimpleResponses?: boolean;
|
|
1092
1092
|
IdentitySource?: string[];
|
|
@@ -1103,7 +1103,7 @@ export interface UpdateDeploymentResponse {
|
|
|
1103
1103
|
AutoDeployed?: boolean;
|
|
1104
1104
|
CreatedDate?: Date;
|
|
1105
1105
|
DeploymentId?: string;
|
|
1106
|
-
DeploymentStatus?: DeploymentStatus
|
|
1106
|
+
DeploymentStatus?: DeploymentStatus;
|
|
1107
1107
|
DeploymentStatusMessage?: string;
|
|
1108
1108
|
Description?: string;
|
|
1109
1109
|
}
|
|
@@ -1122,16 +1122,16 @@ export interface UpdateDomainNameResponse {
|
|
|
1122
1122
|
export interface UpdateIntegrationRequest {
|
|
1123
1123
|
ApiId: string | undefined;
|
|
1124
1124
|
ConnectionId?: string;
|
|
1125
|
-
ConnectionType?: ConnectionType
|
|
1126
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
1125
|
+
ConnectionType?: ConnectionType;
|
|
1126
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
1127
1127
|
CredentialsArn?: string;
|
|
1128
1128
|
Description?: string;
|
|
1129
1129
|
IntegrationId: string | undefined;
|
|
1130
1130
|
IntegrationMethod?: string;
|
|
1131
1131
|
IntegrationSubtype?: string;
|
|
1132
|
-
IntegrationType?: IntegrationType
|
|
1132
|
+
IntegrationType?: IntegrationType;
|
|
1133
1133
|
IntegrationUri?: string;
|
|
1134
|
-
PassthroughBehavior?: PassthroughBehavior
|
|
1134
|
+
PassthroughBehavior?: PassthroughBehavior;
|
|
1135
1135
|
PayloadFormatVersion?: string;
|
|
1136
1136
|
RequestParameters?: Record<string, string>;
|
|
1137
1137
|
RequestTemplates?: Record<string, string>;
|
|
@@ -1143,17 +1143,17 @@ export interface UpdateIntegrationRequest {
|
|
|
1143
1143
|
export interface UpdateIntegrationResult {
|
|
1144
1144
|
ApiGatewayManaged?: boolean;
|
|
1145
1145
|
ConnectionId?: string;
|
|
1146
|
-
ConnectionType?: ConnectionType
|
|
1147
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
1146
|
+
ConnectionType?: ConnectionType;
|
|
1147
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
1148
1148
|
CredentialsArn?: string;
|
|
1149
1149
|
Description?: string;
|
|
1150
1150
|
IntegrationId?: string;
|
|
1151
1151
|
IntegrationMethod?: string;
|
|
1152
1152
|
IntegrationResponseSelectionExpression?: string;
|
|
1153
1153
|
IntegrationSubtype?: string;
|
|
1154
|
-
IntegrationType?: IntegrationType
|
|
1154
|
+
IntegrationType?: IntegrationType;
|
|
1155
1155
|
IntegrationUri?: string;
|
|
1156
|
-
PassthroughBehavior?: PassthroughBehavior
|
|
1156
|
+
PassthroughBehavior?: PassthroughBehavior;
|
|
1157
1157
|
PayloadFormatVersion?: string;
|
|
1158
1158
|
RequestParameters?: Record<string, string>;
|
|
1159
1159
|
RequestTemplates?: Record<string, string>;
|
|
@@ -1164,7 +1164,7 @@ export interface UpdateIntegrationResult {
|
|
|
1164
1164
|
}
|
|
1165
1165
|
export interface UpdateIntegrationResponseRequest {
|
|
1166
1166
|
ApiId: string | undefined;
|
|
1167
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
1167
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
1168
1168
|
IntegrationId: string | undefined;
|
|
1169
1169
|
IntegrationResponseId: string | undefined;
|
|
1170
1170
|
IntegrationResponseKey?: string;
|
|
@@ -1173,7 +1173,7 @@ export interface UpdateIntegrationResponseRequest {
|
|
|
1173
1173
|
TemplateSelectionExpression?: string;
|
|
1174
1174
|
}
|
|
1175
1175
|
export interface UpdateIntegrationResponseResponse {
|
|
1176
|
-
ContentHandlingStrategy?: ContentHandlingStrategy
|
|
1176
|
+
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
1177
1177
|
IntegrationResponseId?: string;
|
|
1178
1178
|
IntegrationResponseKey?: string;
|
|
1179
1179
|
ResponseParameters?: Record<string, string>;
|
|
@@ -1199,7 +1199,7 @@ export interface UpdateRouteRequest {
|
|
|
1199
1199
|
ApiId: string | undefined;
|
|
1200
1200
|
ApiKeyRequired?: boolean;
|
|
1201
1201
|
AuthorizationScopes?: string[];
|
|
1202
|
-
AuthorizationType?: AuthorizationType
|
|
1202
|
+
AuthorizationType?: AuthorizationType;
|
|
1203
1203
|
AuthorizerId?: string;
|
|
1204
1204
|
ModelSelectionExpression?: string;
|
|
1205
1205
|
OperationName?: string;
|
|
@@ -1214,7 +1214,7 @@ export interface UpdateRouteResult {
|
|
|
1214
1214
|
ApiGatewayManaged?: boolean;
|
|
1215
1215
|
ApiKeyRequired?: boolean;
|
|
1216
1216
|
AuthorizationScopes?: string[];
|
|
1217
|
-
AuthorizationType?: AuthorizationType
|
|
1217
|
+
AuthorizationType?: AuthorizationType;
|
|
1218
1218
|
AuthorizerId?: string;
|
|
1219
1219
|
ModelSelectionExpression?: string;
|
|
1220
1220
|
OperationName?: string;
|
|
@@ -1280,7 +1280,7 @@ export interface UpdateVpcLinkResponse {
|
|
|
1280
1280
|
SubnetIds?: string[];
|
|
1281
1281
|
Tags?: Record<string, string>;
|
|
1282
1282
|
VpcLinkId?: string;
|
|
1283
|
-
VpcLinkStatus?: VpcLinkStatus
|
|
1283
|
+
VpcLinkStatus?: VpcLinkStatus;
|
|
1284
1284
|
VpcLinkStatusMessage?: string;
|
|
1285
|
-
VpcLinkVersion?: VpcLinkVersion
|
|
1285
|
+
VpcLinkVersion?: VpcLinkVersion;
|
|
1286
1286
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-apigatewayv2",
|
|
3
3
|
"description": "AWS SDK for JavaScript Apigatewayv2 Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.430.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,28 +21,28 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.430.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.430.0",
|
|
26
|
+
"@aws-sdk/middleware-host-header": "3.429.0",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.428.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.428.0",
|
|
29
29
|
"@aws-sdk/middleware-signing": "3.428.0",
|
|
30
30
|
"@aws-sdk/middleware-user-agent": "3.428.0",
|
|
31
|
-
"@aws-sdk/region-config-resolver": "3.
|
|
31
|
+
"@aws-sdk/region-config-resolver": "3.430.0",
|
|
32
32
|
"@aws-sdk/types": "3.428.0",
|
|
33
33
|
"@aws-sdk/util-endpoints": "3.428.0",
|
|
34
34
|
"@aws-sdk/util-user-agent-browser": "3.428.0",
|
|
35
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
36
|
-
"@smithy/config-resolver": "^2.0.
|
|
35
|
+
"@aws-sdk/util-user-agent-node": "3.430.0",
|
|
36
|
+
"@smithy/config-resolver": "^2.0.15",
|
|
37
37
|
"@smithy/fetch-http-handler": "^2.2.3",
|
|
38
38
|
"@smithy/hash-node": "^2.0.11",
|
|
39
39
|
"@smithy/invalid-dependency": "^2.0.11",
|
|
40
40
|
"@smithy/middleware-content-length": "^2.0.13",
|
|
41
|
-
"@smithy/middleware-endpoint": "^2.1.
|
|
42
|
-
"@smithy/middleware-retry": "^2.0.
|
|
41
|
+
"@smithy/middleware-endpoint": "^2.1.2",
|
|
42
|
+
"@smithy/middleware-retry": "^2.0.17",
|
|
43
43
|
"@smithy/middleware-serde": "^2.0.11",
|
|
44
44
|
"@smithy/middleware-stack": "^2.0.5",
|
|
45
|
-
"@smithy/node-config-provider": "^2.1.
|
|
45
|
+
"@smithy/node-config-provider": "^2.1.2",
|
|
46
46
|
"@smithy/node-http-handler": "^2.1.7",
|
|
47
47
|
"@smithy/protocol-http": "^3.0.7",
|
|
48
48
|
"@smithy/smithy-client": "^2.1.11",
|
|
@@ -52,7 +52,7 @@
|
|
|
52
52
|
"@smithy/util-body-length-browser": "^2.0.0",
|
|
53
53
|
"@smithy/util-body-length-node": "^2.1.0",
|
|
54
54
|
"@smithy/util-defaults-mode-browser": "^2.0.15",
|
|
55
|
-
"@smithy/util-defaults-mode-node": "^2.0.
|
|
55
|
+
"@smithy/util-defaults-mode-node": "^2.0.20",
|
|
56
56
|
"@smithy/util-retry": "^2.0.4",
|
|
57
57
|
"@smithy/util-stream": "^2.0.16",
|
|
58
58
|
"@smithy/util-utf8": "^2.0.0",
|