@aws-sdk/client-api-gateway 3.391.0 → 3.398.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/README.md +1 -1
- package/dist-cjs/APIGatewayClient.js +4 -2
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/protocols/Aws_restJson1.js +6 -0
- package/dist-cjs/runtimeConfig.shared.js +1 -0
- package/dist-cjs/runtimeExtensions.js +16 -0
- package/dist-es/APIGatewayClient.js +4 -2
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +6 -0
- package/dist-es/runtimeConfig.shared.js +1 -0
- package/dist-es/runtimeExtensions.js +12 -0
- package/dist-types/APIGateway.d.ts +1 -1
- package/dist-types/APIGatewayClient.d.ts +7 -2
- package/dist-types/commands/CreateRestApiCommand.d.ts +1 -0
- package/dist-types/commands/GetRestApiCommand.d.ts +1 -0
- package/dist-types/commands/GetRestApisCommand.d.ts +1 -0
- package/dist-types/commands/ImportRestApiCommand.d.ts +1 -0
- package/dist-types/commands/PutRestApiCommand.d.ts +1 -0
- package/dist-types/commands/UpdateRestApiCommand.d.ts +1 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/extensionConfiguration.d.ts +6 -0
- package/dist-types/index.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +37 -35
- package/dist-types/runtimeConfig.browser.d.ts +1 -0
- package/dist-types/runtimeConfig.d.ts +1 -0
- package/dist-types/runtimeConfig.native.d.ts +1 -0
- package/dist-types/runtimeConfig.shared.d.ts +1 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/APIGatewayClient.d.ts +3 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/extensionConfiguration.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +1 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/package.json +31 -31
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@ AWS SDK for JavaScript APIGateway Client for Node.js, Browser and React Native.
|
|
|
8
8
|
|
|
9
9
|
<fullname>Amazon API Gateway</fullname>
|
|
10
10
|
|
|
11
|
-
<p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on
|
|
11
|
+
<p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
|
|
12
12
|
|
|
13
13
|
## Installing
|
|
14
14
|
|
|
@@ -15,6 +15,7 @@ const smithy_client_1 = require("@smithy/smithy-client");
|
|
|
15
15
|
Object.defineProperty(exports, "__Client", { enumerable: true, get: function () { return smithy_client_1.Client; } });
|
|
16
16
|
const EndpointParameters_1 = require("./endpoint/EndpointParameters");
|
|
17
17
|
const runtimeConfig_1 = require("./runtimeConfig");
|
|
18
|
+
const runtimeExtensions_1 = require("./runtimeExtensions");
|
|
18
19
|
class APIGatewayClient extends smithy_client_1.Client {
|
|
19
20
|
constructor(...[configuration]) {
|
|
20
21
|
const _config_0 = (0, runtimeConfig_1.getRuntimeConfig)(configuration || {});
|
|
@@ -25,8 +26,9 @@ class APIGatewayClient extends smithy_client_1.Client {
|
|
|
25
26
|
const _config_5 = (0, middleware_host_header_1.resolveHostHeaderConfig)(_config_4);
|
|
26
27
|
const _config_6 = (0, middleware_signing_1.resolveAwsAuthConfig)(_config_5);
|
|
27
28
|
const _config_7 = (0, middleware_user_agent_1.resolveUserAgentConfig)(_config_6);
|
|
28
|
-
|
|
29
|
-
|
|
29
|
+
const _config_8 = (0, runtimeExtensions_1.resolveRuntimeExtensions)(_config_7, configuration?.extensions || []);
|
|
30
|
+
super(_config_8);
|
|
31
|
+
this.config = _config_8;
|
|
30
32
|
this.middlewareStack.use((0, middleware_retry_1.getRetryPlugin)(this.config));
|
|
31
33
|
this.middlewareStack.use((0, middleware_content_length_1.getContentLengthPlugin)(this.config));
|
|
32
34
|
this.middlewareStack.use((0, middleware_sdk_api_gateway_1.getAcceptHeaderPlugin)(this.config));
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
|
-
const q = "
|
|
5
|
-
const a =
|
|
6
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
4
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
5
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }, { conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ endpoint: { url: "https://apigateway-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ endpoint: { url: "https://apigateway-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ endpoint: { url: "https://apigateway.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { endpoint: { url: "https://apigateway.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -3264,6 +3264,7 @@ const de_CreateRestApiCommand = async (output, context) => {
|
|
|
3264
3264
|
minimumCompressionSize: smithy_client_1.expectInt32,
|
|
3265
3265
|
name: smithy_client_1.expectString,
|
|
3266
3266
|
policy: smithy_client_1.expectString,
|
|
3267
|
+
rootResourceId: smithy_client_1.expectString,
|
|
3267
3268
|
tags: smithy_client_1._json,
|
|
3268
3269
|
version: smithy_client_1.expectString,
|
|
3269
3270
|
warnings: smithy_client_1._json,
|
|
@@ -6014,6 +6015,7 @@ const de_GetRestApiCommand = async (output, context) => {
|
|
|
6014
6015
|
minimumCompressionSize: smithy_client_1.expectInt32,
|
|
6015
6016
|
name: smithy_client_1.expectString,
|
|
6016
6017
|
policy: smithy_client_1.expectString,
|
|
6018
|
+
rootResourceId: smithy_client_1.expectString,
|
|
6017
6019
|
tags: smithy_client_1._json,
|
|
6018
6020
|
version: smithy_client_1.expectString,
|
|
6019
6021
|
warnings: smithy_client_1._json,
|
|
@@ -6831,6 +6833,7 @@ const de_ImportRestApiCommand = async (output, context) => {
|
|
|
6831
6833
|
minimumCompressionSize: smithy_client_1.expectInt32,
|
|
6832
6834
|
name: smithy_client_1.expectString,
|
|
6833
6835
|
policy: smithy_client_1.expectString,
|
|
6836
|
+
rootResourceId: smithy_client_1.expectString,
|
|
6834
6837
|
tags: smithy_client_1._json,
|
|
6835
6838
|
version: smithy_client_1.expectString,
|
|
6836
6839
|
warnings: smithy_client_1._json,
|
|
@@ -7171,6 +7174,7 @@ const de_PutRestApiCommand = async (output, context) => {
|
|
|
7171
7174
|
minimumCompressionSize: smithy_client_1.expectInt32,
|
|
7172
7175
|
name: smithy_client_1.expectString,
|
|
7173
7176
|
policy: smithy_client_1.expectString,
|
|
7177
|
+
rootResourceId: smithy_client_1.expectString,
|
|
7174
7178
|
tags: smithy_client_1._json,
|
|
7175
7179
|
version: smithy_client_1.expectString,
|
|
7176
7180
|
warnings: smithy_client_1._json,
|
|
@@ -8345,6 +8349,7 @@ const de_UpdateRestApiCommand = async (output, context) => {
|
|
|
8345
8349
|
minimumCompressionSize: smithy_client_1.expectInt32,
|
|
8346
8350
|
name: smithy_client_1.expectString,
|
|
8347
8351
|
policy: smithy_client_1.expectString,
|
|
8352
|
+
rootResourceId: smithy_client_1.expectString,
|
|
8348
8353
|
tags: smithy_client_1._json,
|
|
8349
8354
|
version: smithy_client_1.expectString,
|
|
8350
8355
|
warnings: smithy_client_1._json,
|
|
@@ -8949,6 +8954,7 @@ const de_RestApi = (output, context) => {
|
|
|
8949
8954
|
minimumCompressionSize: smithy_client_1.expectInt32,
|
|
8950
8955
|
name: smithy_client_1.expectString,
|
|
8951
8956
|
policy: smithy_client_1.expectString,
|
|
8957
|
+
rootResourceId: smithy_client_1.expectString,
|
|
8952
8958
|
tags: smithy_client_1._json,
|
|
8953
8959
|
version: smithy_client_1.expectString,
|
|
8954
8960
|
warnings: smithy_client_1._json,
|
|
@@ -12,6 +12,7 @@ const getRuntimeConfig = (config) => ({
|
|
|
12
12
|
base64Encoder: config?.base64Encoder ?? util_base64_1.toBase64,
|
|
13
13
|
disableHostPrefix: config?.disableHostPrefix ?? false,
|
|
14
14
|
endpointProvider: config?.endpointProvider ?? endpointResolver_1.defaultEndpointResolver,
|
|
15
|
+
extensions: config?.extensions ?? [],
|
|
15
16
|
logger: config?.logger ?? new smithy_client_1.NoOpLogger(),
|
|
16
17
|
serviceId: config?.serviceId ?? "API Gateway",
|
|
17
18
|
urlParser: config?.urlParser ?? url_parser_1.parseUrl,
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.resolveRuntimeExtensions = void 0;
|
|
4
|
+
const smithy_client_1 = require("@smithy/smithy-client");
|
|
5
|
+
const asPartial = (t) => t;
|
|
6
|
+
const resolveRuntimeExtensions = (runtimeConfig, extensions) => {
|
|
7
|
+
const extensionConfiguration = {
|
|
8
|
+
...asPartial((0, smithy_client_1.getDefaultExtensionConfiguration)(runtimeConfig)),
|
|
9
|
+
};
|
|
10
|
+
extensions.forEach((extension) => extension.configure(extensionConfiguration));
|
|
11
|
+
return {
|
|
12
|
+
...runtimeConfig,
|
|
13
|
+
...(0, smithy_client_1.resolveDefaultRuntimeConfig)(extensionConfiguration),
|
|
14
|
+
};
|
|
15
|
+
};
|
|
16
|
+
exports.resolveRuntimeExtensions = resolveRuntimeExtensions;
|
|
@@ -11,6 +11,7 @@ import { getRetryPlugin, resolveRetryConfig } from "@smithy/middleware-retry";
|
|
|
11
11
|
import { Client as __Client, } from "@smithy/smithy-client";
|
|
12
12
|
import { resolveClientEndpointParameters, } from "./endpoint/EndpointParameters";
|
|
13
13
|
import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig";
|
|
14
|
+
import { resolveRuntimeExtensions } from "./runtimeExtensions";
|
|
14
15
|
export { __Client };
|
|
15
16
|
export class APIGatewayClient extends __Client {
|
|
16
17
|
constructor(...[configuration]) {
|
|
@@ -22,8 +23,9 @@ export class APIGatewayClient extends __Client {
|
|
|
22
23
|
const _config_5 = resolveHostHeaderConfig(_config_4);
|
|
23
24
|
const _config_6 = resolveAwsAuthConfig(_config_5);
|
|
24
25
|
const _config_7 = resolveUserAgentConfig(_config_6);
|
|
25
|
-
|
|
26
|
-
|
|
26
|
+
const _config_8 = resolveRuntimeExtensions(_config_7, configuration?.extensions || []);
|
|
27
|
+
super(_config_8);
|
|
28
|
+
this.config = _config_8;
|
|
27
29
|
this.middlewareStack.use(getRetryPlugin(this.config));
|
|
28
30
|
this.middlewareStack.use(getContentLengthPlugin(this.config));
|
|
29
31
|
this.middlewareStack.use(getAcceptHeaderPlugin(this.config));
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const q = "
|
|
2
|
-
const a =
|
|
3
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
1
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
2
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
3
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }, { conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ endpoint: { url: "https://apigateway-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ endpoint: { url: "https://apigateway-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ endpoint: { url: "https://apigateway.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { endpoint: { url: "https://apigateway.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -3127,6 +3127,7 @@ export const de_CreateRestApiCommand = async (output, context) => {
|
|
|
3127
3127
|
minimumCompressionSize: __expectInt32,
|
|
3128
3128
|
name: __expectString,
|
|
3129
3129
|
policy: __expectString,
|
|
3130
|
+
rootResourceId: __expectString,
|
|
3130
3131
|
tags: _json,
|
|
3131
3132
|
version: __expectString,
|
|
3132
3133
|
warnings: _json,
|
|
@@ -5817,6 +5818,7 @@ export const de_GetRestApiCommand = async (output, context) => {
|
|
|
5817
5818
|
minimumCompressionSize: __expectInt32,
|
|
5818
5819
|
name: __expectString,
|
|
5819
5820
|
policy: __expectString,
|
|
5821
|
+
rootResourceId: __expectString,
|
|
5820
5822
|
tags: _json,
|
|
5821
5823
|
version: __expectString,
|
|
5822
5824
|
warnings: _json,
|
|
@@ -6617,6 +6619,7 @@ export const de_ImportRestApiCommand = async (output, context) => {
|
|
|
6617
6619
|
minimumCompressionSize: __expectInt32,
|
|
6618
6620
|
name: __expectString,
|
|
6619
6621
|
policy: __expectString,
|
|
6622
|
+
rootResourceId: __expectString,
|
|
6620
6623
|
tags: _json,
|
|
6621
6624
|
version: __expectString,
|
|
6622
6625
|
warnings: _json,
|
|
@@ -6951,6 +6954,7 @@ export const de_PutRestApiCommand = async (output, context) => {
|
|
|
6951
6954
|
minimumCompressionSize: __expectInt32,
|
|
6952
6955
|
name: __expectString,
|
|
6953
6956
|
policy: __expectString,
|
|
6957
|
+
rootResourceId: __expectString,
|
|
6954
6958
|
tags: _json,
|
|
6955
6959
|
version: __expectString,
|
|
6956
6960
|
warnings: _json,
|
|
@@ -8103,6 +8107,7 @@ export const de_UpdateRestApiCommand = async (output, context) => {
|
|
|
8103
8107
|
minimumCompressionSize: __expectInt32,
|
|
8104
8108
|
name: __expectString,
|
|
8105
8109
|
policy: __expectString,
|
|
8110
|
+
rootResourceId: __expectString,
|
|
8106
8111
|
tags: _json,
|
|
8107
8112
|
version: __expectString,
|
|
8108
8113
|
warnings: _json,
|
|
@@ -8702,6 +8707,7 @@ const de_RestApi = (output, context) => {
|
|
|
8702
8707
|
minimumCompressionSize: __expectInt32,
|
|
8703
8708
|
name: __expectString,
|
|
8704
8709
|
policy: __expectString,
|
|
8710
|
+
rootResourceId: __expectString,
|
|
8705
8711
|
tags: _json,
|
|
8706
8712
|
version: __expectString,
|
|
8707
8713
|
warnings: _json,
|
|
@@ -9,6 +9,7 @@ export const getRuntimeConfig = (config) => ({
|
|
|
9
9
|
base64Encoder: config?.base64Encoder ?? toBase64,
|
|
10
10
|
disableHostPrefix: config?.disableHostPrefix ?? false,
|
|
11
11
|
endpointProvider: config?.endpointProvider ?? defaultEndpointResolver,
|
|
12
|
+
extensions: config?.extensions ?? [],
|
|
12
13
|
logger: config?.logger ?? new NoOpLogger(),
|
|
13
14
|
serviceId: config?.serviceId ?? "API Gateway",
|
|
14
15
|
urlParser: config?.urlParser ?? parseUrl,
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { getDefaultExtensionConfiguration, resolveDefaultRuntimeConfig } from "@smithy/smithy-client";
|
|
2
|
+
const asPartial = (t) => t;
|
|
3
|
+
export const resolveRuntimeExtensions = (runtimeConfig, extensions) => {
|
|
4
|
+
const extensionConfiguration = {
|
|
5
|
+
...asPartial(getDefaultExtensionConfiguration(runtimeConfig)),
|
|
6
|
+
};
|
|
7
|
+
extensions.forEach((extension) => extension.configure(extensionConfiguration));
|
|
8
|
+
return {
|
|
9
|
+
...runtimeConfig,
|
|
10
|
+
...resolveDefaultRuntimeConfig(extensionConfiguration),
|
|
11
|
+
};
|
|
12
|
+
};
|
|
@@ -845,7 +845,7 @@ export interface APIGateway {
|
|
|
845
845
|
/**
|
|
846
846
|
* @public
|
|
847
847
|
* <fullname>Amazon API Gateway</fullname>
|
|
848
|
-
* <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on
|
|
848
|
+
* <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
|
|
849
849
|
*/
|
|
850
850
|
export declare class APIGateway extends APIGatewayClient implements APIGateway {
|
|
851
851
|
}
|
|
@@ -129,6 +129,7 @@ import { UpdateUsageCommandInput, UpdateUsageCommandOutput } from "./commands/Up
|
|
|
129
129
|
import { UpdateUsagePlanCommandInput, UpdateUsagePlanCommandOutput } from "./commands/UpdateUsagePlanCommand";
|
|
130
130
|
import { UpdateVpcLinkCommandInput, UpdateVpcLinkCommandOutput } from "./commands/UpdateVpcLinkCommand";
|
|
131
131
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
132
|
+
import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
|
|
132
133
|
export { __Client };
|
|
133
134
|
/**
|
|
134
135
|
* @public
|
|
@@ -236,6 +237,10 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
236
237
|
* Optional logger for logging debug/info/warn/error.
|
|
237
238
|
*/
|
|
238
239
|
logger?: __Logger;
|
|
240
|
+
/**
|
|
241
|
+
* Optional extensions
|
|
242
|
+
*/
|
|
243
|
+
extensions?: RuntimeExtension[];
|
|
239
244
|
/**
|
|
240
245
|
* The {@link @smithy/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
241
246
|
*/
|
|
@@ -255,7 +260,7 @@ export interface APIGatewayClientConfig extends APIGatewayClientConfigType {
|
|
|
255
260
|
/**
|
|
256
261
|
* @public
|
|
257
262
|
*/
|
|
258
|
-
export type APIGatewayClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
263
|
+
export type APIGatewayClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
259
264
|
/**
|
|
260
265
|
* @public
|
|
261
266
|
*
|
|
@@ -266,7 +271,7 @@ export interface APIGatewayClientResolvedConfig extends APIGatewayClientResolved
|
|
|
266
271
|
/**
|
|
267
272
|
* @public
|
|
268
273
|
* <fullname>Amazon API Gateway</fullname>
|
|
269
|
-
* <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on
|
|
274
|
+
* <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
|
|
270
275
|
*/
|
|
271
276
|
export declare class APIGatewayClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, APIGatewayClientResolvedConfig> {
|
|
272
277
|
/**
|
|
@@ -65,6 +65,7 @@ export interface GetRestApisCommandOutput extends RestApis, __MetadataBearer {
|
|
|
65
65
|
* // "<keys>": "STRING_VALUE",
|
|
66
66
|
* // },
|
|
67
67
|
* // disableExecuteApiEndpoint: true || false,
|
|
68
|
+
* // rootResourceId: "STRING_VALUE",
|
|
68
69
|
* // },
|
|
69
70
|
* // ],
|
|
70
71
|
* // position: "STRING_VALUE",
|
|
@@ -15,7 +15,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
|
|
|
15
15
|
defaultSigningName: string;
|
|
16
16
|
};
|
|
17
17
|
export interface EndpointParameters extends __EndpointParameters {
|
|
18
|
-
Region
|
|
18
|
+
Region?: string;
|
|
19
19
|
UseDualStack?: boolean;
|
|
20
20
|
UseFIPS?: boolean;
|
|
21
21
|
Endpoint?: string;
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* <fullname>Amazon API Gateway</fullname>
|
|
3
|
-
* <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on
|
|
3
|
+
* <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
|
|
4
4
|
*
|
|
5
5
|
* @packageDocumentation
|
|
6
6
|
*/
|
|
@@ -80,7 +80,7 @@ export interface ApiKey {
|
|
|
80
80
|
name?: string;
|
|
81
81
|
/**
|
|
82
82
|
* @public
|
|
83
|
-
* <p>An
|
|
83
|
+
* <p>An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.</p>
|
|
84
84
|
*/
|
|
85
85
|
customerId?: string;
|
|
86
86
|
/**
|
|
@@ -371,7 +371,7 @@ export interface CreateApiKeyRequest {
|
|
|
371
371
|
stageKeys?: StageKey[];
|
|
372
372
|
/**
|
|
373
373
|
* @public
|
|
374
|
-
* <p>An
|
|
374
|
+
* <p>An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.</p>
|
|
375
375
|
*/
|
|
376
376
|
customerId?: string;
|
|
377
377
|
/**
|
|
@@ -933,7 +933,7 @@ export interface CreateDomainNameRequest {
|
|
|
933
933
|
certificateChain?: string;
|
|
934
934
|
/**
|
|
935
935
|
* @public
|
|
936
|
-
* <p>The reference to an
|
|
936
|
+
* <p>The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name. Certificate Manager is the only supported source.</p>
|
|
937
937
|
*/
|
|
938
938
|
certificateArn?: string;
|
|
939
939
|
/**
|
|
@@ -943,7 +943,7 @@ export interface CreateDomainNameRequest {
|
|
|
943
943
|
regionalCertificateName?: string;
|
|
944
944
|
/**
|
|
945
945
|
* @public
|
|
946
|
-
* <p>The reference to an
|
|
946
|
+
* <p>The reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name. Certificate Manager is the only supported source.</p>
|
|
947
947
|
*/
|
|
948
948
|
regionalCertificateArn?: string;
|
|
949
949
|
/**
|
|
@@ -1038,7 +1038,7 @@ export interface DomainName {
|
|
|
1038
1038
|
certificateName?: string;
|
|
1039
1039
|
/**
|
|
1040
1040
|
* @public
|
|
1041
|
-
* <p>The reference to an
|
|
1041
|
+
* <p>The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name. Certificate Manager is the only supported source.</p>
|
|
1042
1042
|
*/
|
|
1043
1043
|
certificateArn?: string;
|
|
1044
1044
|
/**
|
|
@@ -1063,7 +1063,7 @@ export interface DomainName {
|
|
|
1063
1063
|
regionalCertificateName?: string;
|
|
1064
1064
|
/**
|
|
1065
1065
|
* @public
|
|
1066
|
-
* <p>The reference to an
|
|
1066
|
+
* <p>The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.</p>
|
|
1067
1067
|
*/
|
|
1068
1068
|
regionalCertificateArn?: string;
|
|
1069
1069
|
/**
|
|
@@ -1287,7 +1287,7 @@ export interface IntegrationResponse {
|
|
|
1287
1287
|
statusCode?: string;
|
|
1288
1288
|
/**
|
|
1289
1289
|
* @public
|
|
1290
|
-
* <p>Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the <code>.+</code> regex to match error response. However, make sure that the error response does not contain any newline (<code>\n</code>) character in such cases. If the back end is an
|
|
1290
|
+
* <p>Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the <code>.+</code> regex to match error response. However, make sure that the error response does not contain any newline (<code>\n</code>) character in such cases. If the back end is an Lambda function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services back ends, the HTTP status code is matched.</p>
|
|
1291
1291
|
*/
|
|
1292
1292
|
selectionPattern?: string;
|
|
1293
1293
|
/**
|
|
@@ -1346,7 +1346,7 @@ export declare const IntegrationType: {
|
|
|
1346
1346
|
export type IntegrationType = (typeof IntegrationType)[keyof typeof IntegrationType];
|
|
1347
1347
|
/**
|
|
1348
1348
|
* @public
|
|
1349
|
-
* <p>Represents an HTTP
|
|
1349
|
+
* <p>Represents an <code>HTTP</code>, <code>HTTP_PROXY</code>, <code>AWS</code>, <code>AWS_PROXY</code>, or Mock integration.</p>
|
|
1350
1350
|
*/
|
|
1351
1351
|
export interface Integration {
|
|
1352
1352
|
/**
|
|
@@ -1357,23 +1357,22 @@ export interface Integration {
|
|
|
1357
1357
|
type?: IntegrationType | string;
|
|
1358
1358
|
/**
|
|
1359
1359
|
* @public
|
|
1360
|
-
* <p>Specifies the integration's HTTP method type.</p>
|
|
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>
|
|
1361
1361
|
*/
|
|
1362
1362
|
httpMethod?: string;
|
|
1363
1363
|
/**
|
|
1364
1364
|
* @public
|
|
1365
1365
|
* <p>Specifies Uniform Resource Identifier (URI) of the integration endpoint.</p>
|
|
1366
1366
|
* <p>For <code>HTTP</code> or <code>HTTP_PROXY</code> integrations, the URI must be a fully formed, encoded HTTP(S) URL
|
|
1367
|
-
*
|
|
1368
|
-
*
|
|
1369
|
-
* integration, the URI is not used for routing. For <code>AWS</code> or <code>AWS_PROXY</code> integrations, the URI is of
|
|
1367
|
+
* according to the RFC-3986 specification for standard integrations. If <code>connectionType</code> is <code>VPC_LINK</code> specify the Network Load Balancer DNS name.
|
|
1368
|
+
* For <code>AWS</code> or <code>AWS_PROXY</code> integrations, the URI is of
|
|
1370
1369
|
* the form <code>arn:aws:apigateway:\{region\}:\{subdomain.service|service\}:path|action/\{service_api\}</code>.
|
|
1371
1370
|
* Here, \{Region\} is the API Gateway region (e.g., us-east-1); \{service\} is the name of the
|
|
1372
1371
|
* integrated Amazon Web Services service (e.g., s3); and \{subdomain\} is a designated subdomain supported by
|
|
1373
1372
|
* certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service
|
|
1374
1373
|
* action-based API, using an Action=\{name\}&\{p1\}=\{v1\}&p2=\{v2\}... query string. The ensuing
|
|
1375
1374
|
* \{service_api\} refers to a supported action \{name\} plus any required input parameters.
|
|
1376
|
-
* Alternatively, path can be used for an
|
|
1375
|
+
* Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api
|
|
1377
1376
|
* refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services
|
|
1378
1377
|
* service, if applicable. For example, for integration with the S3 API of GetObject, the uri can
|
|
1379
1378
|
* be either <code>arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket=\{bucket\}&Key=\{key\}</code> or
|
|
@@ -1393,7 +1392,7 @@ export interface Integration {
|
|
|
1393
1392
|
connectionId?: string;
|
|
1394
1393
|
/**
|
|
1395
1394
|
* @public
|
|
1396
|
-
* <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 <code>arn:aws:iam::\*:user/\*</code>. To use resource-based permissions on supported
|
|
1395
|
+
* <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 <code>arn:aws:iam::\*:user/\*</code>. To use resource-based permissions on supported Amazon Web Services services, specify null.</p>
|
|
1397
1396
|
*/
|
|
1398
1397
|
credentials?: string;
|
|
1399
1398
|
/**
|
|
@@ -1615,7 +1614,7 @@ export interface CreateRestApiRequest {
|
|
|
1615
1614
|
/**
|
|
1616
1615
|
* @public
|
|
1617
1616
|
* <p>The source of the API key for metering requests according to a usage plan. Valid values
|
|
1618
|
-
* are:
|
|
1617
|
+
* are: <code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a
|
|
1619
1618
|
* request. <code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code>
|
|
1620
1619
|
* from a custom authorizer.</p>
|
|
1621
1620
|
*/
|
|
@@ -1720,6 +1719,11 @@ export interface RestApi {
|
|
|
1720
1719
|
* custom domain name to invoke your API, disable the default endpoint.</p>
|
|
1721
1720
|
*/
|
|
1722
1721
|
disableExecuteApiEndpoint?: boolean;
|
|
1722
|
+
/**
|
|
1723
|
+
* @public
|
|
1724
|
+
* <p>The API's root resource ID.</p>
|
|
1725
|
+
*/
|
|
1726
|
+
rootResourceId?: string;
|
|
1723
1727
|
}
|
|
1724
1728
|
/**
|
|
1725
1729
|
* @public
|
|
@@ -1845,52 +1849,52 @@ export type UnauthorizedCacheControlHeaderStrategy = (typeof UnauthorizedCacheCo
|
|
|
1845
1849
|
export interface MethodSetting {
|
|
1846
1850
|
/**
|
|
1847
1851
|
* @public
|
|
1848
|
-
* <p>Specifies whether Amazon CloudWatch metrics are enabled for this method
|
|
1852
|
+
* <p>Specifies whether Amazon CloudWatch metrics are enabled for this method.</p>
|
|
1849
1853
|
*/
|
|
1850
1854
|
metricsEnabled?: boolean;
|
|
1851
1855
|
/**
|
|
1852
1856
|
* @public
|
|
1853
|
-
* <p>Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
|
|
1857
|
+
* <p>Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are <code>OFF</code>, <code>ERROR</code>, and <code>INFO</code>. Choose <code>ERROR</code> to write only error-level entries to CloudWatch Logs, or choose <code>INFO</code> to include all <code>ERROR</code> events as well as extra informational events.</p>
|
|
1854
1858
|
*/
|
|
1855
1859
|
loggingLevel?: string;
|
|
1856
1860
|
/**
|
|
1857
1861
|
* @public
|
|
1858
|
-
* <p>Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs
|
|
1862
|
+
* <p>Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.</p>
|
|
1859
1863
|
*/
|
|
1860
1864
|
dataTraceEnabled?: boolean;
|
|
1861
1865
|
/**
|
|
1862
1866
|
* @public
|
|
1863
|
-
* <p>Specifies the throttling burst limit
|
|
1867
|
+
* <p>Specifies the throttling burst limit.</p>
|
|
1864
1868
|
*/
|
|
1865
1869
|
throttlingBurstLimit?: number;
|
|
1866
1870
|
/**
|
|
1867
1871
|
* @public
|
|
1868
|
-
* <p>Specifies the throttling rate limit
|
|
1872
|
+
* <p>Specifies the throttling rate limit.</p>
|
|
1869
1873
|
*/
|
|
1870
1874
|
throttlingRateLimit?: number;
|
|
1871
1875
|
/**
|
|
1872
1876
|
* @public
|
|
1873
|
-
* <p>Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached
|
|
1877
|
+
* <p>Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.</p>
|
|
1874
1878
|
*/
|
|
1875
1879
|
cachingEnabled?: boolean;
|
|
1876
1880
|
/**
|
|
1877
1881
|
* @public
|
|
1878
|
-
* <p>Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached
|
|
1882
|
+
* <p>Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.</p>
|
|
1879
1883
|
*/
|
|
1880
1884
|
cacheTtlInSeconds?: number;
|
|
1881
1885
|
/**
|
|
1882
1886
|
* @public
|
|
1883
|
-
* <p>Specifies whether the cached responses are encrypted
|
|
1887
|
+
* <p>Specifies whether the cached responses are encrypted.</p>
|
|
1884
1888
|
*/
|
|
1885
1889
|
cacheDataEncrypted?: boolean;
|
|
1886
1890
|
/**
|
|
1887
1891
|
* @public
|
|
1888
|
-
* <p>Specifies whether authorization is required for a cache invalidation request
|
|
1892
|
+
* <p>Specifies whether authorization is required for a cache invalidation request.</p>
|
|
1889
1893
|
*/
|
|
1890
1894
|
requireAuthorizationForCacheControl?: boolean;
|
|
1891
1895
|
/**
|
|
1892
1896
|
* @public
|
|
1893
|
-
* <p>Specifies how to handle unauthorized requests for cache invalidation
|
|
1897
|
+
* <p>Specifies how to handle unauthorized requests for cache invalidation.</p>
|
|
1894
1898
|
*/
|
|
1895
1899
|
unauthorizedCacheControlHeaderStrategy?: UnauthorizedCacheControlHeaderStrategy | string;
|
|
1896
1900
|
}
|
|
@@ -2096,7 +2100,7 @@ export interface UsagePlan {
|
|
|
2096
2100
|
quota?: QuotaSettings;
|
|
2097
2101
|
/**
|
|
2098
2102
|
* @public
|
|
2099
|
-
* <p>The
|
|
2103
|
+
* <p>The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.</p>
|
|
2100
2104
|
*/
|
|
2101
2105
|
productCode?: string;
|
|
2102
2106
|
/**
|
|
@@ -2169,7 +2173,7 @@ export interface CreateVpcLinkRequest {
|
|
|
2169
2173
|
description?: string;
|
|
2170
2174
|
/**
|
|
2171
2175
|
* @public
|
|
2172
|
-
* <p>The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same
|
|
2176
|
+
* <p>The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.</p>
|
|
2173
2177
|
*/
|
|
2174
2178
|
targetArns: string[] | undefined;
|
|
2175
2179
|
/**
|
|
@@ -2214,7 +2218,7 @@ export interface VpcLink {
|
|
|
2214
2218
|
description?: string;
|
|
2215
2219
|
/**
|
|
2216
2220
|
* @public
|
|
2217
|
-
* <p>The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same
|
|
2221
|
+
* <p>The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.</p>
|
|
2218
2222
|
*/
|
|
2219
2223
|
targetArns?: string[];
|
|
2220
2224
|
/**
|
|
@@ -2729,7 +2733,7 @@ export interface GetApiKeysRequest {
|
|
|
2729
2733
|
nameQuery?: string;
|
|
2730
2734
|
/**
|
|
2731
2735
|
* @public
|
|
2732
|
-
* <p>The identifier of a customer in
|
|
2736
|
+
* <p>The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.</p>
|
|
2733
2737
|
*/
|
|
2734
2738
|
customerId?: string;
|
|
2735
2739
|
/**
|
|
@@ -4080,7 +4084,7 @@ export interface ImportDocumentationPartsRequest {
|
|
|
4080
4084
|
restApiId: string | undefined;
|
|
4081
4085
|
/**
|
|
4082
4086
|
* @public
|
|
4083
|
-
* <p>A query parameter to indicate whether to overwrite (<code>
|
|
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>
|
|
4084
4088
|
*/
|
|
4085
4089
|
mode?: PutMode | string;
|
|
4086
4090
|
/**
|
|
@@ -4111,8 +4115,6 @@ export interface ImportRestApiRequest {
|
|
|
4111
4115
|
* <p> To exclude DocumentationParts from the import, set <code>parameters</code> as <code>ignore=documentation</code>.</p>
|
|
4112
4116
|
* <p> To configure the endpoint type, set <code>parameters</code> as <code>endpointConfigurationTypes=EDGE</code>, <code>endpointConfigurationTypes=REGIONAL</code>, or <code>endpointConfigurationTypes=PRIVATE</code>. The default endpoint type is <code>EDGE</code>.</p>
|
|
4113
4117
|
* <p> To handle imported <code>basepath</code>, set <code>parameters</code> as <code>basepath=ignore</code>, <code>basepath=prepend</code> or <code>basepath=split</code>.</p>
|
|
4114
|
-
* <p>For example, the AWS CLI command to exclude documentation from the imported API is:</p>
|
|
4115
|
-
* <p>The AWS CLI command to set the regional endpoint on the imported API is:</p>
|
|
4116
4118
|
*/
|
|
4117
4119
|
parameters?: Record<string, string>;
|
|
4118
4120
|
/**
|
|
@@ -4517,7 +4519,7 @@ export interface TestInvokeAuthorizerResponse {
|
|
|
4517
4519
|
log?: string;
|
|
4518
4520
|
/**
|
|
4519
4521
|
* @public
|
|
4520
|
-
* <p>The execution latency of the test authorizer request.</p>
|
|
4522
|
+
* <p>The execution latency, in ms, of the test authorizer request.</p>
|
|
4521
4523
|
*/
|
|
4522
4524
|
latency?: number;
|
|
4523
4525
|
/**
|
|
@@ -4624,7 +4626,7 @@ export interface TestInvokeMethodResponse {
|
|
|
4624
4626
|
log?: string;
|
|
4625
4627
|
/**
|
|
4626
4628
|
* @public
|
|
4627
|
-
* <p>The execution latency of the test invoke request.</p>
|
|
4629
|
+
* <p>The execution latency, in ms, of the test invoke request.</p>
|
|
4628
4630
|
*/
|
|
4629
4631
|
latency?: number;
|
|
4630
4632
|
}
|
|
@@ -4836,7 +4838,7 @@ export interface UpdateDocumentationPartRequest {
|
|
|
4836
4838
|
export interface UpdateDocumentationVersionRequest {
|
|
4837
4839
|
/**
|
|
4838
4840
|
* @public
|
|
4839
|
-
* <p>The string identifier of the associated RestApi
|
|
4841
|
+
* <p>The string identifier of the associated RestApi.</p>
|
|
4840
4842
|
*/
|
|
4841
4843
|
restApiId: string | undefined;
|
|
4842
4844
|
/**
|
|
@@ -26,6 +26,7 @@ export declare const getRuntimeConfig: (config: APIGatewayClientConfig) => {
|
|
|
26
26
|
disableHostPrefix: boolean;
|
|
27
27
|
serviceId: string;
|
|
28
28
|
logger: import("@smithy/types").Logger;
|
|
29
|
+
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
29
30
|
endpoint?: ((string | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>) & (string | import("@smithy/types").Provider<string> | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>)) | undefined;
|
|
30
31
|
endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
|
|
31
32
|
logger?: import("@smithy/types").Logger | undefined;
|
|
@@ -26,6 +26,7 @@ export declare const getRuntimeConfig: (config: APIGatewayClientConfig) => {
|
|
|
26
26
|
disableHostPrefix: boolean;
|
|
27
27
|
serviceId: string;
|
|
28
28
|
logger: import("@smithy/types").Logger;
|
|
29
|
+
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
29
30
|
endpoint?: ((string | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>) & (string | import("@smithy/types").Provider<string> | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>)) | undefined;
|
|
30
31
|
endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
|
|
31
32
|
logger?: import("@smithy/types").Logger | undefined;
|
|
@@ -24,6 +24,7 @@ export declare const getRuntimeConfig: (config: APIGatewayClientConfig) => {
|
|
|
24
24
|
maxAttempts: number | import("@smithy/types").Provider<number>;
|
|
25
25
|
retryMode: string | import("@smithy/types").Provider<string>;
|
|
26
26
|
logger: import("@smithy/types").Logger;
|
|
27
|
+
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
27
28
|
defaultsMode: import("@smithy/smithy-client").DefaultsMode | import("@smithy/types").Provider<import("@smithy/smithy-client").DefaultsMode>;
|
|
28
29
|
endpoint?: string | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2> | undefined;
|
|
29
30
|
endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
|
|
@@ -10,6 +10,7 @@ export declare const getRuntimeConfig: (config: APIGatewayClientConfig) => {
|
|
|
10
10
|
endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
|
|
11
11
|
logger?: import("@smithy/types").Logger | undefined;
|
|
12
12
|
}) => import("@smithy/types").EndpointV2;
|
|
13
|
+
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
13
14
|
logger: import("@smithy/types").Logger;
|
|
14
15
|
serviceId: string;
|
|
15
16
|
urlParser: import("@smithy/types").UrlParser;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { APIGatewayExtensionConfiguration } from "./extensionConfiguration";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
5
|
+
export interface RuntimeExtension {
|
|
6
|
+
configure(clientConfiguration: APIGatewayExtensionConfiguration): void;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* @public
|
|
10
|
+
*/
|
|
11
|
+
export interface RuntimeExtensionsConfig {
|
|
12
|
+
extensions: RuntimeExtension[];
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @internal
|
|
16
|
+
*/
|
|
17
|
+
export declare const resolveRuntimeExtensions: (runtimeConfig: any, extensions: RuntimeExtension[]) => any;
|
|
@@ -530,6 +530,7 @@ import {
|
|
|
530
530
|
ClientResolvedEndpointParameters,
|
|
531
531
|
EndpointParameters,
|
|
532
532
|
} from "./endpoint/EndpointParameters";
|
|
533
|
+
import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
|
|
533
534
|
export { __Client };
|
|
534
535
|
export type ServiceInputTypes =
|
|
535
536
|
| CreateApiKeyCommandInput
|
|
@@ -795,6 +796,7 @@ export interface ClientDefaults
|
|
|
795
796
|
maxAttempts?: number | __Provider<number>;
|
|
796
797
|
retryMode?: string | __Provider<string>;
|
|
797
798
|
logger?: __Logger;
|
|
799
|
+
extensions?: RuntimeExtension[];
|
|
798
800
|
defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
|
|
799
801
|
}
|
|
800
802
|
export type APIGatewayClientConfigType = Partial<
|
|
@@ -812,6 +814,7 @@ export interface APIGatewayClientConfig extends APIGatewayClientConfigType {}
|
|
|
812
814
|
export type APIGatewayClientResolvedConfigType =
|
|
813
815
|
__SmithyResolvedConfiguration<__HttpHandlerOptions> &
|
|
814
816
|
Required<ClientDefaults> &
|
|
817
|
+
RuntimeExtensionsConfig &
|
|
815
818
|
RegionResolvedConfig &
|
|
816
819
|
EndpointResolvedConfig<EndpointParameters> &
|
|
817
820
|
RetryResolvedConfig &
|
|
@@ -26,7 +26,7 @@ export declare const resolveClientEndpointParameters: <T>(
|
|
|
26
26
|
defaultSigningName: string;
|
|
27
27
|
};
|
|
28
28
|
export interface EndpointParameters extends __EndpointParameters {
|
|
29
|
-
Region
|
|
29
|
+
Region?: string;
|
|
30
30
|
UseDualStack?: boolean;
|
|
31
31
|
UseFIPS?: boolean;
|
|
32
32
|
Endpoint?: string;
|
|
@@ -36,6 +36,7 @@ export declare const getRuntimeConfig: (config: APIGatewayClientConfig) => {
|
|
|
36
36
|
disableHostPrefix: boolean;
|
|
37
37
|
serviceId: string;
|
|
38
38
|
logger: import("@smithy/types").Logger;
|
|
39
|
+
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
39
40
|
endpoint?:
|
|
40
41
|
| ((
|
|
41
42
|
| string
|
|
@@ -36,6 +36,7 @@ export declare const getRuntimeConfig: (config: APIGatewayClientConfig) => {
|
|
|
36
36
|
disableHostPrefix: boolean;
|
|
37
37
|
serviceId: string;
|
|
38
38
|
logger: import("@smithy/types").Logger;
|
|
39
|
+
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
39
40
|
endpoint?:
|
|
40
41
|
| ((
|
|
41
42
|
| string
|
|
@@ -32,6 +32,7 @@ export declare const getRuntimeConfig: (config: APIGatewayClientConfig) => {
|
|
|
32
32
|
maxAttempts: number | import("@smithy/types").Provider<number>;
|
|
33
33
|
retryMode: string | import("@smithy/types").Provider<string>;
|
|
34
34
|
logger: import("@smithy/types").Logger;
|
|
35
|
+
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
35
36
|
defaultsMode:
|
|
36
37
|
| import("@smithy/smithy-client").DefaultsMode
|
|
37
38
|
| import("@smithy/types").Provider<
|
|
@@ -10,6 +10,7 @@ export declare const getRuntimeConfig: (config: APIGatewayClientConfig) => {
|
|
|
10
10
|
logger?: import("@smithy/types").Logger | undefined;
|
|
11
11
|
}
|
|
12
12
|
) => import("@smithy/types").EndpointV2;
|
|
13
|
+
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
13
14
|
logger: import("@smithy/types").Logger;
|
|
14
15
|
serviceId: string;
|
|
15
16
|
urlParser: import("@smithy/types").UrlParser;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { APIGatewayExtensionConfiguration } from "./extensionConfiguration";
|
|
2
|
+
export interface RuntimeExtension {
|
|
3
|
+
configure(clientConfiguration: APIGatewayExtensionConfiguration): void;
|
|
4
|
+
}
|
|
5
|
+
export interface RuntimeExtensionsConfig {
|
|
6
|
+
extensions: RuntimeExtension[];
|
|
7
|
+
}
|
|
8
|
+
export declare const resolveRuntimeExtensions: (
|
|
9
|
+
runtimeConfig: any,
|
|
10
|
+
extensions: RuntimeExtension[]
|
|
11
|
+
) => any;
|
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.398.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,40 +21,40 @@
|
|
|
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.
|
|
27
|
-
"@aws-sdk/middleware-logger": "3.
|
|
28
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
29
|
-
"@aws-sdk/middleware-sdk-api-gateway": "3.
|
|
30
|
-
"@aws-sdk/middleware-signing": "3.
|
|
31
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
32
|
-
"@aws-sdk/types": "3.
|
|
33
|
-
"@aws-sdk/util-endpoints": "3.
|
|
34
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
35
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
36
|
-
"@smithy/config-resolver": "^2.0.
|
|
37
|
-
"@smithy/fetch-http-handler": "^2.0.
|
|
38
|
-
"@smithy/hash-node": "^2.0.
|
|
39
|
-
"@smithy/invalid-dependency": "^2.0.
|
|
40
|
-
"@smithy/middleware-content-length": "^2.0.
|
|
41
|
-
"@smithy/middleware-endpoint": "^2.0.
|
|
42
|
-
"@smithy/middleware-retry": "^2.0.
|
|
43
|
-
"@smithy/middleware-serde": "^2.0.
|
|
24
|
+
"@aws-sdk/client-sts": "3.398.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.398.0",
|
|
26
|
+
"@aws-sdk/middleware-host-header": "3.398.0",
|
|
27
|
+
"@aws-sdk/middleware-logger": "3.398.0",
|
|
28
|
+
"@aws-sdk/middleware-recursion-detection": "3.398.0",
|
|
29
|
+
"@aws-sdk/middleware-sdk-api-gateway": "3.398.0",
|
|
30
|
+
"@aws-sdk/middleware-signing": "3.398.0",
|
|
31
|
+
"@aws-sdk/middleware-user-agent": "3.398.0",
|
|
32
|
+
"@aws-sdk/types": "3.398.0",
|
|
33
|
+
"@aws-sdk/util-endpoints": "3.398.0",
|
|
34
|
+
"@aws-sdk/util-user-agent-browser": "3.398.0",
|
|
35
|
+
"@aws-sdk/util-user-agent-node": "3.398.0",
|
|
36
|
+
"@smithy/config-resolver": "^2.0.5",
|
|
37
|
+
"@smithy/fetch-http-handler": "^2.0.5",
|
|
38
|
+
"@smithy/hash-node": "^2.0.5",
|
|
39
|
+
"@smithy/invalid-dependency": "^2.0.5",
|
|
40
|
+
"@smithy/middleware-content-length": "^2.0.5",
|
|
41
|
+
"@smithy/middleware-endpoint": "^2.0.5",
|
|
42
|
+
"@smithy/middleware-retry": "^2.0.5",
|
|
43
|
+
"@smithy/middleware-serde": "^2.0.5",
|
|
44
44
|
"@smithy/middleware-stack": "^2.0.0",
|
|
45
|
-
"@smithy/node-config-provider": "^2.0.
|
|
46
|
-
"@smithy/node-http-handler": "^2.0.
|
|
47
|
-
"@smithy/protocol-http": "^2.0.
|
|
48
|
-
"@smithy/smithy-client": "^2.0.
|
|
49
|
-
"@smithy/types": "^2.2.
|
|
50
|
-
"@smithy/url-parser": "^2.0.
|
|
45
|
+
"@smithy/node-config-provider": "^2.0.5",
|
|
46
|
+
"@smithy/node-http-handler": "^2.0.5",
|
|
47
|
+
"@smithy/protocol-http": "^2.0.5",
|
|
48
|
+
"@smithy/smithy-client": "^2.0.5",
|
|
49
|
+
"@smithy/types": "^2.2.2",
|
|
50
|
+
"@smithy/url-parser": "^2.0.5",
|
|
51
51
|
"@smithy/util-base64": "^2.0.0",
|
|
52
52
|
"@smithy/util-body-length-browser": "^2.0.0",
|
|
53
|
-
"@smithy/util-body-length-node": "^2.
|
|
54
|
-
"@smithy/util-defaults-mode-browser": "^2.0.
|
|
55
|
-
"@smithy/util-defaults-mode-node": "^2.0.
|
|
53
|
+
"@smithy/util-body-length-node": "^2.1.0",
|
|
54
|
+
"@smithy/util-defaults-mode-browser": "^2.0.5",
|
|
55
|
+
"@smithy/util-defaults-mode-node": "^2.0.5",
|
|
56
56
|
"@smithy/util-retry": "^2.0.0",
|
|
57
|
-
"@smithy/util-stream": "^2.0.
|
|
57
|
+
"@smithy/util-stream": "^2.0.5",
|
|
58
58
|
"@smithy/util-utf8": "^2.0.0",
|
|
59
59
|
"tslib": "^2.5.0"
|
|
60
60
|
},
|