@aws-sdk/client-apigatewayv2 3.821.0 → 3.823.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 +47 -7
- package/dist-cjs/index.js +395 -2
- package/dist-es/ApiGatewayV2.js +10 -0
- package/dist-es/commands/CreateRoutingRuleCommand.js +22 -0
- package/dist-es/commands/DeleteRoutingRuleCommand.js +22 -0
- package/dist-es/commands/GetRoutingRuleCommand.js +22 -0
- package/dist-es/commands/ListRoutingRulesCommand.js +22 -0
- package/dist-es/commands/PutRoutingRuleCommand.js +22 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/index.js +1 -0
- package/dist-es/models/models_0.js +5 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListRoutingRulesPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +300 -0
- package/dist-types/ApiGatewayV2.d.ts +35 -0
- package/dist-types/ApiGatewayV2Client.d.ts +7 -2
- package/dist-types/commands/CreateDomainNameCommand.d.ts +3 -0
- package/dist-types/commands/CreateRoutingRuleCommand.d.ts +140 -0
- package/dist-types/commands/DeleteRoutingRuleCommand.d.ts +81 -0
- package/dist-types/commands/GetDomainNameCommand.d.ts +2 -0
- package/dist-types/commands/GetDomainNamesCommand.d.ts +2 -0
- package/dist-types/commands/GetRoutingRuleCommand.d.ts +111 -0
- package/dist-types/commands/ListRoutingRulesCommand.d.ts +117 -0
- package/dist-types/commands/PutRoutingRuleCommand.d.ts +141 -0
- package/dist-types/commands/UpdateDomainNameCommand.d.ts +3 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +415 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListRoutingRulesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
- package/dist-types/ts3.4/ApiGatewayV2.d.ts +85 -0
- package/dist-types/ts3.4/ApiGatewayV2Client.d.ts +30 -0
- package/dist-types/ts3.4/commands/CreateRoutingRuleCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteRoutingRuleCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/GetRoutingRuleCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListRoutingRulesCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/PutRoutingRuleCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +101 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListRoutingRulesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
- package/package.json +5 -5
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApiGatewayV2Client";
|
|
4
|
+
import { CreateRoutingRuleRequest, CreateRoutingRuleResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateRoutingRuleCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateRoutingRuleCommandInput extends CreateRoutingRuleRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateRoutingRuleCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateRoutingRuleCommandOutput extends CreateRoutingRuleResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateRoutingRuleCommand_base: {
|
|
25
|
+
new (input: CreateRoutingRuleCommandInput): import("@smithy/smithy-client").CommandImpl<CreateRoutingRuleCommandInput, CreateRoutingRuleCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: CreateRoutingRuleCommandInput): import("@smithy/smithy-client").CommandImpl<CreateRoutingRuleCommandInput, CreateRoutingRuleCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates a RoutingRule</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ApiGatewayV2Client, CreateRoutingRuleCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
|
|
35
|
+
* // const { ApiGatewayV2Client, CreateRoutingRuleCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import
|
|
36
|
+
* const client = new ApiGatewayV2Client(config);
|
|
37
|
+
* const input = { // CreateRoutingRuleRequest
|
|
38
|
+
* Actions: [ // __listOfRoutingRuleAction // required
|
|
39
|
+
* { // RoutingRuleAction
|
|
40
|
+
* InvokeApi: { // RoutingRuleActionInvokeApi
|
|
41
|
+
* ApiId: "STRING_VALUE", // required
|
|
42
|
+
* Stage: "STRING_VALUE", // required
|
|
43
|
+
* StripBasePath: true || false,
|
|
44
|
+
* },
|
|
45
|
+
* },
|
|
46
|
+
* ],
|
|
47
|
+
* Conditions: [ // __listOfRoutingRuleCondition // required
|
|
48
|
+
* { // RoutingRuleCondition
|
|
49
|
+
* MatchBasePaths: { // RoutingRuleMatchBasePaths
|
|
50
|
+
* AnyOf: [ // __listOfSelectionKey // required
|
|
51
|
+
* "STRING_VALUE",
|
|
52
|
+
* ],
|
|
53
|
+
* },
|
|
54
|
+
* MatchHeaders: { // RoutingRuleMatchHeaders
|
|
55
|
+
* AnyOf: [ // __listOfRoutingRuleMatchHeaderValue // required
|
|
56
|
+
* { // RoutingRuleMatchHeaderValue
|
|
57
|
+
* Header: "STRING_VALUE", // required
|
|
58
|
+
* ValueGlob: "STRING_VALUE", // required
|
|
59
|
+
* },
|
|
60
|
+
* ],
|
|
61
|
+
* },
|
|
62
|
+
* },
|
|
63
|
+
* ],
|
|
64
|
+
* DomainName: "STRING_VALUE", // required
|
|
65
|
+
* DomainNameId: "STRING_VALUE",
|
|
66
|
+
* Priority: Number("int"), // required
|
|
67
|
+
* };
|
|
68
|
+
* const command = new CreateRoutingRuleCommand(input);
|
|
69
|
+
* const response = await client.send(command);
|
|
70
|
+
* // { // CreateRoutingRuleResponse
|
|
71
|
+
* // Actions: [ // __listOfRoutingRuleAction
|
|
72
|
+
* // { // RoutingRuleAction
|
|
73
|
+
* // InvokeApi: { // RoutingRuleActionInvokeApi
|
|
74
|
+
* // ApiId: "STRING_VALUE", // required
|
|
75
|
+
* // Stage: "STRING_VALUE", // required
|
|
76
|
+
* // StripBasePath: true || false,
|
|
77
|
+
* // },
|
|
78
|
+
* // },
|
|
79
|
+
* // ],
|
|
80
|
+
* // Conditions: [ // __listOfRoutingRuleCondition
|
|
81
|
+
* // { // RoutingRuleCondition
|
|
82
|
+
* // MatchBasePaths: { // RoutingRuleMatchBasePaths
|
|
83
|
+
* // AnyOf: [ // __listOfSelectionKey // required
|
|
84
|
+
* // "STRING_VALUE",
|
|
85
|
+
* // ],
|
|
86
|
+
* // },
|
|
87
|
+
* // MatchHeaders: { // RoutingRuleMatchHeaders
|
|
88
|
+
* // AnyOf: [ // __listOfRoutingRuleMatchHeaderValue // required
|
|
89
|
+
* // { // RoutingRuleMatchHeaderValue
|
|
90
|
+
* // Header: "STRING_VALUE", // required
|
|
91
|
+
* // ValueGlob: "STRING_VALUE", // required
|
|
92
|
+
* // },
|
|
93
|
+
* // ],
|
|
94
|
+
* // },
|
|
95
|
+
* // },
|
|
96
|
+
* // ],
|
|
97
|
+
* // Priority: Number("int"),
|
|
98
|
+
* // RoutingRuleArn: "STRING_VALUE",
|
|
99
|
+
* // RoutingRuleId: "STRING_VALUE",
|
|
100
|
+
* // };
|
|
101
|
+
*
|
|
102
|
+
* ```
|
|
103
|
+
*
|
|
104
|
+
* @param CreateRoutingRuleCommandInput - {@link CreateRoutingRuleCommandInput}
|
|
105
|
+
* @returns {@link CreateRoutingRuleCommandOutput}
|
|
106
|
+
* @see {@link CreateRoutingRuleCommandInput} for command's `input` shape.
|
|
107
|
+
* @see {@link CreateRoutingRuleCommandOutput} for command's `response` shape.
|
|
108
|
+
* @see {@link ApiGatewayV2ClientResolvedConfig | config} for ApiGatewayV2Client's `config` shape.
|
|
109
|
+
*
|
|
110
|
+
* @throws {@link BadRequestException} (client fault)
|
|
111
|
+
* <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link ConflictException} (client fault)
|
|
114
|
+
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
|
|
115
|
+
*
|
|
116
|
+
* @throws {@link NotFoundException} (client fault)
|
|
117
|
+
* <p>The resource specified in the request was not found. See the message field for more information.</p>
|
|
118
|
+
*
|
|
119
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
120
|
+
* <p>A limit has been exceeded. See the accompanying error message for details.</p>
|
|
121
|
+
*
|
|
122
|
+
* @throws {@link ApiGatewayV2ServiceException}
|
|
123
|
+
* <p>Base exception class for all service exceptions from ApiGatewayV2 service.</p>
|
|
124
|
+
*
|
|
125
|
+
*
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
export declare class CreateRoutingRuleCommand extends CreateRoutingRuleCommand_base {
|
|
129
|
+
/** @internal type navigation helper, not in runtime. */
|
|
130
|
+
protected static __types: {
|
|
131
|
+
api: {
|
|
132
|
+
input: CreateRoutingRuleRequest;
|
|
133
|
+
output: CreateRoutingRuleResponse;
|
|
134
|
+
};
|
|
135
|
+
sdk: {
|
|
136
|
+
input: CreateRoutingRuleCommandInput;
|
|
137
|
+
output: CreateRoutingRuleCommandOutput;
|
|
138
|
+
};
|
|
139
|
+
};
|
|
140
|
+
}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApiGatewayV2Client";
|
|
4
|
+
import { DeleteRoutingRuleRequest } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteRoutingRuleCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteRoutingRuleCommandInput extends DeleteRoutingRuleRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteRoutingRuleCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteRoutingRuleCommandOutput extends __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteRoutingRuleCommand_base: {
|
|
25
|
+
new (input: DeleteRoutingRuleCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteRoutingRuleCommandInput, DeleteRoutingRuleCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeleteRoutingRuleCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteRoutingRuleCommandInput, DeleteRoutingRuleCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes a routing rule.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ApiGatewayV2Client, DeleteRoutingRuleCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
|
|
35
|
+
* // const { ApiGatewayV2Client, DeleteRoutingRuleCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import
|
|
36
|
+
* const client = new ApiGatewayV2Client(config);
|
|
37
|
+
* const input = { // DeleteRoutingRuleRequest
|
|
38
|
+
* DomainName: "STRING_VALUE", // required
|
|
39
|
+
* DomainNameId: "STRING_VALUE",
|
|
40
|
+
* RoutingRuleId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new DeleteRoutingRuleCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // {};
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param DeleteRoutingRuleCommandInput - {@link DeleteRoutingRuleCommandInput}
|
|
49
|
+
* @returns {@link DeleteRoutingRuleCommandOutput}
|
|
50
|
+
* @see {@link DeleteRoutingRuleCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link DeleteRoutingRuleCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link ApiGatewayV2ClientResolvedConfig | config} for ApiGatewayV2Client's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link BadRequestException} (client fault)
|
|
55
|
+
* <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link NotFoundException} (client fault)
|
|
58
|
+
* <p>The resource specified in the request was not found. See the message field for more information.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
61
|
+
* <p>A limit has been exceeded. See the accompanying error message for details.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ApiGatewayV2ServiceException}
|
|
64
|
+
* <p>Base exception class for all service exceptions from ApiGatewayV2 service.</p>
|
|
65
|
+
*
|
|
66
|
+
*
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
export declare class DeleteRoutingRuleCommand extends DeleteRoutingRuleCommand_base {
|
|
70
|
+
/** @internal type navigation helper, not in runtime. */
|
|
71
|
+
protected static __types: {
|
|
72
|
+
api: {
|
|
73
|
+
input: DeleteRoutingRuleRequest;
|
|
74
|
+
output: {};
|
|
75
|
+
};
|
|
76
|
+
sdk: {
|
|
77
|
+
input: DeleteRoutingRuleCommandInput;
|
|
78
|
+
output: DeleteRoutingRuleCommandOutput;
|
|
79
|
+
};
|
|
80
|
+
};
|
|
81
|
+
}
|
|
@@ -42,6 +42,7 @@ declare const GetDomainNameCommand_base: {
|
|
|
42
42
|
* // { // GetDomainNameResponse
|
|
43
43
|
* // ApiMappingSelectionExpression: "STRING_VALUE",
|
|
44
44
|
* // DomainName: "STRING_VALUE",
|
|
45
|
+
* // DomainNameArn: "STRING_VALUE",
|
|
45
46
|
* // DomainNameConfigurations: [ // DomainNameConfigurations
|
|
46
47
|
* // { // DomainNameConfiguration
|
|
47
48
|
* // ApiGatewayDomainName: "STRING_VALUE",
|
|
@@ -64,6 +65,7 @@ declare const GetDomainNameCommand_base: {
|
|
|
64
65
|
* // "STRING_VALUE",
|
|
65
66
|
* // ],
|
|
66
67
|
* // },
|
|
68
|
+
* // RoutingMode: "API_MAPPING_ONLY" || "ROUTING_RULE_ONLY" || "ROUTING_RULE_THEN_API_MAPPING",
|
|
67
69
|
* // Tags: { // Tags
|
|
68
70
|
* // "<keys>": "STRING_VALUE",
|
|
69
71
|
* // },
|
|
@@ -45,6 +45,7 @@ declare const GetDomainNamesCommand_base: {
|
|
|
45
45
|
* // { // DomainName
|
|
46
46
|
* // ApiMappingSelectionExpression: "STRING_VALUE",
|
|
47
47
|
* // DomainName: "STRING_VALUE", // required
|
|
48
|
+
* // DomainNameArn: "STRING_VALUE",
|
|
48
49
|
* // DomainNameConfigurations: [ // DomainNameConfigurations
|
|
49
50
|
* // { // DomainNameConfiguration
|
|
50
51
|
* // ApiGatewayDomainName: "STRING_VALUE",
|
|
@@ -67,6 +68,7 @@ declare const GetDomainNamesCommand_base: {
|
|
|
67
68
|
* // "STRING_VALUE",
|
|
68
69
|
* // ],
|
|
69
70
|
* // },
|
|
71
|
+
* // RoutingMode: "API_MAPPING_ONLY" || "ROUTING_RULE_ONLY" || "ROUTING_RULE_THEN_API_MAPPING",
|
|
70
72
|
* // Tags: { // Tags
|
|
71
73
|
* // "<keys>": "STRING_VALUE",
|
|
72
74
|
* // },
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApiGatewayV2Client";
|
|
4
|
+
import { GetRoutingRuleRequest, GetRoutingRuleResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetRoutingRuleCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetRoutingRuleCommandInput extends GetRoutingRuleRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetRoutingRuleCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetRoutingRuleCommandOutput extends GetRoutingRuleResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetRoutingRuleCommand_base: {
|
|
25
|
+
new (input: GetRoutingRuleCommandInput): import("@smithy/smithy-client").CommandImpl<GetRoutingRuleCommandInput, GetRoutingRuleCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetRoutingRuleCommandInput): import("@smithy/smithy-client").CommandImpl<GetRoutingRuleCommandInput, GetRoutingRuleCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Gets a routing rule.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ApiGatewayV2Client, GetRoutingRuleCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
|
|
35
|
+
* // const { ApiGatewayV2Client, GetRoutingRuleCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import
|
|
36
|
+
* const client = new ApiGatewayV2Client(config);
|
|
37
|
+
* const input = { // GetRoutingRuleRequest
|
|
38
|
+
* DomainName: "STRING_VALUE", // required
|
|
39
|
+
* DomainNameId: "STRING_VALUE",
|
|
40
|
+
* RoutingRuleId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetRoutingRuleCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetRoutingRuleResponse
|
|
45
|
+
* // Actions: [ // __listOfRoutingRuleAction
|
|
46
|
+
* // { // RoutingRuleAction
|
|
47
|
+
* // InvokeApi: { // RoutingRuleActionInvokeApi
|
|
48
|
+
* // ApiId: "STRING_VALUE", // required
|
|
49
|
+
* // Stage: "STRING_VALUE", // required
|
|
50
|
+
* // StripBasePath: true || false,
|
|
51
|
+
* // },
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // Conditions: [ // __listOfRoutingRuleCondition
|
|
55
|
+
* // { // RoutingRuleCondition
|
|
56
|
+
* // MatchBasePaths: { // RoutingRuleMatchBasePaths
|
|
57
|
+
* // AnyOf: [ // __listOfSelectionKey // required
|
|
58
|
+
* // "STRING_VALUE",
|
|
59
|
+
* // ],
|
|
60
|
+
* // },
|
|
61
|
+
* // MatchHeaders: { // RoutingRuleMatchHeaders
|
|
62
|
+
* // AnyOf: [ // __listOfRoutingRuleMatchHeaderValue // required
|
|
63
|
+
* // { // RoutingRuleMatchHeaderValue
|
|
64
|
+
* // Header: "STRING_VALUE", // required
|
|
65
|
+
* // ValueGlob: "STRING_VALUE", // required
|
|
66
|
+
* // },
|
|
67
|
+
* // ],
|
|
68
|
+
* // },
|
|
69
|
+
* // },
|
|
70
|
+
* // ],
|
|
71
|
+
* // Priority: Number("int"),
|
|
72
|
+
* // RoutingRuleArn: "STRING_VALUE",
|
|
73
|
+
* // RoutingRuleId: "STRING_VALUE",
|
|
74
|
+
* // };
|
|
75
|
+
*
|
|
76
|
+
* ```
|
|
77
|
+
*
|
|
78
|
+
* @param GetRoutingRuleCommandInput - {@link GetRoutingRuleCommandInput}
|
|
79
|
+
* @returns {@link GetRoutingRuleCommandOutput}
|
|
80
|
+
* @see {@link GetRoutingRuleCommandInput} for command's `input` shape.
|
|
81
|
+
* @see {@link GetRoutingRuleCommandOutput} for command's `response` shape.
|
|
82
|
+
* @see {@link ApiGatewayV2ClientResolvedConfig | config} for ApiGatewayV2Client's `config` shape.
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link BadRequestException} (client fault)
|
|
85
|
+
* <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link NotFoundException} (client fault)
|
|
88
|
+
* <p>The resource specified in the request was not found. See the message field for more information.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
91
|
+
* <p>A limit has been exceeded. See the accompanying error message for details.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link ApiGatewayV2ServiceException}
|
|
94
|
+
* <p>Base exception class for all service exceptions from ApiGatewayV2 service.</p>
|
|
95
|
+
*
|
|
96
|
+
*
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
export declare class GetRoutingRuleCommand extends GetRoutingRuleCommand_base {
|
|
100
|
+
/** @internal type navigation helper, not in runtime. */
|
|
101
|
+
protected static __types: {
|
|
102
|
+
api: {
|
|
103
|
+
input: GetRoutingRuleRequest;
|
|
104
|
+
output: GetRoutingRuleResponse;
|
|
105
|
+
};
|
|
106
|
+
sdk: {
|
|
107
|
+
input: GetRoutingRuleCommandInput;
|
|
108
|
+
output: GetRoutingRuleCommandOutput;
|
|
109
|
+
};
|
|
110
|
+
};
|
|
111
|
+
}
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApiGatewayV2Client";
|
|
4
|
+
import { ListRoutingRulesRequest, ListRoutingRulesResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListRoutingRulesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListRoutingRulesCommandInput extends ListRoutingRulesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListRoutingRulesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListRoutingRulesCommandOutput extends ListRoutingRulesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListRoutingRulesCommand_base: {
|
|
25
|
+
new (input: ListRoutingRulesCommandInput): import("@smithy/smithy-client").CommandImpl<ListRoutingRulesCommandInput, ListRoutingRulesCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListRoutingRulesCommandInput): import("@smithy/smithy-client").CommandImpl<ListRoutingRulesCommandInput, ListRoutingRulesCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists routing rules.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ApiGatewayV2Client, ListRoutingRulesCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
|
|
35
|
+
* // const { ApiGatewayV2Client, ListRoutingRulesCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import
|
|
36
|
+
* const client = new ApiGatewayV2Client(config);
|
|
37
|
+
* const input = { // ListRoutingRulesRequest
|
|
38
|
+
* DomainName: "STRING_VALUE", // required
|
|
39
|
+
* DomainNameId: "STRING_VALUE",
|
|
40
|
+
* MaxResults: Number("int"),
|
|
41
|
+
* NextToken: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListRoutingRulesCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListRoutingRulesResponse
|
|
46
|
+
* // NextToken: "STRING_VALUE",
|
|
47
|
+
* // RoutingRules: [ // __listOfRoutingRule
|
|
48
|
+
* // { // RoutingRule
|
|
49
|
+
* // Actions: [ // __listOfRoutingRuleAction
|
|
50
|
+
* // { // RoutingRuleAction
|
|
51
|
+
* // InvokeApi: { // RoutingRuleActionInvokeApi
|
|
52
|
+
* // ApiId: "STRING_VALUE", // required
|
|
53
|
+
* // Stage: "STRING_VALUE", // required
|
|
54
|
+
* // StripBasePath: true || false,
|
|
55
|
+
* // },
|
|
56
|
+
* // },
|
|
57
|
+
* // ],
|
|
58
|
+
* // Conditions: [ // __listOfRoutingRuleCondition
|
|
59
|
+
* // { // RoutingRuleCondition
|
|
60
|
+
* // MatchBasePaths: { // RoutingRuleMatchBasePaths
|
|
61
|
+
* // AnyOf: [ // __listOfSelectionKey // required
|
|
62
|
+
* // "STRING_VALUE",
|
|
63
|
+
* // ],
|
|
64
|
+
* // },
|
|
65
|
+
* // MatchHeaders: { // RoutingRuleMatchHeaders
|
|
66
|
+
* // AnyOf: [ // __listOfRoutingRuleMatchHeaderValue // required
|
|
67
|
+
* // { // RoutingRuleMatchHeaderValue
|
|
68
|
+
* // Header: "STRING_VALUE", // required
|
|
69
|
+
* // ValueGlob: "STRING_VALUE", // required
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // },
|
|
73
|
+
* // },
|
|
74
|
+
* // ],
|
|
75
|
+
* // Priority: Number("int"),
|
|
76
|
+
* // RoutingRuleArn: "STRING_VALUE",
|
|
77
|
+
* // RoutingRuleId: "STRING_VALUE",
|
|
78
|
+
* // },
|
|
79
|
+
* // ],
|
|
80
|
+
* // };
|
|
81
|
+
*
|
|
82
|
+
* ```
|
|
83
|
+
*
|
|
84
|
+
* @param ListRoutingRulesCommandInput - {@link ListRoutingRulesCommandInput}
|
|
85
|
+
* @returns {@link ListRoutingRulesCommandOutput}
|
|
86
|
+
* @see {@link ListRoutingRulesCommandInput} for command's `input` shape.
|
|
87
|
+
* @see {@link ListRoutingRulesCommandOutput} for command's `response` shape.
|
|
88
|
+
* @see {@link ApiGatewayV2ClientResolvedConfig | config} for ApiGatewayV2Client's `config` shape.
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link BadRequestException} (client fault)
|
|
91
|
+
* <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link NotFoundException} (client fault)
|
|
94
|
+
* <p>The resource specified in the request was not found. See the message field for more information.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
97
|
+
* <p>A limit has been exceeded. See the accompanying error message for details.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link ApiGatewayV2ServiceException}
|
|
100
|
+
* <p>Base exception class for all service exceptions from ApiGatewayV2 service.</p>
|
|
101
|
+
*
|
|
102
|
+
*
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
export declare class ListRoutingRulesCommand extends ListRoutingRulesCommand_base {
|
|
106
|
+
/** @internal type navigation helper, not in runtime. */
|
|
107
|
+
protected static __types: {
|
|
108
|
+
api: {
|
|
109
|
+
input: ListRoutingRulesRequest;
|
|
110
|
+
output: ListRoutingRulesResponse;
|
|
111
|
+
};
|
|
112
|
+
sdk: {
|
|
113
|
+
input: ListRoutingRulesCommandInput;
|
|
114
|
+
output: ListRoutingRulesCommandOutput;
|
|
115
|
+
};
|
|
116
|
+
};
|
|
117
|
+
}
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApiGatewayV2Client";
|
|
4
|
+
import { PutRoutingRuleRequest, PutRoutingRuleResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link PutRoutingRuleCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface PutRoutingRuleCommandInput extends PutRoutingRuleRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link PutRoutingRuleCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface PutRoutingRuleCommandOutput extends PutRoutingRuleResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const PutRoutingRuleCommand_base: {
|
|
25
|
+
new (input: PutRoutingRuleCommandInput): import("@smithy/smithy-client").CommandImpl<PutRoutingRuleCommandInput, PutRoutingRuleCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: PutRoutingRuleCommandInput): import("@smithy/smithy-client").CommandImpl<PutRoutingRuleCommandInput, PutRoutingRuleCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates a routing rule.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ApiGatewayV2Client, PutRoutingRuleCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
|
|
35
|
+
* // const { ApiGatewayV2Client, PutRoutingRuleCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import
|
|
36
|
+
* const client = new ApiGatewayV2Client(config);
|
|
37
|
+
* const input = { // PutRoutingRuleRequest
|
|
38
|
+
* Actions: [ // __listOfRoutingRuleAction // required
|
|
39
|
+
* { // RoutingRuleAction
|
|
40
|
+
* InvokeApi: { // RoutingRuleActionInvokeApi
|
|
41
|
+
* ApiId: "STRING_VALUE", // required
|
|
42
|
+
* Stage: "STRING_VALUE", // required
|
|
43
|
+
* StripBasePath: true || false,
|
|
44
|
+
* },
|
|
45
|
+
* },
|
|
46
|
+
* ],
|
|
47
|
+
* Conditions: [ // __listOfRoutingRuleCondition // required
|
|
48
|
+
* { // RoutingRuleCondition
|
|
49
|
+
* MatchBasePaths: { // RoutingRuleMatchBasePaths
|
|
50
|
+
* AnyOf: [ // __listOfSelectionKey // required
|
|
51
|
+
* "STRING_VALUE",
|
|
52
|
+
* ],
|
|
53
|
+
* },
|
|
54
|
+
* MatchHeaders: { // RoutingRuleMatchHeaders
|
|
55
|
+
* AnyOf: [ // __listOfRoutingRuleMatchHeaderValue // required
|
|
56
|
+
* { // RoutingRuleMatchHeaderValue
|
|
57
|
+
* Header: "STRING_VALUE", // required
|
|
58
|
+
* ValueGlob: "STRING_VALUE", // required
|
|
59
|
+
* },
|
|
60
|
+
* ],
|
|
61
|
+
* },
|
|
62
|
+
* },
|
|
63
|
+
* ],
|
|
64
|
+
* DomainName: "STRING_VALUE", // required
|
|
65
|
+
* DomainNameId: "STRING_VALUE",
|
|
66
|
+
* Priority: Number("int"), // required
|
|
67
|
+
* RoutingRuleId: "STRING_VALUE", // required
|
|
68
|
+
* };
|
|
69
|
+
* const command = new PutRoutingRuleCommand(input);
|
|
70
|
+
* const response = await client.send(command);
|
|
71
|
+
* // { // PutRoutingRuleResponse
|
|
72
|
+
* // Actions: [ // __listOfRoutingRuleAction
|
|
73
|
+
* // { // RoutingRuleAction
|
|
74
|
+
* // InvokeApi: { // RoutingRuleActionInvokeApi
|
|
75
|
+
* // ApiId: "STRING_VALUE", // required
|
|
76
|
+
* // Stage: "STRING_VALUE", // required
|
|
77
|
+
* // StripBasePath: true || false,
|
|
78
|
+
* // },
|
|
79
|
+
* // },
|
|
80
|
+
* // ],
|
|
81
|
+
* // Conditions: [ // __listOfRoutingRuleCondition
|
|
82
|
+
* // { // RoutingRuleCondition
|
|
83
|
+
* // MatchBasePaths: { // RoutingRuleMatchBasePaths
|
|
84
|
+
* // AnyOf: [ // __listOfSelectionKey // required
|
|
85
|
+
* // "STRING_VALUE",
|
|
86
|
+
* // ],
|
|
87
|
+
* // },
|
|
88
|
+
* // MatchHeaders: { // RoutingRuleMatchHeaders
|
|
89
|
+
* // AnyOf: [ // __listOfRoutingRuleMatchHeaderValue // required
|
|
90
|
+
* // { // RoutingRuleMatchHeaderValue
|
|
91
|
+
* // Header: "STRING_VALUE", // required
|
|
92
|
+
* // ValueGlob: "STRING_VALUE", // required
|
|
93
|
+
* // },
|
|
94
|
+
* // ],
|
|
95
|
+
* // },
|
|
96
|
+
* // },
|
|
97
|
+
* // ],
|
|
98
|
+
* // Priority: Number("int"),
|
|
99
|
+
* // RoutingRuleArn: "STRING_VALUE",
|
|
100
|
+
* // RoutingRuleId: "STRING_VALUE",
|
|
101
|
+
* // };
|
|
102
|
+
*
|
|
103
|
+
* ```
|
|
104
|
+
*
|
|
105
|
+
* @param PutRoutingRuleCommandInput - {@link PutRoutingRuleCommandInput}
|
|
106
|
+
* @returns {@link PutRoutingRuleCommandOutput}
|
|
107
|
+
* @see {@link PutRoutingRuleCommandInput} for command's `input` shape.
|
|
108
|
+
* @see {@link PutRoutingRuleCommandOutput} for command's `response` shape.
|
|
109
|
+
* @see {@link ApiGatewayV2ClientResolvedConfig | config} for ApiGatewayV2Client's `config` shape.
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link BadRequestException} (client fault)
|
|
112
|
+
* <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link ConflictException} (client fault)
|
|
115
|
+
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
|
|
116
|
+
*
|
|
117
|
+
* @throws {@link NotFoundException} (client fault)
|
|
118
|
+
* <p>The resource specified in the request was not found. See the message field for more information.</p>
|
|
119
|
+
*
|
|
120
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
121
|
+
* <p>A limit has been exceeded. See the accompanying error message for details.</p>
|
|
122
|
+
*
|
|
123
|
+
* @throws {@link ApiGatewayV2ServiceException}
|
|
124
|
+
* <p>Base exception class for all service exceptions from ApiGatewayV2 service.</p>
|
|
125
|
+
*
|
|
126
|
+
*
|
|
127
|
+
* @public
|
|
128
|
+
*/
|
|
129
|
+
export declare class PutRoutingRuleCommand extends PutRoutingRuleCommand_base {
|
|
130
|
+
/** @internal type navigation helper, not in runtime. */
|
|
131
|
+
protected static __types: {
|
|
132
|
+
api: {
|
|
133
|
+
input: PutRoutingRuleRequest;
|
|
134
|
+
output: PutRoutingRuleResponse;
|
|
135
|
+
};
|
|
136
|
+
sdk: {
|
|
137
|
+
input: PutRoutingRuleCommandInput;
|
|
138
|
+
output: PutRoutingRuleCommandOutput;
|
|
139
|
+
};
|
|
140
|
+
};
|
|
141
|
+
}
|
|
@@ -55,12 +55,14 @@ declare const UpdateDomainNameCommand_base: {
|
|
|
55
55
|
* TruststoreUri: "STRING_VALUE",
|
|
56
56
|
* TruststoreVersion: "STRING_VALUE",
|
|
57
57
|
* },
|
|
58
|
+
* RoutingMode: "API_MAPPING_ONLY" || "ROUTING_RULE_ONLY" || "ROUTING_RULE_THEN_API_MAPPING",
|
|
58
59
|
* };
|
|
59
60
|
* const command = new UpdateDomainNameCommand(input);
|
|
60
61
|
* const response = await client.send(command);
|
|
61
62
|
* // { // UpdateDomainNameResponse
|
|
62
63
|
* // ApiMappingSelectionExpression: "STRING_VALUE",
|
|
63
64
|
* // DomainName: "STRING_VALUE",
|
|
65
|
+
* // DomainNameArn: "STRING_VALUE",
|
|
64
66
|
* // DomainNameConfigurations: [ // DomainNameConfigurations
|
|
65
67
|
* // { // DomainNameConfiguration
|
|
66
68
|
* // ApiGatewayDomainName: "STRING_VALUE",
|
|
@@ -83,6 +85,7 @@ declare const UpdateDomainNameCommand_base: {
|
|
|
83
85
|
* // "STRING_VALUE",
|
|
84
86
|
* // ],
|
|
85
87
|
* // },
|
|
88
|
+
* // RoutingMode: "API_MAPPING_ONLY" || "ROUTING_RULE_ONLY" || "ROUTING_RULE_THEN_API_MAPPING",
|
|
86
89
|
* // Tags: { // Tags
|
|
87
90
|
* // "<keys>": "STRING_VALUE",
|
|
88
91
|
* // },
|