@aws-sdk/client-api-gateway 3.428.0 → 3.429.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.
|
@@ -227,7 +227,7 @@ export interface Authorizer {
|
|
|
227
227
|
* @public
|
|
228
228
|
* <p>The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</p>
|
|
229
229
|
*/
|
|
230
|
-
type?: AuthorizerType
|
|
230
|
+
type?: AuthorizerType;
|
|
231
231
|
/**
|
|
232
232
|
* @public
|
|
233
233
|
* <p>A list of the Amazon Cognito user pool ARNs for the <code>COGNITO_USER_POOLS</code> authorizer. Each element is of this format: <code>arn:aws:cognito-idp:\{region\}:\{account_id\}:userpool/\{user_pool_id\}</code>. For a <code>TOKEN</code> or <code>REQUEST</code> authorizer, this is not defined. </p>
|
|
@@ -449,7 +449,7 @@ export interface CreateAuthorizerRequest {
|
|
|
449
449
|
* @public
|
|
450
450
|
* <p>The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</p>
|
|
451
451
|
*/
|
|
452
|
-
type: AuthorizerType |
|
|
452
|
+
type: AuthorizerType | undefined;
|
|
453
453
|
/**
|
|
454
454
|
* @public
|
|
455
455
|
* <p>A list of the Amazon Cognito user pool ARNs for the <code>COGNITO_USER_POOLS</code> authorizer. Each element is of this format: <code>arn:aws:cognito-idp:\{region\}:\{account_id\}:userpool/\{user_pool_id\}</code>. For a <code>TOKEN</code> or <code>REQUEST</code> authorizer, this is not defined. </p>
|
|
@@ -622,7 +622,7 @@ export interface CreateDeploymentRequest {
|
|
|
622
622
|
* @public
|
|
623
623
|
* <p>The stage's cache capacity in GB. For more information about choosing a cache size, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html">Enabling API caching to enhance responsiveness</a>.</p>
|
|
624
624
|
*/
|
|
625
|
-
cacheClusterSize?: CacheClusterSize
|
|
625
|
+
cacheClusterSize?: CacheClusterSize;
|
|
626
626
|
/**
|
|
627
627
|
* @public
|
|
628
628
|
* <p>A map that defines the stage variables for the Stage resource that is associated
|
|
@@ -727,7 +727,7 @@ export interface DocumentationPartLocation {
|
|
|
727
727
|
* @public
|
|
728
728
|
* <p>The type of API entity to which the documentation content applies. Valid values are <code>API</code>, <code>AUTHORIZER</code>, <code>MODEL</code>, <code>RESOURCE</code>, <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. Content inheritance does not apply to any entity of the <code>API</code>, <code>AUTHORIZER</code>, <code>METHOD</code>, <code>MODEL</code>, <code>REQUEST_BODY</code>, or <code>RESOURCE</code> type.</p>
|
|
729
729
|
*/
|
|
730
|
-
type: DocumentationPartType |
|
|
730
|
+
type: DocumentationPartType | undefined;
|
|
731
731
|
/**
|
|
732
732
|
* @public
|
|
733
733
|
* <p>The URL path of the target. It is a valid field for the API entity types of <code>RESOURCE</code>, <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. The default value is <code>/</code> for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other <code>location</code> attributes, the child entity's <code>path</code> attribute must match that of the parent entity as a prefix.</p>
|
|
@@ -860,7 +860,7 @@ export interface EndpointConfiguration {
|
|
|
860
860
|
* @public
|
|
861
861
|
* <p>A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is <code>"EDGE"</code>. For a regional API and its custom domain name, the endpoint type is <code>REGIONAL</code>. For a private API, the endpoint type is <code>PRIVATE</code>.</p>
|
|
862
862
|
*/
|
|
863
|
-
types?:
|
|
863
|
+
types?: EndpointType[];
|
|
864
864
|
/**
|
|
865
865
|
* @public
|
|
866
866
|
* <p>A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for <code>PRIVATE</code> endpoint type.</p>
|
|
@@ -960,7 +960,7 @@ export interface CreateDomainNameRequest {
|
|
|
960
960
|
* @public
|
|
961
961
|
* <p>The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are <code>TLS_1_0</code> and <code>TLS_1_2</code>.</p>
|
|
962
962
|
*/
|
|
963
|
-
securityPolicy?: SecurityPolicy
|
|
963
|
+
securityPolicy?: SecurityPolicy;
|
|
964
964
|
/**
|
|
965
965
|
* @public
|
|
966
966
|
* <p>The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway
|
|
@@ -1085,7 +1085,7 @@ export interface DomainName {
|
|
|
1085
1085
|
* @public
|
|
1086
1086
|
* <p>The status of the DomainName migration. The valid values are <code>AVAILABLE</code> and <code>UPDATING</code>. If the status is <code>UPDATING</code>, the domain cannot be modified further until the existing operation is complete. If it is <code>AVAILABLE</code>, the domain can be updated.</p>
|
|
1087
1087
|
*/
|
|
1088
|
-
domainNameStatus?: DomainNameStatus
|
|
1088
|
+
domainNameStatus?: DomainNameStatus;
|
|
1089
1089
|
/**
|
|
1090
1090
|
* @public
|
|
1091
1091
|
* <p>An optional text message containing detailed information about status of the DomainName migration.</p>
|
|
@@ -1095,7 +1095,7 @@ export interface DomainName {
|
|
|
1095
1095
|
* @public
|
|
1096
1096
|
* <p>The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are <code>TLS_1_0</code> and <code>TLS_1_2</code>.</p>
|
|
1097
1097
|
*/
|
|
1098
|
-
securityPolicy?: SecurityPolicy
|
|
1098
|
+
securityPolicy?: SecurityPolicy;
|
|
1099
1099
|
/**
|
|
1100
1100
|
* @public
|
|
1101
1101
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
@@ -1306,7 +1306,7 @@ export interface IntegrationResponse {
|
|
|
1306
1306
|
* <p>Specifies how to handle response payload content type conversions. Supported values are <code>CONVERT_TO_BINARY</code> and <code>CONVERT_TO_TEXT</code>, with the following behaviors:</p>
|
|
1307
1307
|
* <p>If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.</p>
|
|
1308
1308
|
*/
|
|
1309
|
-
contentHandling?: ContentHandlingStrategy
|
|
1309
|
+
contentHandling?: ContentHandlingStrategy;
|
|
1310
1310
|
}
|
|
1311
1311
|
/**
|
|
1312
1312
|
* @public
|
|
@@ -1354,7 +1354,7 @@ export interface Integration {
|
|
|
1354
1354
|
* <p>Specifies an API method integration type. The valid value is one of the following:</p>
|
|
1355
1355
|
* <p>For the HTTP and HTTP proxy integrations, each integration can specify a protocol (<code>http/https</code>), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a <code>connectionType</code> of <code>VPC_LINK</code> is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.</p>
|
|
1356
1356
|
*/
|
|
1357
|
-
type?: IntegrationType
|
|
1357
|
+
type?: IntegrationType;
|
|
1358
1358
|
/**
|
|
1359
1359
|
* @public
|
|
1360
1360
|
* <p>Specifies the integration's HTTP method type. For the Type property, if you specify <code>MOCK</code>, this property is optional. For Lambda integrations, you must set the integration method to <code>POST</code>. For all other types, you must specify this property.</p>
|
|
@@ -1384,7 +1384,7 @@ export interface Integration {
|
|
|
1384
1384
|
* @public
|
|
1385
1385
|
* <p>The type of the network connection to the integration endpoint. The valid value is <code>INTERNET</code> for connections through the public routable internet or <code>VPC_LINK</code> for private connections between API Gateway and a network load balancer in a VPC. The default value is <code>INTERNET</code>.</p>
|
|
1386
1386
|
*/
|
|
1387
|
-
connectionType?: ConnectionType
|
|
1387
|
+
connectionType?: ConnectionType;
|
|
1388
1388
|
/**
|
|
1389
1389
|
* @public
|
|
1390
1390
|
* <p>The ID of the VpcLink used for the integration when <code>connectionType=VPC_LINK</code> and undefined, otherwise.</p>
|
|
@@ -1429,7 +1429,7 @@ export interface Integration {
|
|
|
1429
1429
|
* <p>Specifies how to handle request payload content type conversions. Supported values are <code>CONVERT_TO_BINARY</code> and <code>CONVERT_TO_TEXT</code>, with the following behaviors:</p>
|
|
1430
1430
|
* <p>If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the <code>passthroughBehavior</code> is configured to support payload pass-through.</p>
|
|
1431
1431
|
*/
|
|
1432
|
-
contentHandling?: ContentHandlingStrategy
|
|
1432
|
+
contentHandling?: ContentHandlingStrategy;
|
|
1433
1433
|
/**
|
|
1434
1434
|
* @public
|
|
1435
1435
|
* <p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.</p>
|
|
@@ -1618,7 +1618,7 @@ export interface CreateRestApiRequest {
|
|
|
1618
1618
|
* request. <code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code>
|
|
1619
1619
|
* from a custom authorizer.</p>
|
|
1620
1620
|
*/
|
|
1621
|
-
apiKeySource?: ApiKeySourceType
|
|
1621
|
+
apiKeySource?: ApiKeySourceType;
|
|
1622
1622
|
/**
|
|
1623
1623
|
* @public
|
|
1624
1624
|
* <p>The endpoint configuration of this RestApi showing the endpoint types of the API. </p>
|
|
@@ -1695,7 +1695,7 @@ export interface RestApi {
|
|
|
1695
1695
|
* request. <code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code>
|
|
1696
1696
|
* from a custom authorizer.</p>
|
|
1697
1697
|
*/
|
|
1698
|
-
apiKeySource?: ApiKeySourceType
|
|
1698
|
+
apiKeySource?: ApiKeySourceType;
|
|
1699
1699
|
/**
|
|
1700
1700
|
* @public
|
|
1701
1701
|
* <p>The endpoint configuration of this RestApi showing the endpoint types of the API. </p>
|
|
@@ -1785,7 +1785,7 @@ export interface CreateStageRequest {
|
|
|
1785
1785
|
* @public
|
|
1786
1786
|
* <p>The stage's cache capacity in GB. For more information about choosing a cache size, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html">Enabling API caching to enhance responsiveness</a>.</p>
|
|
1787
1787
|
*/
|
|
1788
|
-
cacheClusterSize?: CacheClusterSize
|
|
1788
|
+
cacheClusterSize?: CacheClusterSize;
|
|
1789
1789
|
/**
|
|
1790
1790
|
* @public
|
|
1791
1791
|
* <p>A map that defines the stage variables for the new Stage resource. Variable names
|
|
@@ -1896,7 +1896,7 @@ export interface MethodSetting {
|
|
|
1896
1896
|
* @public
|
|
1897
1897
|
* <p>Specifies how to handle unauthorized requests for cache invalidation.</p>
|
|
1898
1898
|
*/
|
|
1899
|
-
unauthorizedCacheControlHeaderStrategy?: UnauthorizedCacheControlHeaderStrategy
|
|
1899
|
+
unauthorizedCacheControlHeaderStrategy?: UnauthorizedCacheControlHeaderStrategy;
|
|
1900
1900
|
}
|
|
1901
1901
|
/**
|
|
1902
1902
|
* @public
|
|
@@ -1932,12 +1932,12 @@ export interface Stage {
|
|
|
1932
1932
|
* @public
|
|
1933
1933
|
* <p>The stage's cache capacity in GB. For more information about choosing a cache size, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html">Enabling API caching to enhance responsiveness</a>.</p>
|
|
1934
1934
|
*/
|
|
1935
|
-
cacheClusterSize?: CacheClusterSize
|
|
1935
|
+
cacheClusterSize?: CacheClusterSize;
|
|
1936
1936
|
/**
|
|
1937
1937
|
* @public
|
|
1938
1938
|
* <p>The status of the cache cluster for the stage, if enabled.</p>
|
|
1939
1939
|
*/
|
|
1940
|
-
cacheClusterStatus?: CacheClusterStatus
|
|
1940
|
+
cacheClusterStatus?: CacheClusterStatus;
|
|
1941
1941
|
/**
|
|
1942
1942
|
* @public
|
|
1943
1943
|
* <p>A map that defines the method settings for a Stage resource. Keys (designated as <code>/\{method_setting_key</code> below) are method paths defined as <code>\{resource_path\}/\{http_method\}</code> for an individual method override, or <code>/\*\/\*</code> for overriding all methods in the stage. </p>
|
|
@@ -2022,7 +2022,7 @@ export interface QuotaSettings {
|
|
|
2022
2022
|
* @public
|
|
2023
2023
|
* <p>The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".</p>
|
|
2024
2024
|
*/
|
|
2025
|
-
period?: QuotaPeriodType
|
|
2025
|
+
period?: QuotaPeriodType;
|
|
2026
2026
|
}
|
|
2027
2027
|
/**
|
|
2028
2028
|
* @public
|
|
@@ -2225,7 +2225,7 @@ export interface VpcLink {
|
|
|
2225
2225
|
* @public
|
|
2226
2226
|
* <p>The status of the VPC link. The valid values are <code>AVAILABLE</code>, <code>PENDING</code>, <code>DELETING</code>, or <code>FAILED</code>. Deploying an API will wait if the status is <code>PENDING</code> and will fail if the status is <code>DELETING</code>. </p>
|
|
2227
2227
|
*/
|
|
2228
|
-
status?: VpcLinkStatus
|
|
2228
|
+
status?: VpcLinkStatus;
|
|
2229
2229
|
/**
|
|
2230
2230
|
* @public
|
|
2231
2231
|
* <p>A description about the VPC link status.</p>
|
|
@@ -2396,7 +2396,7 @@ export interface DeleteGatewayResponseRequest {
|
|
|
2396
2396
|
* @public
|
|
2397
2397
|
* <p>The response type of the associated GatewayResponse.</p>
|
|
2398
2398
|
*/
|
|
2399
|
-
responseType: GatewayResponseType |
|
|
2399
|
+
responseType: GatewayResponseType | undefined;
|
|
2400
2400
|
}
|
|
2401
2401
|
/**
|
|
2402
2402
|
* @public
|
|
@@ -2991,7 +2991,7 @@ export interface GetDocumentationPartsRequest {
|
|
|
2991
2991
|
* @public
|
|
2992
2992
|
* <p>The type of API entities of the to-be-retrieved documentation parts. </p>
|
|
2993
2993
|
*/
|
|
2994
|
-
type?: DocumentationPartType
|
|
2994
|
+
type?: DocumentationPartType;
|
|
2995
2995
|
/**
|
|
2996
2996
|
* @public
|
|
2997
2997
|
* <p>The name of API entities of the to-be-retrieved documentation parts.</p>
|
|
@@ -3016,7 +3016,7 @@ export interface GetDocumentationPartsRequest {
|
|
|
3016
3016
|
* @public
|
|
3017
3017
|
* <p>The status of the API documentation parts to retrieve. Valid values are <code>DOCUMENTED</code> for retrieving DocumentationPart resources with content and <code>UNDOCUMENTED</code> for DocumentationPart resources without content.</p>
|
|
3018
3018
|
*/
|
|
3019
|
-
locationStatus?: LocationStatusType
|
|
3019
|
+
locationStatus?: LocationStatusType;
|
|
3020
3020
|
}
|
|
3021
3021
|
/**
|
|
3022
3022
|
* @public
|
|
@@ -3176,7 +3176,7 @@ export interface GatewayResponse {
|
|
|
3176
3176
|
* @public
|
|
3177
3177
|
* <p>The response type of the associated GatewayResponse.</p>
|
|
3178
3178
|
*/
|
|
3179
|
-
responseType?: GatewayResponseType
|
|
3179
|
+
responseType?: GatewayResponseType;
|
|
3180
3180
|
/**
|
|
3181
3181
|
* @public
|
|
3182
3182
|
* <p>The HTTP status code for this GatewayResponse.</p>
|
|
@@ -3213,7 +3213,7 @@ export interface GetGatewayResponseRequest {
|
|
|
3213
3213
|
* @public
|
|
3214
3214
|
* <p>The response type of the associated GatewayResponse.</p>
|
|
3215
3215
|
*/
|
|
3216
|
-
responseType: GatewayResponseType |
|
|
3216
|
+
responseType: GatewayResponseType | undefined;
|
|
3217
3217
|
}
|
|
3218
3218
|
/**
|
|
3219
3219
|
* @public
|
|
@@ -4037,7 +4037,7 @@ export interface ImportApiKeysRequest {
|
|
|
4037
4037
|
* @public
|
|
4038
4038
|
* <p>A query parameter to specify the input format to imported API keys. Currently, only the <code>csv</code> format is supported.</p>
|
|
4039
4039
|
*/
|
|
4040
|
-
format: ApiKeysFormat |
|
|
4040
|
+
format: ApiKeysFormat | undefined;
|
|
4041
4041
|
/**
|
|
4042
4042
|
* @public
|
|
4043
4043
|
* <p>A query parameter to indicate whether to rollback ApiKey importation (<code>true</code>) or not (<code>false</code>) when error is encountered.</p>
|
|
@@ -4086,7 +4086,7 @@ export interface ImportDocumentationPartsRequest {
|
|
|
4086
4086
|
* @public
|
|
4087
4087
|
* <p>A query parameter to indicate whether to overwrite (<code>overwrite</code>) any existing DocumentationParts definition or to merge (<code>merge</code>) the new definition into the existing one. The default value is <code>merge</code>.</p>
|
|
4088
4088
|
*/
|
|
4089
|
-
mode?: PutMode
|
|
4089
|
+
mode?: PutMode;
|
|
4090
4090
|
/**
|
|
4091
4091
|
* @public
|
|
4092
4092
|
* <p>A query parameter to specify whether to rollback the documentation importation (<code>true</code>) or not (<code>false</code>) when a warning is encountered. The default value is <code>false</code>.</p>
|
|
@@ -4137,7 +4137,7 @@ export interface PutGatewayResponseRequest {
|
|
|
4137
4137
|
* @public
|
|
4138
4138
|
* <p>The response type of the associated GatewayResponse</p>
|
|
4139
4139
|
*/
|
|
4140
|
-
responseType: GatewayResponseType |
|
|
4140
|
+
responseType: GatewayResponseType | undefined;
|
|
4141
4141
|
/**
|
|
4142
4142
|
* @public
|
|
4143
4143
|
* <p>The HTTP status code of the GatewayResponse.</p>
|
|
@@ -4178,7 +4178,7 @@ export interface PutIntegrationRequest {
|
|
|
4178
4178
|
* @public
|
|
4179
4179
|
* <p>Specifies a put integration input's type.</p>
|
|
4180
4180
|
*/
|
|
4181
|
-
type: IntegrationType |
|
|
4181
|
+
type: IntegrationType | undefined;
|
|
4182
4182
|
/**
|
|
4183
4183
|
* @public
|
|
4184
4184
|
* <p>The HTTP method for the integration.</p>
|
|
@@ -4208,7 +4208,7 @@ export interface PutIntegrationRequest {
|
|
|
4208
4208
|
* @public
|
|
4209
4209
|
* <p>The type of the network connection to the integration endpoint. The valid value is <code>INTERNET</code> for connections through the public routable internet or <code>VPC_LINK</code> for private connections between API Gateway and a network load balancer in a VPC. The default value is <code>INTERNET</code>.</p>
|
|
4210
4210
|
*/
|
|
4211
|
-
connectionType?: ConnectionType
|
|
4211
|
+
connectionType?: ConnectionType;
|
|
4212
4212
|
/**
|
|
4213
4213
|
* @public
|
|
4214
4214
|
* <p>The ID of the VpcLink used for the integration. Specify this value only if you specify <code>VPC_LINK</code> as the connection type.</p>
|
|
@@ -4250,7 +4250,7 @@ export interface PutIntegrationRequest {
|
|
|
4250
4250
|
* <p>Specifies how to handle request payload content type conversions. Supported values are <code>CONVERT_TO_BINARY</code> and <code>CONVERT_TO_TEXT</code>, with the following behaviors:</p>
|
|
4251
4251
|
* <p>If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the <code>passthroughBehavior</code> is configured to support payload pass-through.</p>
|
|
4252
4252
|
*/
|
|
4253
|
-
contentHandling?: ContentHandlingStrategy
|
|
4253
|
+
contentHandling?: ContentHandlingStrategy;
|
|
4254
4254
|
/**
|
|
4255
4255
|
* @public
|
|
4256
4256
|
* <p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.</p>
|
|
@@ -4308,7 +4308,7 @@ export interface PutIntegrationResponseRequest {
|
|
|
4308
4308
|
* <p>Specifies how to handle response payload content type conversions. Supported values are <code>CONVERT_TO_BINARY</code> and <code>CONVERT_TO_TEXT</code>, with the following behaviors:</p>
|
|
4309
4309
|
* <p>If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.</p>
|
|
4310
4310
|
*/
|
|
4311
|
-
contentHandling?: ContentHandlingStrategy
|
|
4311
|
+
contentHandling?: ContentHandlingStrategy;
|
|
4312
4312
|
}
|
|
4313
4313
|
/**
|
|
4314
4314
|
* @public
|
|
@@ -4422,7 +4422,7 @@ export interface PutRestApiRequest {
|
|
|
4422
4422
|
* <p>The <code>mode</code> query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default,
|
|
4423
4423
|
* the update mode is "merge".</p>
|
|
4424
4424
|
*/
|
|
4425
|
-
mode?: PutMode
|
|
4425
|
+
mode?: PutMode;
|
|
4426
4426
|
/**
|
|
4427
4427
|
* @public
|
|
4428
4428
|
* <p>A query parameter to indicate whether to rollback the API update (<code>true</code>) or not (<code>false</code>)
|
|
@@ -4674,7 +4674,7 @@ export interface PatchOperation {
|
|
|
4674
4674
|
* resource. Support of the operations depends on specific operational contexts. Attempts
|
|
4675
4675
|
* to apply an unsupported operation on a resource will return an error message..</p>
|
|
4676
4676
|
*/
|
|
4677
|
-
op?: Op
|
|
4677
|
+
op?: Op;
|
|
4678
4678
|
/**
|
|
4679
4679
|
* @public
|
|
4680
4680
|
* <p>The op operation's target, as identified by a JSON Pointer value that references a
|
|
@@ -4882,7 +4882,7 @@ export interface UpdateGatewayResponseRequest {
|
|
|
4882
4882
|
* @public
|
|
4883
4883
|
* <p>The response type of the associated GatewayResponse.</p>
|
|
4884
4884
|
*/
|
|
4885
|
-
responseType: GatewayResponseType |
|
|
4885
|
+
responseType: GatewayResponseType | undefined;
|
|
4886
4886
|
/**
|
|
4887
4887
|
* @public
|
|
4888
4888
|
* <p>For more information about supported patch operations, see <a href="https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html">Patch Operations</a>.</p>
|
|
@@ -60,7 +60,7 @@ export type AuthorizerType =
|
|
|
60
60
|
export interface Authorizer {
|
|
61
61
|
id?: string;
|
|
62
62
|
name?: string;
|
|
63
|
-
type?: AuthorizerType
|
|
63
|
+
type?: AuthorizerType;
|
|
64
64
|
providerARNs?: string[];
|
|
65
65
|
authType?: string;
|
|
66
66
|
authorizerUri?: string;
|
|
@@ -130,7 +130,7 @@ export declare class UnauthorizedException extends __BaseException {
|
|
|
130
130
|
export interface CreateAuthorizerRequest {
|
|
131
131
|
restApiId: string | undefined;
|
|
132
132
|
name: string | undefined;
|
|
133
|
-
type: AuthorizerType |
|
|
133
|
+
type: AuthorizerType | undefined;
|
|
134
134
|
providerARNs?: string[];
|
|
135
135
|
authType?: string;
|
|
136
136
|
authorizerUri?: string;
|
|
@@ -173,7 +173,7 @@ export interface CreateDeploymentRequest {
|
|
|
173
173
|
stageDescription?: string;
|
|
174
174
|
description?: string;
|
|
175
175
|
cacheClusterEnabled?: boolean;
|
|
176
|
-
cacheClusterSize?: CacheClusterSize
|
|
176
|
+
cacheClusterSize?: CacheClusterSize;
|
|
177
177
|
variables?: Record<string, string>;
|
|
178
178
|
canarySettings?: DeploymentCanarySettings;
|
|
179
179
|
tracingEnabled?: boolean;
|
|
@@ -213,7 +213,7 @@ export declare const DocumentationPartType: {
|
|
|
213
213
|
export type DocumentationPartType =
|
|
214
214
|
(typeof DocumentationPartType)[keyof typeof DocumentationPartType];
|
|
215
215
|
export interface DocumentationPartLocation {
|
|
216
|
-
type: DocumentationPartType |
|
|
216
|
+
type: DocumentationPartType | undefined;
|
|
217
217
|
path?: string;
|
|
218
218
|
method?: string;
|
|
219
219
|
statusCode?: string;
|
|
@@ -247,7 +247,7 @@ export declare const EndpointType: {
|
|
|
247
247
|
};
|
|
248
248
|
export type EndpointType = (typeof EndpointType)[keyof typeof EndpointType];
|
|
249
249
|
export interface EndpointConfiguration {
|
|
250
|
-
types?:
|
|
250
|
+
types?: EndpointType[];
|
|
251
251
|
vpcEndpointIds?: string[];
|
|
252
252
|
}
|
|
253
253
|
export interface MutualTlsAuthenticationInput {
|
|
@@ -271,7 +271,7 @@ export interface CreateDomainNameRequest {
|
|
|
271
271
|
regionalCertificateArn?: string;
|
|
272
272
|
endpointConfiguration?: EndpointConfiguration;
|
|
273
273
|
tags?: Record<string, string>;
|
|
274
|
-
securityPolicy?: SecurityPolicy
|
|
274
|
+
securityPolicy?: SecurityPolicy;
|
|
275
275
|
mutualTlsAuthentication?: MutualTlsAuthenticationInput;
|
|
276
276
|
ownershipVerificationCertificateArn?: string;
|
|
277
277
|
}
|
|
@@ -301,9 +301,9 @@ export interface DomainName {
|
|
|
301
301
|
distributionDomainName?: string;
|
|
302
302
|
distributionHostedZoneId?: string;
|
|
303
303
|
endpointConfiguration?: EndpointConfiguration;
|
|
304
|
-
domainNameStatus?: DomainNameStatus
|
|
304
|
+
domainNameStatus?: DomainNameStatus;
|
|
305
305
|
domainNameStatusMessage?: string;
|
|
306
|
-
securityPolicy?: SecurityPolicy
|
|
306
|
+
securityPolicy?: SecurityPolicy;
|
|
307
307
|
tags?: Record<string, string>;
|
|
308
308
|
mutualTlsAuthentication?: MutualTlsAuthentication;
|
|
309
309
|
ownershipVerificationCertificateArn?: string;
|
|
@@ -356,7 +356,7 @@ export interface IntegrationResponse {
|
|
|
356
356
|
selectionPattern?: string;
|
|
357
357
|
responseParameters?: Record<string, string>;
|
|
358
358
|
responseTemplates?: Record<string, string>;
|
|
359
|
-
contentHandling?: ContentHandlingStrategy
|
|
359
|
+
contentHandling?: ContentHandlingStrategy;
|
|
360
360
|
}
|
|
361
361
|
export interface TlsConfig {
|
|
362
362
|
insecureSkipVerification?: boolean;
|
|
@@ -371,16 +371,16 @@ export declare const IntegrationType: {
|
|
|
371
371
|
export type IntegrationType =
|
|
372
372
|
(typeof IntegrationType)[keyof typeof IntegrationType];
|
|
373
373
|
export interface Integration {
|
|
374
|
-
type?: IntegrationType
|
|
374
|
+
type?: IntegrationType;
|
|
375
375
|
httpMethod?: string;
|
|
376
376
|
uri?: string;
|
|
377
|
-
connectionType?: ConnectionType
|
|
377
|
+
connectionType?: ConnectionType;
|
|
378
378
|
connectionId?: string;
|
|
379
379
|
credentials?: string;
|
|
380
380
|
requestParameters?: Record<string, string>;
|
|
381
381
|
requestTemplates?: Record<string, string>;
|
|
382
382
|
passthroughBehavior?: string;
|
|
383
|
-
contentHandling?: ContentHandlingStrategy
|
|
383
|
+
contentHandling?: ContentHandlingStrategy;
|
|
384
384
|
timeoutInMillis?: number;
|
|
385
385
|
cacheNamespace?: string;
|
|
386
386
|
cacheKeyParameters?: string[];
|
|
@@ -419,7 +419,7 @@ export interface CreateRestApiRequest {
|
|
|
419
419
|
cloneFrom?: string;
|
|
420
420
|
binaryMediaTypes?: string[];
|
|
421
421
|
minimumCompressionSize?: number;
|
|
422
|
-
apiKeySource?: ApiKeySourceType
|
|
422
|
+
apiKeySource?: ApiKeySourceType;
|
|
423
423
|
endpointConfiguration?: EndpointConfiguration;
|
|
424
424
|
policy?: string;
|
|
425
425
|
tags?: Record<string, string>;
|
|
@@ -434,7 +434,7 @@ export interface RestApi {
|
|
|
434
434
|
warnings?: string[];
|
|
435
435
|
binaryMediaTypes?: string[];
|
|
436
436
|
minimumCompressionSize?: number;
|
|
437
|
-
apiKeySource?: ApiKeySourceType
|
|
437
|
+
apiKeySource?: ApiKeySourceType;
|
|
438
438
|
endpointConfiguration?: EndpointConfiguration;
|
|
439
439
|
policy?: string;
|
|
440
440
|
tags?: Record<string, string>;
|
|
@@ -453,7 +453,7 @@ export interface CreateStageRequest {
|
|
|
453
453
|
deploymentId: string | undefined;
|
|
454
454
|
description?: string;
|
|
455
455
|
cacheClusterEnabled?: boolean;
|
|
456
|
-
cacheClusterSize?: CacheClusterSize
|
|
456
|
+
cacheClusterSize?: CacheClusterSize;
|
|
457
457
|
variables?: Record<string, string>;
|
|
458
458
|
documentationVersion?: string;
|
|
459
459
|
canarySettings?: CanarySettings;
|
|
@@ -486,9 +486,7 @@ export interface MethodSetting {
|
|
|
486
486
|
cacheTtlInSeconds?: number;
|
|
487
487
|
cacheDataEncrypted?: boolean;
|
|
488
488
|
requireAuthorizationForCacheControl?: boolean;
|
|
489
|
-
unauthorizedCacheControlHeaderStrategy?:
|
|
490
|
-
| UnauthorizedCacheControlHeaderStrategy
|
|
491
|
-
| string;
|
|
489
|
+
unauthorizedCacheControlHeaderStrategy?: UnauthorizedCacheControlHeaderStrategy;
|
|
492
490
|
}
|
|
493
491
|
export interface Stage {
|
|
494
492
|
deploymentId?: string;
|
|
@@ -496,8 +494,8 @@ export interface Stage {
|
|
|
496
494
|
stageName?: string;
|
|
497
495
|
description?: string;
|
|
498
496
|
cacheClusterEnabled?: boolean;
|
|
499
|
-
cacheClusterSize?: CacheClusterSize
|
|
500
|
-
cacheClusterStatus?: CacheClusterStatus
|
|
497
|
+
cacheClusterSize?: CacheClusterSize;
|
|
498
|
+
cacheClusterStatus?: CacheClusterStatus;
|
|
501
499
|
methodSettings?: Record<string, MethodSetting>;
|
|
502
500
|
variables?: Record<string, string>;
|
|
503
501
|
documentationVersion?: string;
|
|
@@ -519,7 +517,7 @@ export type QuotaPeriodType =
|
|
|
519
517
|
export interface QuotaSettings {
|
|
520
518
|
limit?: number;
|
|
521
519
|
offset?: number;
|
|
522
|
-
period?: QuotaPeriodType
|
|
520
|
+
period?: QuotaPeriodType;
|
|
523
521
|
}
|
|
524
522
|
export interface CreateUsagePlanRequest {
|
|
525
523
|
name: string | undefined;
|
|
@@ -568,7 +566,7 @@ export interface VpcLink {
|
|
|
568
566
|
name?: string;
|
|
569
567
|
description?: string;
|
|
570
568
|
targetArns?: string[];
|
|
571
|
-
status?: VpcLinkStatus
|
|
569
|
+
status?: VpcLinkStatus;
|
|
572
570
|
statusMessage?: string;
|
|
573
571
|
tags?: Record<string, string>;
|
|
574
572
|
}
|
|
@@ -628,7 +626,7 @@ export type GatewayResponseType =
|
|
|
628
626
|
(typeof GatewayResponseType)[keyof typeof GatewayResponseType];
|
|
629
627
|
export interface DeleteGatewayResponseRequest {
|
|
630
628
|
restApiId: string | undefined;
|
|
631
|
-
responseType: GatewayResponseType |
|
|
629
|
+
responseType: GatewayResponseType | undefined;
|
|
632
630
|
}
|
|
633
631
|
export interface DeleteIntegrationRequest {
|
|
634
632
|
restApiId: string | undefined;
|
|
@@ -776,12 +774,12 @@ export type LocationStatusType =
|
|
|
776
774
|
(typeof LocationStatusType)[keyof typeof LocationStatusType];
|
|
777
775
|
export interface GetDocumentationPartsRequest {
|
|
778
776
|
restApiId: string | undefined;
|
|
779
|
-
type?: DocumentationPartType
|
|
777
|
+
type?: DocumentationPartType;
|
|
780
778
|
nameQuery?: string;
|
|
781
779
|
path?: string;
|
|
782
780
|
position?: string;
|
|
783
781
|
limit?: number;
|
|
784
|
-
locationStatus?: LocationStatusType
|
|
782
|
+
locationStatus?: LocationStatusType;
|
|
785
783
|
}
|
|
786
784
|
export interface GetDocumentationVersionRequest {
|
|
787
785
|
restApiId: string | undefined;
|
|
@@ -820,7 +818,7 @@ export interface GetExportRequest {
|
|
|
820
818
|
accepts?: string;
|
|
821
819
|
}
|
|
822
820
|
export interface GatewayResponse {
|
|
823
|
-
responseType?: GatewayResponseType
|
|
821
|
+
responseType?: GatewayResponseType;
|
|
824
822
|
statusCode?: string;
|
|
825
823
|
responseParameters?: Record<string, string>;
|
|
826
824
|
responseTemplates?: Record<string, string>;
|
|
@@ -828,7 +826,7 @@ export interface GatewayResponse {
|
|
|
828
826
|
}
|
|
829
827
|
export interface GetGatewayResponseRequest {
|
|
830
828
|
restApiId: string | undefined;
|
|
831
|
-
responseType: GatewayResponseType |
|
|
829
|
+
responseType: GatewayResponseType | undefined;
|
|
832
830
|
}
|
|
833
831
|
export interface GatewayResponses {
|
|
834
832
|
items?: GatewayResponse[];
|
|
@@ -1028,7 +1026,7 @@ export interface VpcLinks {
|
|
|
1028
1026
|
}
|
|
1029
1027
|
export interface ImportApiKeysRequest {
|
|
1030
1028
|
body: Uint8Array | undefined;
|
|
1031
|
-
format: ApiKeysFormat |
|
|
1029
|
+
format: ApiKeysFormat | undefined;
|
|
1032
1030
|
failOnWarnings?: boolean;
|
|
1033
1031
|
}
|
|
1034
1032
|
export interface DocumentationPartIds {
|
|
@@ -1042,7 +1040,7 @@ export declare const PutMode: {
|
|
|
1042
1040
|
export type PutMode = (typeof PutMode)[keyof typeof PutMode];
|
|
1043
1041
|
export interface ImportDocumentationPartsRequest {
|
|
1044
1042
|
restApiId: string | undefined;
|
|
1045
|
-
mode?: PutMode
|
|
1043
|
+
mode?: PutMode;
|
|
1046
1044
|
failOnWarnings?: boolean;
|
|
1047
1045
|
body: Uint8Array | undefined;
|
|
1048
1046
|
}
|
|
@@ -1053,7 +1051,7 @@ export interface ImportRestApiRequest {
|
|
|
1053
1051
|
}
|
|
1054
1052
|
export interface PutGatewayResponseRequest {
|
|
1055
1053
|
restApiId: string | undefined;
|
|
1056
|
-
responseType: GatewayResponseType |
|
|
1054
|
+
responseType: GatewayResponseType | undefined;
|
|
1057
1055
|
statusCode?: string;
|
|
1058
1056
|
responseParameters?: Record<string, string>;
|
|
1059
1057
|
responseTemplates?: Record<string, string>;
|
|
@@ -1062,10 +1060,10 @@ export interface PutIntegrationRequest {
|
|
|
1062
1060
|
restApiId: string | undefined;
|
|
1063
1061
|
resourceId: string | undefined;
|
|
1064
1062
|
httpMethod: string | undefined;
|
|
1065
|
-
type: IntegrationType |
|
|
1063
|
+
type: IntegrationType | undefined;
|
|
1066
1064
|
integrationHttpMethod?: string;
|
|
1067
1065
|
uri?: string;
|
|
1068
|
-
connectionType?: ConnectionType
|
|
1066
|
+
connectionType?: ConnectionType;
|
|
1069
1067
|
connectionId?: string;
|
|
1070
1068
|
credentials?: string;
|
|
1071
1069
|
requestParameters?: Record<string, string>;
|
|
@@ -1073,7 +1071,7 @@ export interface PutIntegrationRequest {
|
|
|
1073
1071
|
passthroughBehavior?: string;
|
|
1074
1072
|
cacheNamespace?: string;
|
|
1075
1073
|
cacheKeyParameters?: string[];
|
|
1076
|
-
contentHandling?: ContentHandlingStrategy
|
|
1074
|
+
contentHandling?: ContentHandlingStrategy;
|
|
1077
1075
|
timeoutInMillis?: number;
|
|
1078
1076
|
tlsConfig?: TlsConfig;
|
|
1079
1077
|
}
|
|
@@ -1085,7 +1083,7 @@ export interface PutIntegrationResponseRequest {
|
|
|
1085
1083
|
selectionPattern?: string;
|
|
1086
1084
|
responseParameters?: Record<string, string>;
|
|
1087
1085
|
responseTemplates?: Record<string, string>;
|
|
1088
|
-
contentHandling?: ContentHandlingStrategy
|
|
1086
|
+
contentHandling?: ContentHandlingStrategy;
|
|
1089
1087
|
}
|
|
1090
1088
|
export interface PutMethodRequest {
|
|
1091
1089
|
restApiId: string | undefined;
|
|
@@ -1110,7 +1108,7 @@ export interface PutMethodResponseRequest {
|
|
|
1110
1108
|
}
|
|
1111
1109
|
export interface PutRestApiRequest {
|
|
1112
1110
|
restApiId: string | undefined;
|
|
1113
|
-
mode?: PutMode
|
|
1111
|
+
mode?: PutMode;
|
|
1114
1112
|
failOnWarnings?: boolean;
|
|
1115
1113
|
parameters?: Record<string, string>;
|
|
1116
1114
|
body: Uint8Array | undefined;
|
|
@@ -1171,7 +1169,7 @@ export declare const Op: {
|
|
|
1171
1169
|
};
|
|
1172
1170
|
export type Op = (typeof Op)[keyof typeof Op];
|
|
1173
1171
|
export interface PatchOperation {
|
|
1174
|
-
op?: Op
|
|
1172
|
+
op?: Op;
|
|
1175
1173
|
path?: string;
|
|
1176
1174
|
value?: string;
|
|
1177
1175
|
from?: string;
|
|
@@ -1218,7 +1216,7 @@ export interface UpdateDomainNameRequest {
|
|
|
1218
1216
|
}
|
|
1219
1217
|
export interface UpdateGatewayResponseRequest {
|
|
1220
1218
|
restApiId: string | undefined;
|
|
1221
|
-
responseType: GatewayResponseType |
|
|
1219
|
+
responseType: GatewayResponseType | undefined;
|
|
1222
1220
|
patchOperations?: PatchOperation[];
|
|
1223
1221
|
}
|
|
1224
1222
|
export interface UpdateIntegrationRequest {
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-api-gateway",
|
|
3
3
|
"description": "AWS SDK for JavaScript Api Gateway Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.429.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,9 +21,9 @@
|
|
|
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.429.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.429.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-sdk-api-gateway": "3.428.0",
|
|
@@ -39,7 +39,7 @@
|
|
|
39
39
|
"@smithy/hash-node": "^2.0.11",
|
|
40
40
|
"@smithy/invalid-dependency": "^2.0.11",
|
|
41
41
|
"@smithy/middleware-content-length": "^2.0.13",
|
|
42
|
-
"@smithy/middleware-endpoint": "^2.1.
|
|
42
|
+
"@smithy/middleware-endpoint": "^2.1.1",
|
|
43
43
|
"@smithy/middleware-retry": "^2.0.16",
|
|
44
44
|
"@smithy/middleware-serde": "^2.0.11",
|
|
45
45
|
"@smithy/middleware-stack": "^2.0.5",
|