@aws-sdk/client-api-gateway 3.379.1 → 3.385.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +700 -0
- package/package.json +5 -5
|
@@ -6,10 +6,12 @@ import { APIGatewayServiceException as __BaseException } from "./APIGatewayServi
|
|
|
6
6
|
*/
|
|
7
7
|
export interface AccessLogSettings {
|
|
8
8
|
/**
|
|
9
|
+
* @public
|
|
9
10
|
* <p>A single line format of the access logs of data, as specified by selected $context variables. The format must include at least <code>$context.requestId</code>.</p>
|
|
10
11
|
*/
|
|
11
12
|
format?: string;
|
|
12
13
|
/**
|
|
14
|
+
* @public
|
|
13
15
|
* <p>The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with <code>amazon-apigateway-</code>.</p>
|
|
14
16
|
*/
|
|
15
17
|
destinationArn?: string;
|
|
@@ -20,10 +22,12 @@ export interface AccessLogSettings {
|
|
|
20
22
|
*/
|
|
21
23
|
export interface ThrottleSettings {
|
|
22
24
|
/**
|
|
25
|
+
* @public
|
|
23
26
|
* <p>The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.</p>
|
|
24
27
|
*/
|
|
25
28
|
burstLimit?: number;
|
|
26
29
|
/**
|
|
30
|
+
* @public
|
|
27
31
|
* <p>The API target request rate limit.</p>
|
|
28
32
|
*/
|
|
29
33
|
rateLimit?: number;
|
|
@@ -34,18 +38,22 @@ export interface ThrottleSettings {
|
|
|
34
38
|
*/
|
|
35
39
|
export interface Account {
|
|
36
40
|
/**
|
|
41
|
+
* @public
|
|
37
42
|
* <p>The ARN of an Amazon CloudWatch role for the current Account. </p>
|
|
38
43
|
*/
|
|
39
44
|
cloudwatchRoleArn?: string;
|
|
40
45
|
/**
|
|
46
|
+
* @public
|
|
41
47
|
* <p>Specifies the API request limits configured for the current Account.</p>
|
|
42
48
|
*/
|
|
43
49
|
throttleSettings?: ThrottleSettings;
|
|
44
50
|
/**
|
|
51
|
+
* @public
|
|
45
52
|
* <p>A list of features supported for the account. When usage plans are enabled, the features list will include an entry of <code>"UsagePlans"</code>.</p>
|
|
46
53
|
*/
|
|
47
54
|
features?: string[];
|
|
48
55
|
/**
|
|
56
|
+
* @public
|
|
49
57
|
* <p>The version of the API keys used for the account.</p>
|
|
50
58
|
*/
|
|
51
59
|
apiKeyVersion?: string;
|
|
@@ -56,42 +64,52 @@ export interface Account {
|
|
|
56
64
|
*/
|
|
57
65
|
export interface ApiKey {
|
|
58
66
|
/**
|
|
67
|
+
* @public
|
|
59
68
|
* <p>The identifier of the API Key.</p>
|
|
60
69
|
*/
|
|
61
70
|
id?: string;
|
|
62
71
|
/**
|
|
72
|
+
* @public
|
|
63
73
|
* <p>The value of the API Key.</p>
|
|
64
74
|
*/
|
|
65
75
|
value?: string;
|
|
66
76
|
/**
|
|
77
|
+
* @public
|
|
67
78
|
* <p>The name of the API Key.</p>
|
|
68
79
|
*/
|
|
69
80
|
name?: string;
|
|
70
81
|
/**
|
|
82
|
+
* @public
|
|
71
83
|
* <p>An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.</p>
|
|
72
84
|
*/
|
|
73
85
|
customerId?: string;
|
|
74
86
|
/**
|
|
87
|
+
* @public
|
|
75
88
|
* <p>The description of the API Key.</p>
|
|
76
89
|
*/
|
|
77
90
|
description?: string;
|
|
78
91
|
/**
|
|
92
|
+
* @public
|
|
79
93
|
* <p>Specifies whether the API Key can be used by callers.</p>
|
|
80
94
|
*/
|
|
81
95
|
enabled?: boolean;
|
|
82
96
|
/**
|
|
97
|
+
* @public
|
|
83
98
|
* <p>The timestamp when the API Key was created.</p>
|
|
84
99
|
*/
|
|
85
100
|
createdDate?: Date;
|
|
86
101
|
/**
|
|
102
|
+
* @public
|
|
87
103
|
* <p>The timestamp when the API Key was last updated.</p>
|
|
88
104
|
*/
|
|
89
105
|
lastUpdatedDate?: Date;
|
|
90
106
|
/**
|
|
107
|
+
* @public
|
|
91
108
|
* <p>A list of Stage resources that are associated with the ApiKey resource.</p>
|
|
92
109
|
*/
|
|
93
110
|
stageKeys?: string[];
|
|
94
111
|
/**
|
|
112
|
+
* @public
|
|
95
113
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
96
114
|
*/
|
|
97
115
|
tags?: Record<string, string>;
|
|
@@ -102,10 +120,12 @@ export interface ApiKey {
|
|
|
102
120
|
*/
|
|
103
121
|
export interface ApiKeyIds {
|
|
104
122
|
/**
|
|
123
|
+
* @public
|
|
105
124
|
* <p>A list of all the ApiKey identifiers.</p>
|
|
106
125
|
*/
|
|
107
126
|
ids?: string[];
|
|
108
127
|
/**
|
|
128
|
+
* @public
|
|
109
129
|
* <p>A list of warning messages.</p>
|
|
110
130
|
*/
|
|
111
131
|
warnings?: string[];
|
|
@@ -116,14 +136,17 @@ export interface ApiKeyIds {
|
|
|
116
136
|
*/
|
|
117
137
|
export interface ApiKeys {
|
|
118
138
|
/**
|
|
139
|
+
* @public
|
|
119
140
|
* <p>A list of warning messages logged during the import of API keys when the <code>failOnWarnings</code> option is set to true.</p>
|
|
120
141
|
*/
|
|
121
142
|
warnings?: string[];
|
|
122
143
|
/**
|
|
144
|
+
* @public
|
|
123
145
|
* <p>The current page of elements from this collection.</p>
|
|
124
146
|
*/
|
|
125
147
|
items?: ApiKey[];
|
|
126
148
|
/**
|
|
149
|
+
* @public
|
|
127
150
|
* <p>The current pagination position in the paged result set.</p>
|
|
128
151
|
*/
|
|
129
152
|
position?: string;
|
|
@@ -157,14 +180,17 @@ export type ApiKeySourceType = (typeof ApiKeySourceType)[keyof typeof ApiKeySour
|
|
|
157
180
|
*/
|
|
158
181
|
export interface ApiStage {
|
|
159
182
|
/**
|
|
183
|
+
* @public
|
|
160
184
|
* <p>API Id of the associated API stage in a usage plan.</p>
|
|
161
185
|
*/
|
|
162
186
|
apiId?: string;
|
|
163
187
|
/**
|
|
188
|
+
* @public
|
|
164
189
|
* <p>API stage name of the associated API stage in a usage plan.</p>
|
|
165
190
|
*/
|
|
166
191
|
stage?: string;
|
|
167
192
|
/**
|
|
193
|
+
* @public
|
|
168
194
|
* <p>Map containing method level throttling information for API stage in a usage plan.</p>
|
|
169
195
|
*/
|
|
170
196
|
throttle?: Record<string, ThrottleSettings>;
|
|
@@ -188,34 +214,42 @@ export type AuthorizerType = (typeof AuthorizerType)[keyof typeof AuthorizerType
|
|
|
188
214
|
*/
|
|
189
215
|
export interface Authorizer {
|
|
190
216
|
/**
|
|
217
|
+
* @public
|
|
191
218
|
* <p>The identifier for the authorizer resource.</p>
|
|
192
219
|
*/
|
|
193
220
|
id?: string;
|
|
194
221
|
/**
|
|
222
|
+
* @public
|
|
195
223
|
* <p>The name of the authorizer.</p>
|
|
196
224
|
*/
|
|
197
225
|
name?: string;
|
|
198
226
|
/**
|
|
227
|
+
* @public
|
|
199
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>
|
|
200
229
|
*/
|
|
201
230
|
type?: AuthorizerType | string;
|
|
202
231
|
/**
|
|
232
|
+
* @public
|
|
203
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>
|
|
204
234
|
*/
|
|
205
235
|
providerARNs?: string[];
|
|
206
236
|
/**
|
|
237
|
+
* @public
|
|
207
238
|
* <p>Optional customer-defined field, used in OpenAPI imports and exports without functional impact.</p>
|
|
208
239
|
*/
|
|
209
240
|
authType?: string;
|
|
210
241
|
/**
|
|
242
|
+
* @public
|
|
211
243
|
* <p>Specifies the authorizer's Uniform Resource Identifier (URI). For <code>TOKEN</code> or <code>REQUEST</code> authorizers, this must be a well-formed Lambda function URI, for example, <code>arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:\{account_id\}:function:\{lambda_function_name\}/invocations</code>. In general, the URI has this form <code>arn:aws:apigateway:\{region\}:lambda:path/\{service_api\}</code>, where <code>\{region\}</code> is the same as the region hosting the Lambda function, <code>path</code> indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial <code>/</code>. For Lambda functions, this is usually of the form <code>/2015-03-31/functions/[FunctionARN]/invocations</code>.</p>
|
|
212
244
|
*/
|
|
213
245
|
authorizerUri?: string;
|
|
214
246
|
/**
|
|
247
|
+
* @public
|
|
215
248
|
* <p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.</p>
|
|
216
249
|
*/
|
|
217
250
|
authorizerCredentials?: string;
|
|
218
251
|
/**
|
|
252
|
+
* @public
|
|
219
253
|
* <p>The identity source for which authorization is requested. For a <code>TOKEN</code> or
|
|
220
254
|
* <code>COGNITO_USER_POOLS</code> authorizer, this is required and specifies the request
|
|
221
255
|
* header mapping expression for the custom header holding the authorization token submitted by
|
|
@@ -234,10 +268,12 @@ export interface Authorizer {
|
|
|
234
268
|
*/
|
|
235
269
|
identitySource?: string;
|
|
236
270
|
/**
|
|
271
|
+
* @public
|
|
237
272
|
* <p>A validation expression for the incoming identity token. For <code>TOKEN</code> authorizers, this value is a regular expression. For <code>COGNITO_USER_POOLS</code> authorizers, API Gateway will match the <code>aud</code> field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the <code>REQUEST</code> authorizer.</p>
|
|
238
273
|
*/
|
|
239
274
|
identityValidationExpression?: string;
|
|
240
275
|
/**
|
|
276
|
+
* @public
|
|
241
277
|
* <p>The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.</p>
|
|
242
278
|
*/
|
|
243
279
|
authorizerResultTtlInSeconds?: number;
|
|
@@ -248,10 +284,12 @@ export interface Authorizer {
|
|
|
248
284
|
*/
|
|
249
285
|
export interface Authorizers {
|
|
250
286
|
/**
|
|
287
|
+
* @public
|
|
251
288
|
* <p>The current page of elements from this collection.</p>
|
|
252
289
|
*/
|
|
253
290
|
items?: Authorizer[];
|
|
254
291
|
/**
|
|
292
|
+
* @public
|
|
255
293
|
* <p>The current pagination position in the paged result set.</p>
|
|
256
294
|
*/
|
|
257
295
|
position?: string;
|
|
@@ -286,10 +324,12 @@ export declare class ConflictException extends __BaseException {
|
|
|
286
324
|
*/
|
|
287
325
|
export interface StageKey {
|
|
288
326
|
/**
|
|
327
|
+
* @public
|
|
289
328
|
* <p>The string identifier of the associated RestApi.</p>
|
|
290
329
|
*/
|
|
291
330
|
restApiId?: string;
|
|
292
331
|
/**
|
|
332
|
+
* @public
|
|
293
333
|
* <p>The stage name associated with the stage key.</p>
|
|
294
334
|
*/
|
|
295
335
|
stageName?: string;
|
|
@@ -300,34 +340,42 @@ export interface StageKey {
|
|
|
300
340
|
*/
|
|
301
341
|
export interface CreateApiKeyRequest {
|
|
302
342
|
/**
|
|
343
|
+
* @public
|
|
303
344
|
* <p>The name of the ApiKey.</p>
|
|
304
345
|
*/
|
|
305
346
|
name?: string;
|
|
306
347
|
/**
|
|
348
|
+
* @public
|
|
307
349
|
* <p>The description of the ApiKey.</p>
|
|
308
350
|
*/
|
|
309
351
|
description?: string;
|
|
310
352
|
/**
|
|
353
|
+
* @public
|
|
311
354
|
* <p>Specifies whether the ApiKey can be used by callers.</p>
|
|
312
355
|
*/
|
|
313
356
|
enabled?: boolean;
|
|
314
357
|
/**
|
|
358
|
+
* @public
|
|
315
359
|
* <p>Specifies whether (<code>true</code>) or not (<code>false</code>) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.</p>
|
|
316
360
|
*/
|
|
317
361
|
generateDistinctId?: boolean;
|
|
318
362
|
/**
|
|
363
|
+
* @public
|
|
319
364
|
* <p>Specifies a value of the API key.</p>
|
|
320
365
|
*/
|
|
321
366
|
value?: string;
|
|
322
367
|
/**
|
|
368
|
+
* @public
|
|
323
369
|
* <p>DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.</p>
|
|
324
370
|
*/
|
|
325
371
|
stageKeys?: StageKey[];
|
|
326
372
|
/**
|
|
373
|
+
* @public
|
|
327
374
|
* <p>An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.</p>
|
|
328
375
|
*/
|
|
329
376
|
customerId?: string;
|
|
330
377
|
/**
|
|
378
|
+
* @public
|
|
331
379
|
* <p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</p>
|
|
332
380
|
*/
|
|
333
381
|
tags?: Record<string, string>;
|
|
@@ -388,34 +436,42 @@ export declare class UnauthorizedException extends __BaseException {
|
|
|
388
436
|
*/
|
|
389
437
|
export interface CreateAuthorizerRequest {
|
|
390
438
|
/**
|
|
439
|
+
* @public
|
|
391
440
|
* <p>The string identifier of the associated RestApi.</p>
|
|
392
441
|
*/
|
|
393
442
|
restApiId: string | undefined;
|
|
394
443
|
/**
|
|
444
|
+
* @public
|
|
395
445
|
* <p>The name of the authorizer.</p>
|
|
396
446
|
*/
|
|
397
447
|
name: string | undefined;
|
|
398
448
|
/**
|
|
449
|
+
* @public
|
|
399
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>
|
|
400
451
|
*/
|
|
401
452
|
type: AuthorizerType | string | undefined;
|
|
402
453
|
/**
|
|
454
|
+
* @public
|
|
403
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>
|
|
404
456
|
*/
|
|
405
457
|
providerARNs?: string[];
|
|
406
458
|
/**
|
|
459
|
+
* @public
|
|
407
460
|
* <p>Optional customer-defined field, used in OpenAPI imports and exports without functional impact.</p>
|
|
408
461
|
*/
|
|
409
462
|
authType?: string;
|
|
410
463
|
/**
|
|
464
|
+
* @public
|
|
411
465
|
* <p>Specifies the authorizer's Uniform Resource Identifier (URI). For <code>TOKEN</code> or <code>REQUEST</code> authorizers, this must be a well-formed Lambda function URI, for example, <code>arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:\{account_id\}:function:\{lambda_function_name\}/invocations</code>. In general, the URI has this form <code>arn:aws:apigateway:\{region\}:lambda:path/\{service_api\}</code>, where <code>\{region\}</code> is the same as the region hosting the Lambda function, <code>path</code> indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial <code>/</code>. For Lambda functions, this is usually of the form <code>/2015-03-31/functions/[FunctionARN]/invocations</code>.</p>
|
|
412
466
|
*/
|
|
413
467
|
authorizerUri?: string;
|
|
414
468
|
/**
|
|
469
|
+
* @public
|
|
415
470
|
* <p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.</p>
|
|
416
471
|
*/
|
|
417
472
|
authorizerCredentials?: string;
|
|
418
473
|
/**
|
|
474
|
+
* @public
|
|
419
475
|
* <p>The identity source for which authorization is requested. For a <code>TOKEN</code> or
|
|
420
476
|
* <code>COGNITO_USER_POOLS</code> authorizer, this is required and specifies the request
|
|
421
477
|
* header mapping expression for the custom header holding the authorization token submitted by
|
|
@@ -436,10 +492,12 @@ export interface CreateAuthorizerRequest {
|
|
|
436
492
|
*/
|
|
437
493
|
identitySource?: string;
|
|
438
494
|
/**
|
|
495
|
+
* @public
|
|
439
496
|
* <p>A validation expression for the incoming identity token. For <code>TOKEN</code> authorizers, this value is a regular expression. For <code>COGNITO_USER_POOLS</code> authorizers, API Gateway will match the <code>aud</code> field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the <code>REQUEST</code> authorizer.</p>
|
|
440
497
|
*/
|
|
441
498
|
identityValidationExpression?: string;
|
|
442
499
|
/**
|
|
500
|
+
* @public
|
|
443
501
|
* <p>The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.</p>
|
|
444
502
|
*/
|
|
445
503
|
authorizerResultTtlInSeconds?: number;
|
|
@@ -450,14 +508,17 @@ export interface CreateAuthorizerRequest {
|
|
|
450
508
|
*/
|
|
451
509
|
export interface BasePathMapping {
|
|
452
510
|
/**
|
|
511
|
+
* @public
|
|
453
512
|
* <p>The base path name that callers of the API must provide as part of the URL after the domain name.</p>
|
|
454
513
|
*/
|
|
455
514
|
basePath?: string;
|
|
456
515
|
/**
|
|
516
|
+
* @public
|
|
457
517
|
* <p>The string identifier of the associated RestApi.</p>
|
|
458
518
|
*/
|
|
459
519
|
restApiId?: string;
|
|
460
520
|
/**
|
|
521
|
+
* @public
|
|
461
522
|
* <p>The name of the associated stage.</p>
|
|
462
523
|
*/
|
|
463
524
|
stage?: string;
|
|
@@ -468,18 +529,22 @@ export interface BasePathMapping {
|
|
|
468
529
|
*/
|
|
469
530
|
export interface CreateBasePathMappingRequest {
|
|
470
531
|
/**
|
|
532
|
+
* @public
|
|
471
533
|
* <p>The domain name of the BasePathMapping resource to create.</p>
|
|
472
534
|
*/
|
|
473
535
|
domainName: string | undefined;
|
|
474
536
|
/**
|
|
537
|
+
* @public
|
|
475
538
|
* <p>The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.</p>
|
|
476
539
|
*/
|
|
477
540
|
basePath?: string;
|
|
478
541
|
/**
|
|
542
|
+
* @public
|
|
479
543
|
* <p>The string identifier of the associated RestApi.</p>
|
|
480
544
|
*/
|
|
481
545
|
restApiId: string | undefined;
|
|
482
546
|
/**
|
|
547
|
+
* @public
|
|
483
548
|
* <p>The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.</p>
|
|
484
549
|
*/
|
|
485
550
|
stage?: string;
|
|
@@ -508,14 +573,17 @@ export type CacheClusterSize = (typeof CacheClusterSize)[keyof typeof CacheClust
|
|
|
508
573
|
*/
|
|
509
574
|
export interface DeploymentCanarySettings {
|
|
510
575
|
/**
|
|
576
|
+
* @public
|
|
511
577
|
* <p>The percentage (0.0-100.0) of traffic routed to the canary deployment.</p>
|
|
512
578
|
*/
|
|
513
579
|
percentTraffic?: number;
|
|
514
580
|
/**
|
|
581
|
+
* @public
|
|
515
582
|
* <p>A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.</p>
|
|
516
583
|
*/
|
|
517
584
|
stageVariableOverrides?: Record<string, string>;
|
|
518
585
|
/**
|
|
586
|
+
* @public
|
|
519
587
|
* <p>A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.</p>
|
|
520
588
|
*/
|
|
521
589
|
useStageCache?: boolean;
|
|
@@ -526,40 +594,49 @@ export interface DeploymentCanarySettings {
|
|
|
526
594
|
*/
|
|
527
595
|
export interface CreateDeploymentRequest {
|
|
528
596
|
/**
|
|
597
|
+
* @public
|
|
529
598
|
* <p>The string identifier of the associated RestApi.</p>
|
|
530
599
|
*/
|
|
531
600
|
restApiId: string | undefined;
|
|
532
601
|
/**
|
|
602
|
+
* @public
|
|
533
603
|
* <p>The name of the Stage resource for the Deployment resource to create.</p>
|
|
534
604
|
*/
|
|
535
605
|
stageName?: string;
|
|
536
606
|
/**
|
|
607
|
+
* @public
|
|
537
608
|
* <p>The description of the Stage resource for the Deployment resource to create.</p>
|
|
538
609
|
*/
|
|
539
610
|
stageDescription?: string;
|
|
540
611
|
/**
|
|
612
|
+
* @public
|
|
541
613
|
* <p>The description for the Deployment resource to create.</p>
|
|
542
614
|
*/
|
|
543
615
|
description?: string;
|
|
544
616
|
/**
|
|
617
|
+
* @public
|
|
545
618
|
* <p>Enables a cache cluster for the Stage resource specified in the input.</p>
|
|
546
619
|
*/
|
|
547
620
|
cacheClusterEnabled?: boolean;
|
|
548
621
|
/**
|
|
622
|
+
* @public
|
|
549
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>
|
|
550
624
|
*/
|
|
551
625
|
cacheClusterSize?: CacheClusterSize | string;
|
|
552
626
|
/**
|
|
627
|
+
* @public
|
|
553
628
|
* <p>A map that defines the stage variables for the Stage resource that is associated
|
|
554
629
|
* with the new deployment. Variable names can have alphanumeric and underscore characters, and the values
|
|
555
630
|
* must match <code>[A-Za-z0-9-._~:/?#&=,]+</code>.</p>
|
|
556
631
|
*/
|
|
557
632
|
variables?: Record<string, string>;
|
|
558
633
|
/**
|
|
634
|
+
* @public
|
|
559
635
|
* <p>The input configuration for the canary deployment when the deployment is a canary release deployment. </p>
|
|
560
636
|
*/
|
|
561
637
|
canarySettings?: DeploymentCanarySettings;
|
|
562
638
|
/**
|
|
639
|
+
* @public
|
|
563
640
|
* <p>Specifies whether active tracing with X-ray is enabled for the Stage.</p>
|
|
564
641
|
*/
|
|
565
642
|
tracingEnabled?: boolean;
|
|
@@ -570,10 +647,12 @@ export interface CreateDeploymentRequest {
|
|
|
570
647
|
*/
|
|
571
648
|
export interface MethodSnapshot {
|
|
572
649
|
/**
|
|
650
|
+
* @public
|
|
573
651
|
* <p>The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool.</p>
|
|
574
652
|
*/
|
|
575
653
|
authorizationType?: string;
|
|
576
654
|
/**
|
|
655
|
+
* @public
|
|
577
656
|
* <p>Specifies whether the method requires a valid ApiKey.</p>
|
|
578
657
|
*/
|
|
579
658
|
apiKeyRequired?: boolean;
|
|
@@ -584,18 +663,22 @@ export interface MethodSnapshot {
|
|
|
584
663
|
*/
|
|
585
664
|
export interface Deployment {
|
|
586
665
|
/**
|
|
666
|
+
* @public
|
|
587
667
|
* <p>The identifier for the deployment resource.</p>
|
|
588
668
|
*/
|
|
589
669
|
id?: string;
|
|
590
670
|
/**
|
|
671
|
+
* @public
|
|
591
672
|
* <p>The description for the deployment resource.</p>
|
|
592
673
|
*/
|
|
593
674
|
description?: string;
|
|
594
675
|
/**
|
|
676
|
+
* @public
|
|
595
677
|
* <p>The date and time that the deployment resource was created.</p>
|
|
596
678
|
*/
|
|
597
679
|
createdDate?: Date;
|
|
598
680
|
/**
|
|
681
|
+
* @public
|
|
599
682
|
* <p>A summary of the RestApi at the date and time that the deployment resource was created.</p>
|
|
600
683
|
*/
|
|
601
684
|
apiSummary?: Record<string, Record<string, MethodSnapshot>>;
|
|
@@ -641,22 +724,27 @@ export type DocumentationPartType = (typeof DocumentationPartType)[keyof typeof
|
|
|
641
724
|
*/
|
|
642
725
|
export interface DocumentationPartLocation {
|
|
643
726
|
/**
|
|
727
|
+
* @public
|
|
644
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>
|
|
645
729
|
*/
|
|
646
730
|
type: DocumentationPartType | string | undefined;
|
|
647
731
|
/**
|
|
732
|
+
* @public
|
|
648
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>
|
|
649
734
|
*/
|
|
650
735
|
path?: string;
|
|
651
736
|
/**
|
|
737
|
+
* @public
|
|
652
738
|
* <p>The HTTP verb of a method. It is a valid field for the API entity types of <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 any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other <code>location</code> attributes, the child entity's <code>method</code> attribute must match that of the parent entity exactly.</p>
|
|
653
739
|
*/
|
|
654
740
|
method?: string;
|
|
655
741
|
/**
|
|
742
|
+
* @public
|
|
656
743
|
* <p>The HTTP status code of a response. It is a valid field for the API entity types of <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. The default value is <code>*</code> for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other <code>location</code> attributes, the child entity's <code>statusCode</code> attribute must match that of the parent entity exactly.</p>
|
|
657
744
|
*/
|
|
658
745
|
statusCode?: string;
|
|
659
746
|
/**
|
|
747
|
+
* @public
|
|
660
748
|
* <p>The name of the targeted API entity. It is a valid and required field for the API entity types of <code>AUTHORIZER</code>, <code>MODEL</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code> and <code>RESPONSE_HEADER</code>. It is an invalid field for any other entity type.</p>
|
|
661
749
|
*/
|
|
662
750
|
name?: string;
|
|
@@ -667,14 +755,17 @@ export interface DocumentationPartLocation {
|
|
|
667
755
|
*/
|
|
668
756
|
export interface CreateDocumentationPartRequest {
|
|
669
757
|
/**
|
|
758
|
+
* @public
|
|
670
759
|
* <p>The string identifier of the associated RestApi.</p>
|
|
671
760
|
*/
|
|
672
761
|
restApiId: string | undefined;
|
|
673
762
|
/**
|
|
763
|
+
* @public
|
|
674
764
|
* <p>The location of the targeted API entity of the to-be-created documentation part.</p>
|
|
675
765
|
*/
|
|
676
766
|
location: DocumentationPartLocation | undefined;
|
|
677
767
|
/**
|
|
768
|
+
* @public
|
|
678
769
|
* <p>The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.</p>
|
|
679
770
|
*/
|
|
680
771
|
properties: string | undefined;
|
|
@@ -685,14 +776,17 @@ export interface CreateDocumentationPartRequest {
|
|
|
685
776
|
*/
|
|
686
777
|
export interface DocumentationPart {
|
|
687
778
|
/**
|
|
779
|
+
* @public
|
|
688
780
|
* <p>The DocumentationPart identifier, generated by API Gateway when the <code>DocumentationPart</code> is created.</p>
|
|
689
781
|
*/
|
|
690
782
|
id?: string;
|
|
691
783
|
/**
|
|
784
|
+
* @public
|
|
692
785
|
* <p>The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.</p>
|
|
693
786
|
*/
|
|
694
787
|
location?: DocumentationPartLocation;
|
|
695
788
|
/**
|
|
789
|
+
* @public
|
|
696
790
|
* <p>A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., <code>"\{ \"description\": \"The API does ...\" \}"</code>. Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of <code>x-amazon-apigateway-documentation</code>.</p>
|
|
697
791
|
*/
|
|
698
792
|
properties?: string;
|
|
@@ -703,18 +797,22 @@ export interface DocumentationPart {
|
|
|
703
797
|
*/
|
|
704
798
|
export interface CreateDocumentationVersionRequest {
|
|
705
799
|
/**
|
|
800
|
+
* @public
|
|
706
801
|
* <p>The string identifier of the associated RestApi.</p>
|
|
707
802
|
*/
|
|
708
803
|
restApiId: string | undefined;
|
|
709
804
|
/**
|
|
805
|
+
* @public
|
|
710
806
|
* <p>The version identifier of the new snapshot.</p>
|
|
711
807
|
*/
|
|
712
808
|
documentationVersion: string | undefined;
|
|
713
809
|
/**
|
|
810
|
+
* @public
|
|
714
811
|
* <p>The stage name to be associated with the new documentation snapshot.</p>
|
|
715
812
|
*/
|
|
716
813
|
stageName?: string;
|
|
717
814
|
/**
|
|
815
|
+
* @public
|
|
718
816
|
* <p>A description about the new documentation snapshot.</p>
|
|
719
817
|
*/
|
|
720
818
|
description?: string;
|
|
@@ -725,14 +823,17 @@ export interface CreateDocumentationVersionRequest {
|
|
|
725
823
|
*/
|
|
726
824
|
export interface DocumentationVersion {
|
|
727
825
|
/**
|
|
826
|
+
* @public
|
|
728
827
|
* <p>The version identifier of the API documentation snapshot.</p>
|
|
729
828
|
*/
|
|
730
829
|
version?: string;
|
|
731
830
|
/**
|
|
831
|
+
* @public
|
|
732
832
|
* <p>The date when the API documentation snapshot is created.</p>
|
|
733
833
|
*/
|
|
734
834
|
createdDate?: Date;
|
|
735
835
|
/**
|
|
836
|
+
* @public
|
|
736
837
|
* <p>The description of the API documentation snapshot.</p>
|
|
737
838
|
*/
|
|
738
839
|
description?: string;
|
|
@@ -756,10 +857,12 @@ export type EndpointType = (typeof EndpointType)[keyof typeof EndpointType];
|
|
|
756
857
|
*/
|
|
757
858
|
export interface EndpointConfiguration {
|
|
758
859
|
/**
|
|
860
|
+
* @public
|
|
759
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>
|
|
760
862
|
*/
|
|
761
863
|
types?: (EndpointType | string)[];
|
|
762
864
|
/**
|
|
865
|
+
* @public
|
|
763
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>
|
|
764
867
|
*/
|
|
765
868
|
vpcEndpointIds?: string[];
|
|
@@ -772,6 +875,7 @@ export interface EndpointConfiguration {
|
|
|
772
875
|
*/
|
|
773
876
|
export interface MutualTlsAuthenticationInput {
|
|
774
877
|
/**
|
|
878
|
+
* @public
|
|
775
879
|
* <p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example
|
|
776
880
|
* <code>s3://bucket-name/key-name</code>. The truststore can contain certificates from public or private
|
|
777
881
|
* certificate authorities. To update the truststore, upload a new version to S3, and then update
|
|
@@ -780,6 +884,7 @@ export interface MutualTlsAuthenticationInput {
|
|
|
780
884
|
*/
|
|
781
885
|
truststoreUri?: string;
|
|
782
886
|
/**
|
|
887
|
+
* @public
|
|
783
888
|
* <p>The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket</p>
|
|
784
889
|
*/
|
|
785
890
|
truststoreVersion?: string;
|
|
@@ -802,56 +907,69 @@ export type SecurityPolicy = (typeof SecurityPolicy)[keyof typeof SecurityPolicy
|
|
|
802
907
|
*/
|
|
803
908
|
export interface CreateDomainNameRequest {
|
|
804
909
|
/**
|
|
910
|
+
* @public
|
|
805
911
|
* <p>The name of the DomainName resource.</p>
|
|
806
912
|
*/
|
|
807
913
|
domainName: string | undefined;
|
|
808
914
|
/**
|
|
915
|
+
* @public
|
|
809
916
|
* <p>The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.</p>
|
|
810
917
|
*/
|
|
811
918
|
certificateName?: string;
|
|
812
919
|
/**
|
|
920
|
+
* @public
|
|
813
921
|
* <p>[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.</p>
|
|
814
922
|
*/
|
|
815
923
|
certificateBody?: string;
|
|
816
924
|
/**
|
|
925
|
+
* @public
|
|
817
926
|
* <p>[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.</p>
|
|
818
927
|
*/
|
|
819
928
|
certificatePrivateKey?: string;
|
|
820
929
|
/**
|
|
930
|
+
* @public
|
|
821
931
|
* <p>[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.</p>
|
|
822
932
|
*/
|
|
823
933
|
certificateChain?: string;
|
|
824
934
|
/**
|
|
935
|
+
* @public
|
|
825
936
|
* <p>The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.</p>
|
|
826
937
|
*/
|
|
827
938
|
certificateArn?: string;
|
|
828
939
|
/**
|
|
940
|
+
* @public
|
|
829
941
|
* <p>The user-friendly name of the certificate that will be used by regional endpoint for this domain name.</p>
|
|
830
942
|
*/
|
|
831
943
|
regionalCertificateName?: string;
|
|
832
944
|
/**
|
|
945
|
+
* @public
|
|
833
946
|
* <p>The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.</p>
|
|
834
947
|
*/
|
|
835
948
|
regionalCertificateArn?: string;
|
|
836
949
|
/**
|
|
950
|
+
* @public
|
|
837
951
|
* <p>The endpoint configuration of this DomainName showing the endpoint types of the domain name. </p>
|
|
838
952
|
*/
|
|
839
953
|
endpointConfiguration?: EndpointConfiguration;
|
|
840
954
|
/**
|
|
955
|
+
* @public
|
|
841
956
|
* <p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</p>
|
|
842
957
|
*/
|
|
843
958
|
tags?: Record<string, string>;
|
|
844
959
|
/**
|
|
960
|
+
* @public
|
|
845
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>
|
|
846
962
|
*/
|
|
847
963
|
securityPolicy?: SecurityPolicy | string;
|
|
848
964
|
/**
|
|
965
|
+
* @public
|
|
849
966
|
* <p>The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway
|
|
850
967
|
* performs two-way authentication between the client and the server. Clients must present a
|
|
851
968
|
* trusted certificate to access your API.</p>
|
|
852
969
|
*/
|
|
853
970
|
mutualTlsAuthentication?: MutualTlsAuthenticationInput;
|
|
854
971
|
/**
|
|
972
|
+
* @public
|
|
855
973
|
* <p>The ARN of the public certificate issued by ACM to validate ownership of your custom
|
|
856
974
|
* domain. Only required when configuring mutual TLS and using an ACM imported or private CA
|
|
857
975
|
* certificate ARN as the regionalCertificateArn.</p>
|
|
@@ -881,6 +999,7 @@ export type DomainNameStatus = (typeof DomainNameStatus)[keyof typeof DomainName
|
|
|
881
999
|
*/
|
|
882
1000
|
export interface MutualTlsAuthentication {
|
|
883
1001
|
/**
|
|
1002
|
+
* @public
|
|
884
1003
|
* <p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example
|
|
885
1004
|
* <code>s3://bucket-name/key-name</code>. The truststore can contain certificates from public or private
|
|
886
1005
|
* certificate authorities. To update the truststore, upload a new version to S3, and then update
|
|
@@ -889,10 +1008,12 @@ export interface MutualTlsAuthentication {
|
|
|
889
1008
|
*/
|
|
890
1009
|
truststoreUri?: string;
|
|
891
1010
|
/**
|
|
1011
|
+
* @public
|
|
892
1012
|
* <p>The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.</p>
|
|
893
1013
|
*/
|
|
894
1014
|
truststoreVersion?: string;
|
|
895
1015
|
/**
|
|
1016
|
+
* @public
|
|
896
1017
|
* <p>A list of warnings that API Gateway returns while processing your truststore. Invalid
|
|
897
1018
|
* certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able
|
|
898
1019
|
* to access your API. To resolve warnings, upload a new truststore to S3, and then update you
|
|
@@ -906,72 +1027,89 @@ export interface MutualTlsAuthentication {
|
|
|
906
1027
|
*/
|
|
907
1028
|
export interface DomainName {
|
|
908
1029
|
/**
|
|
1030
|
+
* @public
|
|
909
1031
|
* <p>The custom domain name as an API host name, for example, <code>my-api.example.com</code>.</p>
|
|
910
1032
|
*/
|
|
911
1033
|
domainName?: string;
|
|
912
1034
|
/**
|
|
1035
|
+
* @public
|
|
913
1036
|
* <p>The name of the certificate that will be used by edge-optimized endpoint for this domain name.</p>
|
|
914
1037
|
*/
|
|
915
1038
|
certificateName?: string;
|
|
916
1039
|
/**
|
|
1040
|
+
* @public
|
|
917
1041
|
* <p>The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.</p>
|
|
918
1042
|
*/
|
|
919
1043
|
certificateArn?: string;
|
|
920
1044
|
/**
|
|
1045
|
+
* @public
|
|
921
1046
|
* <p>The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.</p>
|
|
922
1047
|
*/
|
|
923
1048
|
certificateUploadDate?: Date;
|
|
924
1049
|
/**
|
|
1050
|
+
* @public
|
|
925
1051
|
* <p>The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.</p>
|
|
926
1052
|
*/
|
|
927
1053
|
regionalDomainName?: string;
|
|
928
1054
|
/**
|
|
1055
|
+
* @public
|
|
929
1056
|
* <p>The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway. </p>
|
|
930
1057
|
*/
|
|
931
1058
|
regionalHostedZoneId?: string;
|
|
932
1059
|
/**
|
|
1060
|
+
* @public
|
|
933
1061
|
* <p>The name of the certificate that will be used for validating the regional domain name.</p>
|
|
934
1062
|
*/
|
|
935
1063
|
regionalCertificateName?: string;
|
|
936
1064
|
/**
|
|
1065
|
+
* @public
|
|
937
1066
|
* <p>The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.</p>
|
|
938
1067
|
*/
|
|
939
1068
|
regionalCertificateArn?: string;
|
|
940
1069
|
/**
|
|
1070
|
+
* @public
|
|
941
1071
|
* <p>The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.</p>
|
|
942
1072
|
*/
|
|
943
1073
|
distributionDomainName?: string;
|
|
944
1074
|
/**
|
|
1075
|
+
* @public
|
|
945
1076
|
* <p>The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is <code>Z2FDTNDATAQYW2</code> for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway. </p>
|
|
946
1077
|
*/
|
|
947
1078
|
distributionHostedZoneId?: string;
|
|
948
1079
|
/**
|
|
1080
|
+
* @public
|
|
949
1081
|
* <p>The endpoint configuration of this DomainName showing the endpoint types of the domain name. </p>
|
|
950
1082
|
*/
|
|
951
1083
|
endpointConfiguration?: EndpointConfiguration;
|
|
952
1084
|
/**
|
|
1085
|
+
* @public
|
|
953
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>
|
|
954
1087
|
*/
|
|
955
1088
|
domainNameStatus?: DomainNameStatus | string;
|
|
956
1089
|
/**
|
|
1090
|
+
* @public
|
|
957
1091
|
* <p>An optional text message containing detailed information about status of the DomainName migration.</p>
|
|
958
1092
|
*/
|
|
959
1093
|
domainNameStatusMessage?: string;
|
|
960
1094
|
/**
|
|
1095
|
+
* @public
|
|
961
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>
|
|
962
1097
|
*/
|
|
963
1098
|
securityPolicy?: SecurityPolicy | string;
|
|
964
1099
|
/**
|
|
1100
|
+
* @public
|
|
965
1101
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
966
1102
|
*/
|
|
967
1103
|
tags?: Record<string, string>;
|
|
968
1104
|
/**
|
|
1105
|
+
* @public
|
|
969
1106
|
* <p>The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway
|
|
970
1107
|
* performs two-way authentication between the client and the server. Clients must present a
|
|
971
1108
|
* trusted certificate to access your API.</p>
|
|
972
1109
|
*/
|
|
973
1110
|
mutualTlsAuthentication?: MutualTlsAuthentication;
|
|
974
1111
|
/**
|
|
1112
|
+
* @public
|
|
975
1113
|
* <p>The ARN of the public certificate issued by ACM to validate ownership of your custom
|
|
976
1114
|
* domain. Only required when configuring mutual TLS and using an ACM imported or private CA
|
|
977
1115
|
* certificate ARN as the regionalCertificateArn.</p>
|
|
@@ -984,22 +1122,27 @@ export interface DomainName {
|
|
|
984
1122
|
*/
|
|
985
1123
|
export interface CreateModelRequest {
|
|
986
1124
|
/**
|
|
1125
|
+
* @public
|
|
987
1126
|
* <p>The RestApi identifier under which the Model will be created.</p>
|
|
988
1127
|
*/
|
|
989
1128
|
restApiId: string | undefined;
|
|
990
1129
|
/**
|
|
1130
|
+
* @public
|
|
991
1131
|
* <p>The name of the model. Must be alphanumeric.</p>
|
|
992
1132
|
*/
|
|
993
1133
|
name: string | undefined;
|
|
994
1134
|
/**
|
|
1135
|
+
* @public
|
|
995
1136
|
* <p>The description of the model.</p>
|
|
996
1137
|
*/
|
|
997
1138
|
description?: string;
|
|
998
1139
|
/**
|
|
1140
|
+
* @public
|
|
999
1141
|
* <p>The schema for the model. For <code>application/json</code> models, this should be JSON schema draft 4 model.</p>
|
|
1000
1142
|
*/
|
|
1001
1143
|
schema?: string;
|
|
1002
1144
|
/**
|
|
1145
|
+
* @public
|
|
1003
1146
|
* <p>The content-type for the model.</p>
|
|
1004
1147
|
*/
|
|
1005
1148
|
contentType: string | undefined;
|
|
@@ -1010,22 +1153,27 @@ export interface CreateModelRequest {
|
|
|
1010
1153
|
*/
|
|
1011
1154
|
export interface Model {
|
|
1012
1155
|
/**
|
|
1156
|
+
* @public
|
|
1013
1157
|
* <p>The identifier for the model resource.</p>
|
|
1014
1158
|
*/
|
|
1015
1159
|
id?: string;
|
|
1016
1160
|
/**
|
|
1161
|
+
* @public
|
|
1017
1162
|
* <p>The name of the model. Must be an alphanumeric string.</p>
|
|
1018
1163
|
*/
|
|
1019
1164
|
name?: string;
|
|
1020
1165
|
/**
|
|
1166
|
+
* @public
|
|
1021
1167
|
* <p>The description of the model.</p>
|
|
1022
1168
|
*/
|
|
1023
1169
|
description?: string;
|
|
1024
1170
|
/**
|
|
1171
|
+
* @public
|
|
1025
1172
|
* <p>The schema for the model. For <code>application/json</code> models, this should be JSON schema draft 4 model. Do not include "\*\/" characters in the description of any properties because such "\*\/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.</p>
|
|
1026
1173
|
*/
|
|
1027
1174
|
schema?: string;
|
|
1028
1175
|
/**
|
|
1176
|
+
* @public
|
|
1029
1177
|
* <p>The content-type for the model.</p>
|
|
1030
1178
|
*/
|
|
1031
1179
|
contentType?: string;
|
|
@@ -1036,18 +1184,22 @@ export interface Model {
|
|
|
1036
1184
|
*/
|
|
1037
1185
|
export interface CreateRequestValidatorRequest {
|
|
1038
1186
|
/**
|
|
1187
|
+
* @public
|
|
1039
1188
|
* <p>The string identifier of the associated RestApi.</p>
|
|
1040
1189
|
*/
|
|
1041
1190
|
restApiId: string | undefined;
|
|
1042
1191
|
/**
|
|
1192
|
+
* @public
|
|
1043
1193
|
* <p>The name of the to-be-created RequestValidator.</p>
|
|
1044
1194
|
*/
|
|
1045
1195
|
name?: string;
|
|
1046
1196
|
/**
|
|
1197
|
+
* @public
|
|
1047
1198
|
* <p>A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (<code>true</code>) or not (<code>false</code>).</p>
|
|
1048
1199
|
*/
|
|
1049
1200
|
validateRequestBody?: boolean;
|
|
1050
1201
|
/**
|
|
1202
|
+
* @public
|
|
1051
1203
|
* <p>A Boolean flag to indicate whether to validate request parameters, <code>true</code>, or not <code>false</code>.</p>
|
|
1052
1204
|
*/
|
|
1053
1205
|
validateRequestParameters?: boolean;
|
|
@@ -1058,18 +1210,22 @@ export interface CreateRequestValidatorRequest {
|
|
|
1058
1210
|
*/
|
|
1059
1211
|
export interface RequestValidator {
|
|
1060
1212
|
/**
|
|
1213
|
+
* @public
|
|
1061
1214
|
* <p>The identifier of this RequestValidator.</p>
|
|
1062
1215
|
*/
|
|
1063
1216
|
id?: string;
|
|
1064
1217
|
/**
|
|
1218
|
+
* @public
|
|
1065
1219
|
* <p>The name of this RequestValidator</p>
|
|
1066
1220
|
*/
|
|
1067
1221
|
name?: string;
|
|
1068
1222
|
/**
|
|
1223
|
+
* @public
|
|
1069
1224
|
* <p>A Boolean flag to indicate whether to validate a request body according to the configured Model schema.</p>
|
|
1070
1225
|
*/
|
|
1071
1226
|
validateRequestBody?: boolean;
|
|
1072
1227
|
/**
|
|
1228
|
+
* @public
|
|
1073
1229
|
* <p>A Boolean flag to indicate whether to validate request parameters (<code>true</code>) or not (<code>false</code>).</p>
|
|
1074
1230
|
*/
|
|
1075
1231
|
validateRequestParameters?: boolean;
|
|
@@ -1080,14 +1236,17 @@ export interface RequestValidator {
|
|
|
1080
1236
|
*/
|
|
1081
1237
|
export interface CreateResourceRequest {
|
|
1082
1238
|
/**
|
|
1239
|
+
* @public
|
|
1083
1240
|
* <p>The string identifier of the associated RestApi.</p>
|
|
1084
1241
|
*/
|
|
1085
1242
|
restApiId: string | undefined;
|
|
1086
1243
|
/**
|
|
1244
|
+
* @public
|
|
1087
1245
|
* <p>The parent resource's identifier.</p>
|
|
1088
1246
|
*/
|
|
1089
1247
|
parentId: string | undefined;
|
|
1090
1248
|
/**
|
|
1249
|
+
* @public
|
|
1091
1250
|
* <p>The last path segment for this resource.</p>
|
|
1092
1251
|
*/
|
|
1093
1252
|
pathPart: string | undefined;
|
|
@@ -1122,23 +1281,28 @@ export type ContentHandlingStrategy = (typeof ContentHandlingStrategy)[keyof typ
|
|
|
1122
1281
|
*/
|
|
1123
1282
|
export interface IntegrationResponse {
|
|
1124
1283
|
/**
|
|
1284
|
+
* @public
|
|
1125
1285
|
* <p>Specifies the status code that is used to map the integration response to an existing MethodResponse.</p>
|
|
1126
1286
|
*/
|
|
1127
1287
|
statusCode?: string;
|
|
1128
1288
|
/**
|
|
1289
|
+
* @public
|
|
1129
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 AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.</p>
|
|
1130
1291
|
*/
|
|
1131
1292
|
selectionPattern?: string;
|
|
1132
1293
|
/**
|
|
1294
|
+
* @public
|
|
1133
1295
|
* <p>A key-value map specifying response parameters that are passed to the method response from the back end.
|
|
1134
1296
|
* The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of <code>method.response.header.\{name\}</code>, where <code>name</code> is a valid and unique header name. The mapped non-static value must match the pattern of <code>integration.response.header.\{name\}</code> or <code>integration.response.body.\{JSON-expression\}</code>, where <code>name</code> is a valid and unique response header name and <code>JSON-expression</code> is a valid JSON expression without the <code>$</code> prefix.</p>
|
|
1135
1297
|
*/
|
|
1136
1298
|
responseParameters?: Record<string, string>;
|
|
1137
1299
|
/**
|
|
1300
|
+
* @public
|
|
1138
1301
|
* <p>Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>
|
|
1139
1302
|
*/
|
|
1140
1303
|
responseTemplates?: Record<string, string>;
|
|
1141
1304
|
/**
|
|
1305
|
+
* @public
|
|
1142
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>
|
|
1143
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>
|
|
1144
1308
|
*/
|
|
@@ -1150,6 +1314,7 @@ export interface IntegrationResponse {
|
|
|
1150
1314
|
*/
|
|
1151
1315
|
export interface TlsConfig {
|
|
1152
1316
|
/**
|
|
1317
|
+
* @public
|
|
1153
1318
|
* <p>Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is
|
|
1154
1319
|
* issued by a supported certificate authority. This isn’t recommended, but it enables you to
|
|
1155
1320
|
* use certificates that are signed by private certificate authorities, or certificates
|
|
@@ -1185,15 +1350,18 @@ export type IntegrationType = (typeof IntegrationType)[keyof typeof IntegrationT
|
|
|
1185
1350
|
*/
|
|
1186
1351
|
export interface Integration {
|
|
1187
1352
|
/**
|
|
1353
|
+
* @public
|
|
1188
1354
|
* <p>Specifies an API method integration type. The valid value is one of the following:</p>
|
|
1189
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>
|
|
1190
1356
|
*/
|
|
1191
1357
|
type?: IntegrationType | string;
|
|
1192
1358
|
/**
|
|
1359
|
+
* @public
|
|
1193
1360
|
* <p>Specifies the integration's HTTP method type.</p>
|
|
1194
1361
|
*/
|
|
1195
1362
|
httpMethod?: string;
|
|
1196
1363
|
/**
|
|
1364
|
+
* @public
|
|
1197
1365
|
* <p>Specifies Uniform Resource Identifier (URI) of the integration endpoint.</p>
|
|
1198
1366
|
* <p>For <code>HTTP</code> or <code>HTTP_PROXY</code> integrations, the URI must be a fully formed, encoded HTTP(S) URL
|
|
1199
1367
|
* according to the RFC-3986 specification, for either standard integration, where <code>connectionType</code>
|
|
@@ -1214,26 +1382,32 @@ export interface Integration {
|
|
|
1214
1382
|
*/
|
|
1215
1383
|
uri?: string;
|
|
1216
1384
|
/**
|
|
1385
|
+
* @public
|
|
1217
1386
|
* <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>
|
|
1218
1387
|
*/
|
|
1219
1388
|
connectionType?: ConnectionType | string;
|
|
1220
1389
|
/**
|
|
1390
|
+
* @public
|
|
1221
1391
|
* <p>The ID of the VpcLink used for the integration when <code>connectionType=VPC_LINK</code> and undefined, otherwise.</p>
|
|
1222
1392
|
*/
|
|
1223
1393
|
connectionId?: string;
|
|
1224
1394
|
/**
|
|
1395
|
+
* @public
|
|
1225
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 AWS services, specify null.</p>
|
|
1226
1397
|
*/
|
|
1227
1398
|
credentials?: string;
|
|
1228
1399
|
/**
|
|
1400
|
+
* @public
|
|
1229
1401
|
* <p>A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of <code>method.request.\{location\}.\{name\}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> must be a valid and unique method request parameter name.</p>
|
|
1230
1402
|
*/
|
|
1231
1403
|
requestParameters?: Record<string, string>;
|
|
1232
1404
|
/**
|
|
1405
|
+
* @public
|
|
1233
1406
|
* <p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.</p>
|
|
1234
1407
|
*/
|
|
1235
1408
|
requestTemplates?: Record<string, string>;
|
|
1236
1409
|
/**
|
|
1410
|
+
* @public
|
|
1237
1411
|
* <p>Specifies how the method request body of an unmapped content type will be passed through
|
|
1238
1412
|
* the integration request to the back end without transformation. A content type is unmapped if
|
|
1239
1413
|
* no mapping template is defined in the integration or the content type does not match any of
|
|
@@ -1252,27 +1426,33 @@ export interface Integration {
|
|
|
1252
1426
|
*/
|
|
1253
1427
|
passthroughBehavior?: string;
|
|
1254
1428
|
/**
|
|
1429
|
+
* @public
|
|
1255
1430
|
* <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>
|
|
1256
1431
|
* <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>
|
|
1257
1432
|
*/
|
|
1258
1433
|
contentHandling?: ContentHandlingStrategy | string;
|
|
1259
1434
|
/**
|
|
1435
|
+
* @public
|
|
1260
1436
|
* <p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.</p>
|
|
1261
1437
|
*/
|
|
1262
1438
|
timeoutInMillis?: number;
|
|
1263
1439
|
/**
|
|
1440
|
+
* @public
|
|
1264
1441
|
* <p>Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the <code>cacheNamespace</code>. You can specify the same <code>cacheNamespace</code> across resources to return the same cached data for requests to different resources.</p>
|
|
1265
1442
|
*/
|
|
1266
1443
|
cacheNamespace?: string;
|
|
1267
1444
|
/**
|
|
1445
|
+
* @public
|
|
1268
1446
|
* <p>A list of request parameters whose values API Gateway caches. To be valid values for <code>cacheKeyParameters</code>, these parameters must also be specified for Method <code>requestParameters</code>.</p>
|
|
1269
1447
|
*/
|
|
1270
1448
|
cacheKeyParameters?: string[];
|
|
1271
1449
|
/**
|
|
1450
|
+
* @public
|
|
1272
1451
|
* <p>Specifies the integration's responses.</p>
|
|
1273
1452
|
*/
|
|
1274
1453
|
integrationResponses?: Record<string, IntegrationResponse>;
|
|
1275
1454
|
/**
|
|
1455
|
+
* @public
|
|
1276
1456
|
* <p>Specifies the TLS configuration for an integration.</p>
|
|
1277
1457
|
*/
|
|
1278
1458
|
tlsConfig?: TlsConfig;
|
|
@@ -1283,14 +1463,17 @@ export interface Integration {
|
|
|
1283
1463
|
*/
|
|
1284
1464
|
export interface MethodResponse {
|
|
1285
1465
|
/**
|
|
1466
|
+
* @public
|
|
1286
1467
|
* <p>The method response's status code.</p>
|
|
1287
1468
|
*/
|
|
1288
1469
|
statusCode?: string;
|
|
1289
1470
|
/**
|
|
1471
|
+
* @public
|
|
1290
1472
|
* <p>A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern <code>method.response.header.\{name\}</code>, where <code>name</code> is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in <code>integration.response.header.\{name\}</code>, a static value enclosed within a pair of single quotes (e.g., <code>'application/json'</code>), or a JSON expression from the back-end response payload in the form of <code>integration.response.body.\{JSON-expression\}</code>, where <code>JSON-expression</code> is a valid JSON expression without the <code>$</code> prefix.)</p>
|
|
1291
1473
|
*/
|
|
1292
1474
|
responseParameters?: Record<string, boolean>;
|
|
1293
1475
|
/**
|
|
1476
|
+
* @public
|
|
1294
1477
|
* <p>Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.</p>
|
|
1295
1478
|
*/
|
|
1296
1479
|
responseModels?: Record<string, string>;
|
|
@@ -1308,46 +1491,57 @@ export interface MethodResponse {
|
|
|
1308
1491
|
*/
|
|
1309
1492
|
export interface Method {
|
|
1310
1493
|
/**
|
|
1494
|
+
* @public
|
|
1311
1495
|
* <p>The method's HTTP verb.</p>
|
|
1312
1496
|
*/
|
|
1313
1497
|
httpMethod?: string;
|
|
1314
1498
|
/**
|
|
1499
|
+
* @public
|
|
1315
1500
|
* <p>The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool.</p>
|
|
1316
1501
|
*/
|
|
1317
1502
|
authorizationType?: string;
|
|
1318
1503
|
/**
|
|
1504
|
+
* @public
|
|
1319
1505
|
* <p>The identifier of an Authorizer to use on this method. The <code>authorizationType</code> must be <code>CUSTOM</code>.</p>
|
|
1320
1506
|
*/
|
|
1321
1507
|
authorizerId?: string;
|
|
1322
1508
|
/**
|
|
1509
|
+
* @public
|
|
1323
1510
|
* <p>A boolean flag specifying whether a valid ApiKey is required to invoke this method.</p>
|
|
1324
1511
|
*/
|
|
1325
1512
|
apiKeyRequired?: boolean;
|
|
1326
1513
|
/**
|
|
1514
|
+
* @public
|
|
1327
1515
|
* <p>The identifier of a RequestValidator for request validation.</p>
|
|
1328
1516
|
*/
|
|
1329
1517
|
requestValidatorId?: string;
|
|
1330
1518
|
/**
|
|
1519
|
+
* @public
|
|
1331
1520
|
* <p>A human-friendly operation identifier for the method. For example, you can assign the <code>operationName</code> of <code>ListPets</code> for the <code>GET /pets</code> method in the <code>PetStore</code> example.</p>
|
|
1332
1521
|
*/
|
|
1333
1522
|
operationName?: string;
|
|
1334
1523
|
/**
|
|
1524
|
+
* @public
|
|
1335
1525
|
* <p>A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of <code>method.request.\{location\}.\{name\}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (<code>true</code>) or optional (<code>false</code>). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.</p>
|
|
1336
1526
|
*/
|
|
1337
1527
|
requestParameters?: Record<string, boolean>;
|
|
1338
1528
|
/**
|
|
1529
|
+
* @public
|
|
1339
1530
|
* <p>A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).</p>
|
|
1340
1531
|
*/
|
|
1341
1532
|
requestModels?: Record<string, string>;
|
|
1342
1533
|
/**
|
|
1534
|
+
* @public
|
|
1343
1535
|
* <p>Gets a method response associated with a given HTTP status code. </p>
|
|
1344
1536
|
*/
|
|
1345
1537
|
methodResponses?: Record<string, MethodResponse>;
|
|
1346
1538
|
/**
|
|
1539
|
+
* @public
|
|
1347
1540
|
* <p>Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.</p>
|
|
1348
1541
|
*/
|
|
1349
1542
|
methodIntegration?: Integration;
|
|
1350
1543
|
/**
|
|
1544
|
+
* @public
|
|
1351
1545
|
* <p>A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOLS</code> authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>
|
|
1352
1546
|
*/
|
|
1353
1547
|
authorizationScopes?: string[];
|
|
@@ -1358,22 +1552,27 @@ export interface Method {
|
|
|
1358
1552
|
*/
|
|
1359
1553
|
export interface Resource {
|
|
1360
1554
|
/**
|
|
1555
|
+
* @public
|
|
1361
1556
|
* <p>The resource's identifier.</p>
|
|
1362
1557
|
*/
|
|
1363
1558
|
id?: string;
|
|
1364
1559
|
/**
|
|
1560
|
+
* @public
|
|
1365
1561
|
* <p>The parent resource's identifier.</p>
|
|
1366
1562
|
*/
|
|
1367
1563
|
parentId?: string;
|
|
1368
1564
|
/**
|
|
1565
|
+
* @public
|
|
1369
1566
|
* <p>The last path segment for this resource.</p>
|
|
1370
1567
|
*/
|
|
1371
1568
|
pathPart?: string;
|
|
1372
1569
|
/**
|
|
1570
|
+
* @public
|
|
1373
1571
|
* <p>The full path for this resource.</p>
|
|
1374
1572
|
*/
|
|
1375
1573
|
path?: string;
|
|
1376
1574
|
/**
|
|
1575
|
+
* @public
|
|
1377
1576
|
* <p>Gets an API resource's method of a given HTTP verb.</p>
|
|
1378
1577
|
*/
|
|
1379
1578
|
resourceMethods?: Record<string, Method>;
|
|
@@ -1384,30 +1583,37 @@ export interface Resource {
|
|
|
1384
1583
|
*/
|
|
1385
1584
|
export interface CreateRestApiRequest {
|
|
1386
1585
|
/**
|
|
1586
|
+
* @public
|
|
1387
1587
|
* <p>The name of the RestApi.</p>
|
|
1388
1588
|
*/
|
|
1389
1589
|
name: string | undefined;
|
|
1390
1590
|
/**
|
|
1591
|
+
* @public
|
|
1391
1592
|
* <p>The description of the RestApi.</p>
|
|
1392
1593
|
*/
|
|
1393
1594
|
description?: string;
|
|
1394
1595
|
/**
|
|
1596
|
+
* @public
|
|
1395
1597
|
* <p>A version identifier for the API.</p>
|
|
1396
1598
|
*/
|
|
1397
1599
|
version?: string;
|
|
1398
1600
|
/**
|
|
1601
|
+
* @public
|
|
1399
1602
|
* <p>The ID of the RestApi that you want to clone from.</p>
|
|
1400
1603
|
*/
|
|
1401
1604
|
cloneFrom?: string;
|
|
1402
1605
|
/**
|
|
1606
|
+
* @public
|
|
1403
1607
|
* <p>The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.</p>
|
|
1404
1608
|
*/
|
|
1405
1609
|
binaryMediaTypes?: string[];
|
|
1406
1610
|
/**
|
|
1611
|
+
* @public
|
|
1407
1612
|
* <p>A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.</p>
|
|
1408
1613
|
*/
|
|
1409
1614
|
minimumCompressionSize?: number;
|
|
1410
1615
|
/**
|
|
1616
|
+
* @public
|
|
1411
1617
|
* <p>The source of the API key for metering requests according to a usage plan. Valid values
|
|
1412
1618
|
* are: ><code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a
|
|
1413
1619
|
* request. <code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code>
|
|
@@ -1415,18 +1621,22 @@ export interface CreateRestApiRequest {
|
|
|
1415
1621
|
*/
|
|
1416
1622
|
apiKeySource?: ApiKeySourceType | string;
|
|
1417
1623
|
/**
|
|
1624
|
+
* @public
|
|
1418
1625
|
* <p>The endpoint configuration of this RestApi showing the endpoint types of the API. </p>
|
|
1419
1626
|
*/
|
|
1420
1627
|
endpointConfiguration?: EndpointConfiguration;
|
|
1421
1628
|
/**
|
|
1629
|
+
* @public
|
|
1422
1630
|
* <p>A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.</p>
|
|
1423
1631
|
*/
|
|
1424
1632
|
policy?: string;
|
|
1425
1633
|
/**
|
|
1634
|
+
* @public
|
|
1426
1635
|
* <p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</p>
|
|
1427
1636
|
*/
|
|
1428
1637
|
tags?: Record<string, string>;
|
|
1429
1638
|
/**
|
|
1639
|
+
* @public
|
|
1430
1640
|
* <p>Specifies whether clients can invoke your API by using the default <code>execute-api</code> endpoint.
|
|
1431
1641
|
* By default, clients can invoke your API with the default
|
|
1432
1642
|
* <code>https://\{api_id\}.execute-api.\{region\}.amazonaws.com</code> endpoint. To require that clients use a
|
|
@@ -1440,38 +1650,47 @@ export interface CreateRestApiRequest {
|
|
|
1440
1650
|
*/
|
|
1441
1651
|
export interface RestApi {
|
|
1442
1652
|
/**
|
|
1653
|
+
* @public
|
|
1443
1654
|
* <p>The API's identifier. This identifier is unique across all of your APIs in API Gateway.</p>
|
|
1444
1655
|
*/
|
|
1445
1656
|
id?: string;
|
|
1446
1657
|
/**
|
|
1658
|
+
* @public
|
|
1447
1659
|
* <p>The API's name.</p>
|
|
1448
1660
|
*/
|
|
1449
1661
|
name?: string;
|
|
1450
1662
|
/**
|
|
1663
|
+
* @public
|
|
1451
1664
|
* <p>The API's description.</p>
|
|
1452
1665
|
*/
|
|
1453
1666
|
description?: string;
|
|
1454
1667
|
/**
|
|
1668
|
+
* @public
|
|
1455
1669
|
* <p>The timestamp when the API was created.</p>
|
|
1456
1670
|
*/
|
|
1457
1671
|
createdDate?: Date;
|
|
1458
1672
|
/**
|
|
1673
|
+
* @public
|
|
1459
1674
|
* <p>A version identifier for the API.</p>
|
|
1460
1675
|
*/
|
|
1461
1676
|
version?: string;
|
|
1462
1677
|
/**
|
|
1678
|
+
* @public
|
|
1463
1679
|
* <p>The warning messages reported when <code>failonwarnings</code> is turned on during API import.</p>
|
|
1464
1680
|
*/
|
|
1465
1681
|
warnings?: string[];
|
|
1466
1682
|
/**
|
|
1683
|
+
* @public
|
|
1467
1684
|
* <p>The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.</p>
|
|
1468
1685
|
*/
|
|
1469
1686
|
binaryMediaTypes?: string[];
|
|
1470
1687
|
/**
|
|
1688
|
+
* @public
|
|
1471
1689
|
* <p>A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.</p>
|
|
1472
1690
|
*/
|
|
1473
1691
|
minimumCompressionSize?: number;
|
|
1474
1692
|
/**
|
|
1693
|
+
* @public
|
|
1475
1694
|
* <p>The source of the API key for metering requests according to a usage plan. Valid values
|
|
1476
1695
|
* are: ><code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a
|
|
1477
1696
|
* request. <code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code>
|
|
@@ -1479,18 +1698,22 @@ export interface RestApi {
|
|
|
1479
1698
|
*/
|
|
1480
1699
|
apiKeySource?: ApiKeySourceType | string;
|
|
1481
1700
|
/**
|
|
1701
|
+
* @public
|
|
1482
1702
|
* <p>The endpoint configuration of this RestApi showing the endpoint types of the API. </p>
|
|
1483
1703
|
*/
|
|
1484
1704
|
endpointConfiguration?: EndpointConfiguration;
|
|
1485
1705
|
/**
|
|
1706
|
+
* @public
|
|
1486
1707
|
* <p>A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.</p>
|
|
1487
1708
|
*/
|
|
1488
1709
|
policy?: string;
|
|
1489
1710
|
/**
|
|
1711
|
+
* @public
|
|
1490
1712
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
1491
1713
|
*/
|
|
1492
1714
|
tags?: Record<string, string>;
|
|
1493
1715
|
/**
|
|
1716
|
+
* @public
|
|
1494
1717
|
* <p>Specifies whether clients can invoke your API by using the default <code>execute-api</code> endpoint.
|
|
1495
1718
|
* By default, clients can invoke your API with the default
|
|
1496
1719
|
* <code>https://\{api_id\}.execute-api.\{region\}.amazonaws.com</code> endpoint. To require that clients use a
|
|
@@ -1504,18 +1727,22 @@ export interface RestApi {
|
|
|
1504
1727
|
*/
|
|
1505
1728
|
export interface CanarySettings {
|
|
1506
1729
|
/**
|
|
1730
|
+
* @public
|
|
1507
1731
|
* <p>The percent (0-100) of traffic diverted to a canary deployment.</p>
|
|
1508
1732
|
*/
|
|
1509
1733
|
percentTraffic?: number;
|
|
1510
1734
|
/**
|
|
1735
|
+
* @public
|
|
1511
1736
|
* <p>The ID of the canary deployment.</p>
|
|
1512
1737
|
*/
|
|
1513
1738
|
deploymentId?: string;
|
|
1514
1739
|
/**
|
|
1740
|
+
* @public
|
|
1515
1741
|
* <p>Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.</p>
|
|
1516
1742
|
*/
|
|
1517
1743
|
stageVariableOverrides?: Record<string, string>;
|
|
1518
1744
|
/**
|
|
1745
|
+
* @public
|
|
1519
1746
|
* <p>A Boolean flag to indicate whether the canary deployment uses the stage cache or not.</p>
|
|
1520
1747
|
*/
|
|
1521
1748
|
useStageCache?: boolean;
|
|
@@ -1526,48 +1753,59 @@ export interface CanarySettings {
|
|
|
1526
1753
|
*/
|
|
1527
1754
|
export interface CreateStageRequest {
|
|
1528
1755
|
/**
|
|
1756
|
+
* @public
|
|
1529
1757
|
* <p>The string identifier of the associated RestApi.</p>
|
|
1530
1758
|
*/
|
|
1531
1759
|
restApiId: string | undefined;
|
|
1532
1760
|
/**
|
|
1761
|
+
* @public
|
|
1533
1762
|
* <p>The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.</p>
|
|
1534
1763
|
*/
|
|
1535
1764
|
stageName: string | undefined;
|
|
1536
1765
|
/**
|
|
1766
|
+
* @public
|
|
1537
1767
|
* <p>The identifier of the Deployment resource for the Stage resource.</p>
|
|
1538
1768
|
*/
|
|
1539
1769
|
deploymentId: string | undefined;
|
|
1540
1770
|
/**
|
|
1771
|
+
* @public
|
|
1541
1772
|
* <p>The description of the Stage resource.</p>
|
|
1542
1773
|
*/
|
|
1543
1774
|
description?: string;
|
|
1544
1775
|
/**
|
|
1776
|
+
* @public
|
|
1545
1777
|
* <p>Whether cache clustering is enabled for the stage.</p>
|
|
1546
1778
|
*/
|
|
1547
1779
|
cacheClusterEnabled?: boolean;
|
|
1548
1780
|
/**
|
|
1781
|
+
* @public
|
|
1549
1782
|
* <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>
|
|
1550
1783
|
*/
|
|
1551
1784
|
cacheClusterSize?: CacheClusterSize | string;
|
|
1552
1785
|
/**
|
|
1786
|
+
* @public
|
|
1553
1787
|
* <p>A map that defines the stage variables for the new Stage resource. Variable names
|
|
1554
1788
|
* can have alphanumeric and underscore characters, and the values must match
|
|
1555
1789
|
* <code>[A-Za-z0-9-._~:/?#&=,]+</code>.</p>
|
|
1556
1790
|
*/
|
|
1557
1791
|
variables?: Record<string, string>;
|
|
1558
1792
|
/**
|
|
1793
|
+
* @public
|
|
1559
1794
|
* <p>The version of the associated API documentation.</p>
|
|
1560
1795
|
*/
|
|
1561
1796
|
documentationVersion?: string;
|
|
1562
1797
|
/**
|
|
1798
|
+
* @public
|
|
1563
1799
|
* <p>The canary deployment settings of this stage.</p>
|
|
1564
1800
|
*/
|
|
1565
1801
|
canarySettings?: CanarySettings;
|
|
1566
1802
|
/**
|
|
1803
|
+
* @public
|
|
1567
1804
|
* <p>Specifies whether active tracing with X-ray is enabled for the Stage.</p>
|
|
1568
1805
|
*/
|
|
1569
1806
|
tracingEnabled?: boolean;
|
|
1570
1807
|
/**
|
|
1808
|
+
* @public
|
|
1571
1809
|
* <p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</p>
|
|
1572
1810
|
*/
|
|
1573
1811
|
tags?: Record<string, string>;
|
|
@@ -1606,42 +1844,52 @@ export type UnauthorizedCacheControlHeaderStrategy = (typeof UnauthorizedCacheCo
|
|
|
1606
1844
|
*/
|
|
1607
1845
|
export interface MethodSetting {
|
|
1608
1846
|
/**
|
|
1847
|
+
* @public
|
|
1609
1848
|
* <p>Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is <code>/\{method_setting_key\}/metrics/enabled</code>, and the value is a Boolean.</p>
|
|
1610
1849
|
*/
|
|
1611
1850
|
metricsEnabled?: boolean;
|
|
1612
1851
|
/**
|
|
1852
|
+
* @public
|
|
1613
1853
|
* <p>Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is <code>/\{method_setting_key\}/logging/loglevel</code>, and the available levels 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>
|
|
1614
1854
|
*/
|
|
1615
1855
|
loggingLevel?: string;
|
|
1616
1856
|
/**
|
|
1857
|
+
* @public
|
|
1617
1858
|
* <p>Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is <code>/\{method_setting_key\}/logging/dataTrace</code>, and the value is a Boolean.</p>
|
|
1618
1859
|
*/
|
|
1619
1860
|
dataTraceEnabled?: boolean;
|
|
1620
1861
|
/**
|
|
1862
|
+
* @public
|
|
1621
1863
|
* <p>Specifies the throttling burst limit. The PATCH path for this setting is <code>/\{method_setting_key\}/throttling/burstLimit</code>, and the value is an integer.</p>
|
|
1622
1864
|
*/
|
|
1623
1865
|
throttlingBurstLimit?: number;
|
|
1624
1866
|
/**
|
|
1867
|
+
* @public
|
|
1625
1868
|
* <p>Specifies the throttling rate limit. The PATCH path for this setting is <code>/\{method_setting_key\}/throttling/rateLimit</code>, and the value is a double.</p>
|
|
1626
1869
|
*/
|
|
1627
1870
|
throttlingRateLimit?: number;
|
|
1628
1871
|
/**
|
|
1872
|
+
* @public
|
|
1629
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. The PATCH path for this setting is <code>/\{method_setting_key\}/caching/enabled</code>, and the value is a Boolean.</p>
|
|
1630
1874
|
*/
|
|
1631
1875
|
cachingEnabled?: boolean;
|
|
1632
1876
|
/**
|
|
1877
|
+
* @public
|
|
1633
1878
|
* <p>Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is <code>/\{method_setting_key\}/caching/ttlInSeconds</code>, and the value is an integer.</p>
|
|
1634
1879
|
*/
|
|
1635
1880
|
cacheTtlInSeconds?: number;
|
|
1636
1881
|
/**
|
|
1882
|
+
* @public
|
|
1637
1883
|
* <p>Specifies whether the cached responses are encrypted. The PATCH path for this setting is <code>/\{method_setting_key\}/caching/dataEncrypted</code>, and the value is a Boolean.</p>
|
|
1638
1884
|
*/
|
|
1639
1885
|
cacheDataEncrypted?: boolean;
|
|
1640
1886
|
/**
|
|
1887
|
+
* @public
|
|
1641
1888
|
* <p>Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is <code>/\{method_setting_key\}/caching/requireAuthorizationForCacheControl</code>, and the value is a Boolean.</p>
|
|
1642
1889
|
*/
|
|
1643
1890
|
requireAuthorizationForCacheControl?: boolean;
|
|
1644
1891
|
/**
|
|
1892
|
+
* @public
|
|
1645
1893
|
* <p>Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is <code>/\{method_setting_key\}/caching/unauthorizedCacheControlHeaderStrategy</code>, and the available values are <code>FAIL_WITH_403</code>, <code>SUCCEED_WITH_RESPONSE_HEADER</code>, <code>SUCCEED_WITHOUT_RESPONSE_HEADER</code>.</p>
|
|
1646
1894
|
*/
|
|
1647
1895
|
unauthorizedCacheControlHeaderStrategy?: UnauthorizedCacheControlHeaderStrategy | string;
|
|
@@ -1652,71 +1900,88 @@ export interface MethodSetting {
|
|
|
1652
1900
|
*/
|
|
1653
1901
|
export interface Stage {
|
|
1654
1902
|
/**
|
|
1903
|
+
* @public
|
|
1655
1904
|
* <p>The identifier of the Deployment that the stage points to.</p>
|
|
1656
1905
|
*/
|
|
1657
1906
|
deploymentId?: string;
|
|
1658
1907
|
/**
|
|
1908
|
+
* @public
|
|
1659
1909
|
* <p>The identifier of a client certificate for an API stage.</p>
|
|
1660
1910
|
*/
|
|
1661
1911
|
clientCertificateId?: string;
|
|
1662
1912
|
/**
|
|
1913
|
+
* @public
|
|
1663
1914
|
* <p>The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.</p>
|
|
1664
1915
|
*/
|
|
1665
1916
|
stageName?: string;
|
|
1666
1917
|
/**
|
|
1918
|
+
* @public
|
|
1667
1919
|
* <p>The stage's description.</p>
|
|
1668
1920
|
*/
|
|
1669
1921
|
description?: string;
|
|
1670
1922
|
/**
|
|
1923
|
+
* @public
|
|
1671
1924
|
* <p>Specifies whether a cache cluster is enabled for the stage.</p>
|
|
1672
1925
|
*/
|
|
1673
1926
|
cacheClusterEnabled?: boolean;
|
|
1674
1927
|
/**
|
|
1928
|
+
* @public
|
|
1675
1929
|
* <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>
|
|
1676
1930
|
*/
|
|
1677
1931
|
cacheClusterSize?: CacheClusterSize | string;
|
|
1678
1932
|
/**
|
|
1933
|
+
* @public
|
|
1679
1934
|
* <p>The status of the cache cluster for the stage, if enabled.</p>
|
|
1680
1935
|
*/
|
|
1681
1936
|
cacheClusterStatus?: CacheClusterStatus | string;
|
|
1682
1937
|
/**
|
|
1938
|
+
* @public
|
|
1683
1939
|
* <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>
|
|
1684
1940
|
*/
|
|
1685
1941
|
methodSettings?: Record<string, MethodSetting>;
|
|
1686
1942
|
/**
|
|
1943
|
+
* @public
|
|
1687
1944
|
* <p>A map that defines the stage variables for a Stage resource. Variable names can
|
|
1688
1945
|
* have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&=,]+</code>.</p>
|
|
1689
1946
|
*/
|
|
1690
1947
|
variables?: Record<string, string>;
|
|
1691
1948
|
/**
|
|
1949
|
+
* @public
|
|
1692
1950
|
* <p>The version of the associated API documentation.</p>
|
|
1693
1951
|
*/
|
|
1694
1952
|
documentationVersion?: string;
|
|
1695
1953
|
/**
|
|
1954
|
+
* @public
|
|
1696
1955
|
* <p>Settings for logging access in this stage.</p>
|
|
1697
1956
|
*/
|
|
1698
1957
|
accessLogSettings?: AccessLogSettings;
|
|
1699
1958
|
/**
|
|
1959
|
+
* @public
|
|
1700
1960
|
* <p>Settings for the canary deployment in this stage.</p>
|
|
1701
1961
|
*/
|
|
1702
1962
|
canarySettings?: CanarySettings;
|
|
1703
1963
|
/**
|
|
1964
|
+
* @public
|
|
1704
1965
|
* <p>Specifies whether active tracing with X-ray is enabled for the Stage.</p>
|
|
1705
1966
|
*/
|
|
1706
1967
|
tracingEnabled?: boolean;
|
|
1707
1968
|
/**
|
|
1969
|
+
* @public
|
|
1708
1970
|
* <p>The ARN of the WebAcl associated with the Stage.</p>
|
|
1709
1971
|
*/
|
|
1710
1972
|
webAclArn?: string;
|
|
1711
1973
|
/**
|
|
1974
|
+
* @public
|
|
1712
1975
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
1713
1976
|
*/
|
|
1714
1977
|
tags?: Record<string, string>;
|
|
1715
1978
|
/**
|
|
1979
|
+
* @public
|
|
1716
1980
|
* <p>The timestamp when the stage was created.</p>
|
|
1717
1981
|
*/
|
|
1718
1982
|
createdDate?: Date;
|
|
1719
1983
|
/**
|
|
1984
|
+
* @public
|
|
1720
1985
|
* <p>The timestamp when the stage last updated.</p>
|
|
1721
1986
|
*/
|
|
1722
1987
|
lastUpdatedDate?: Date;
|
|
@@ -1740,14 +2005,17 @@ export type QuotaPeriodType = (typeof QuotaPeriodType)[keyof typeof QuotaPeriodT
|
|
|
1740
2005
|
*/
|
|
1741
2006
|
export interface QuotaSettings {
|
|
1742
2007
|
/**
|
|
2008
|
+
* @public
|
|
1743
2009
|
* <p>The target maximum number of requests that can be made in a given time period.</p>
|
|
1744
2010
|
*/
|
|
1745
2011
|
limit?: number;
|
|
1746
2012
|
/**
|
|
2013
|
+
* @public
|
|
1747
2014
|
* <p>The number of requests subtracted from the given limit in the initial time period.</p>
|
|
1748
2015
|
*/
|
|
1749
2016
|
offset?: number;
|
|
1750
2017
|
/**
|
|
2018
|
+
* @public
|
|
1751
2019
|
* <p>The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".</p>
|
|
1752
2020
|
*/
|
|
1753
2021
|
period?: QuotaPeriodType | string;
|
|
@@ -1758,26 +2026,32 @@ export interface QuotaSettings {
|
|
|
1758
2026
|
*/
|
|
1759
2027
|
export interface CreateUsagePlanRequest {
|
|
1760
2028
|
/**
|
|
2029
|
+
* @public
|
|
1761
2030
|
* <p>The name of the usage plan.</p>
|
|
1762
2031
|
*/
|
|
1763
2032
|
name: string | undefined;
|
|
1764
2033
|
/**
|
|
2034
|
+
* @public
|
|
1765
2035
|
* <p>The description of the usage plan.</p>
|
|
1766
2036
|
*/
|
|
1767
2037
|
description?: string;
|
|
1768
2038
|
/**
|
|
2039
|
+
* @public
|
|
1769
2040
|
* <p>The associated API stages of the usage plan.</p>
|
|
1770
2041
|
*/
|
|
1771
2042
|
apiStages?: ApiStage[];
|
|
1772
2043
|
/**
|
|
2044
|
+
* @public
|
|
1773
2045
|
* <p>The throttling limits of the usage plan.</p>
|
|
1774
2046
|
*/
|
|
1775
2047
|
throttle?: ThrottleSettings;
|
|
1776
2048
|
/**
|
|
2049
|
+
* @public
|
|
1777
2050
|
* <p>The quota of the usage plan.</p>
|
|
1778
2051
|
*/
|
|
1779
2052
|
quota?: QuotaSettings;
|
|
1780
2053
|
/**
|
|
2054
|
+
* @public
|
|
1781
2055
|
* <p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</p>
|
|
1782
2056
|
*/
|
|
1783
2057
|
tags?: Record<string, string>;
|
|
@@ -1791,34 +2065,42 @@ export interface CreateUsagePlanRequest {
|
|
|
1791
2065
|
*/
|
|
1792
2066
|
export interface UsagePlan {
|
|
1793
2067
|
/**
|
|
2068
|
+
* @public
|
|
1794
2069
|
* <p>The identifier of a UsagePlan resource.</p>
|
|
1795
2070
|
*/
|
|
1796
2071
|
id?: string;
|
|
1797
2072
|
/**
|
|
2073
|
+
* @public
|
|
1798
2074
|
* <p>The name of a usage plan.</p>
|
|
1799
2075
|
*/
|
|
1800
2076
|
name?: string;
|
|
1801
2077
|
/**
|
|
2078
|
+
* @public
|
|
1802
2079
|
* <p>The description of a usage plan.</p>
|
|
1803
2080
|
*/
|
|
1804
2081
|
description?: string;
|
|
1805
2082
|
/**
|
|
2083
|
+
* @public
|
|
1806
2084
|
* <p>The associated API stages of a usage plan.</p>
|
|
1807
2085
|
*/
|
|
1808
2086
|
apiStages?: ApiStage[];
|
|
1809
2087
|
/**
|
|
2088
|
+
* @public
|
|
1810
2089
|
* <p>A map containing method level throttling information for API stage in a usage plan.</p>
|
|
1811
2090
|
*/
|
|
1812
2091
|
throttle?: ThrottleSettings;
|
|
1813
2092
|
/**
|
|
2093
|
+
* @public
|
|
1814
2094
|
* <p>The target maximum number of permitted requests per a given unit time interval.</p>
|
|
1815
2095
|
*/
|
|
1816
2096
|
quota?: QuotaSettings;
|
|
1817
2097
|
/**
|
|
2098
|
+
* @public
|
|
1818
2099
|
* <p>The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.</p>
|
|
1819
2100
|
*/
|
|
1820
2101
|
productCode?: string;
|
|
1821
2102
|
/**
|
|
2103
|
+
* @public
|
|
1822
2104
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
1823
2105
|
*/
|
|
1824
2106
|
tags?: Record<string, string>;
|
|
@@ -1829,14 +2111,17 @@ export interface UsagePlan {
|
|
|
1829
2111
|
*/
|
|
1830
2112
|
export interface CreateUsagePlanKeyRequest {
|
|
1831
2113
|
/**
|
|
2114
|
+
* @public
|
|
1832
2115
|
* <p>The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.</p>
|
|
1833
2116
|
*/
|
|
1834
2117
|
usagePlanId: string | undefined;
|
|
1835
2118
|
/**
|
|
2119
|
+
* @public
|
|
1836
2120
|
* <p>The identifier of a UsagePlanKey resource for a plan customer.</p>
|
|
1837
2121
|
*/
|
|
1838
2122
|
keyId: string | undefined;
|
|
1839
2123
|
/**
|
|
2124
|
+
* @public
|
|
1840
2125
|
* <p>The type of a UsagePlanKey resource for a plan customer.</p>
|
|
1841
2126
|
*/
|
|
1842
2127
|
keyType: string | undefined;
|
|
@@ -1847,18 +2132,22 @@ export interface CreateUsagePlanKeyRequest {
|
|
|
1847
2132
|
*/
|
|
1848
2133
|
export interface UsagePlanKey {
|
|
1849
2134
|
/**
|
|
2135
|
+
* @public
|
|
1850
2136
|
* <p>The Id of a usage plan key.</p>
|
|
1851
2137
|
*/
|
|
1852
2138
|
id?: string;
|
|
1853
2139
|
/**
|
|
2140
|
+
* @public
|
|
1854
2141
|
* <p>The type of a usage plan key. Currently, the valid key type is <code>API_KEY</code>.</p>
|
|
1855
2142
|
*/
|
|
1856
2143
|
type?: string;
|
|
1857
2144
|
/**
|
|
2145
|
+
* @public
|
|
1858
2146
|
* <p>The value of a usage plan key.</p>
|
|
1859
2147
|
*/
|
|
1860
2148
|
value?: string;
|
|
1861
2149
|
/**
|
|
2150
|
+
* @public
|
|
1862
2151
|
* <p>The name of a usage plan key.</p>
|
|
1863
2152
|
*/
|
|
1864
2153
|
name?: string;
|
|
@@ -1869,18 +2158,22 @@ export interface UsagePlanKey {
|
|
|
1869
2158
|
*/
|
|
1870
2159
|
export interface CreateVpcLinkRequest {
|
|
1871
2160
|
/**
|
|
2161
|
+
* @public
|
|
1872
2162
|
* <p>The name used to label and identify the VPC link.</p>
|
|
1873
2163
|
*/
|
|
1874
2164
|
name: string | undefined;
|
|
1875
2165
|
/**
|
|
2166
|
+
* @public
|
|
1876
2167
|
* <p>The description of the VPC link.</p>
|
|
1877
2168
|
*/
|
|
1878
2169
|
description?: string;
|
|
1879
2170
|
/**
|
|
2171
|
+
* @public
|
|
1880
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 AWS account of the API owner.</p>
|
|
1881
2173
|
*/
|
|
1882
2174
|
targetArns: string[] | undefined;
|
|
1883
2175
|
/**
|
|
2176
|
+
* @public
|
|
1884
2177
|
* <p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</p>
|
|
1885
2178
|
*/
|
|
1886
2179
|
tags?: Record<string, string>;
|
|
@@ -1905,30 +2198,37 @@ export type VpcLinkStatus = (typeof VpcLinkStatus)[keyof typeof VpcLinkStatus];
|
|
|
1905
2198
|
*/
|
|
1906
2199
|
export interface VpcLink {
|
|
1907
2200
|
/**
|
|
2201
|
+
* @public
|
|
1908
2202
|
* <p>The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.</p>
|
|
1909
2203
|
*/
|
|
1910
2204
|
id?: string;
|
|
1911
2205
|
/**
|
|
2206
|
+
* @public
|
|
1912
2207
|
* <p>The name used to label and identify the VPC link.</p>
|
|
1913
2208
|
*/
|
|
1914
2209
|
name?: string;
|
|
1915
2210
|
/**
|
|
2211
|
+
* @public
|
|
1916
2212
|
* <p>The description of the VPC link.</p>
|
|
1917
2213
|
*/
|
|
1918
2214
|
description?: string;
|
|
1919
2215
|
/**
|
|
2216
|
+
* @public
|
|
1920
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 AWS account of the API owner.</p>
|
|
1921
2218
|
*/
|
|
1922
2219
|
targetArns?: string[];
|
|
1923
2220
|
/**
|
|
2221
|
+
* @public
|
|
1924
2222
|
* <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>
|
|
1925
2223
|
*/
|
|
1926
2224
|
status?: VpcLinkStatus | string;
|
|
1927
2225
|
/**
|
|
2226
|
+
* @public
|
|
1928
2227
|
* <p>A description about the VPC link status.</p>
|
|
1929
2228
|
*/
|
|
1930
2229
|
statusMessage?: string;
|
|
1931
2230
|
/**
|
|
2231
|
+
* @public
|
|
1932
2232
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
1933
2233
|
*/
|
|
1934
2234
|
tags?: Record<string, string>;
|
|
@@ -1939,6 +2239,7 @@ export interface VpcLink {
|
|
|
1939
2239
|
*/
|
|
1940
2240
|
export interface DeleteApiKeyRequest {
|
|
1941
2241
|
/**
|
|
2242
|
+
* @public
|
|
1942
2243
|
* <p>The identifier of the ApiKey resource to be deleted.</p>
|
|
1943
2244
|
*/
|
|
1944
2245
|
apiKey: string | undefined;
|
|
@@ -1949,10 +2250,12 @@ export interface DeleteApiKeyRequest {
|
|
|
1949
2250
|
*/
|
|
1950
2251
|
export interface DeleteAuthorizerRequest {
|
|
1951
2252
|
/**
|
|
2253
|
+
* @public
|
|
1952
2254
|
* <p>The string identifier of the associated RestApi.</p>
|
|
1953
2255
|
*/
|
|
1954
2256
|
restApiId: string | undefined;
|
|
1955
2257
|
/**
|
|
2258
|
+
* @public
|
|
1956
2259
|
* <p>The identifier of the Authorizer resource.</p>
|
|
1957
2260
|
*/
|
|
1958
2261
|
authorizerId: string | undefined;
|
|
@@ -1963,10 +2266,12 @@ export interface DeleteAuthorizerRequest {
|
|
|
1963
2266
|
*/
|
|
1964
2267
|
export interface DeleteBasePathMappingRequest {
|
|
1965
2268
|
/**
|
|
2269
|
+
* @public
|
|
1966
2270
|
* <p>The domain name of the BasePathMapping resource to delete.</p>
|
|
1967
2271
|
*/
|
|
1968
2272
|
domainName: string | undefined;
|
|
1969
2273
|
/**
|
|
2274
|
+
* @public
|
|
1970
2275
|
* <p>The base path name of the BasePathMapping resource to delete.</p>
|
|
1971
2276
|
* <p>To specify an empty base path, set this parameter to <code>'(none)'</code>.</p>
|
|
1972
2277
|
*/
|
|
@@ -1978,6 +2283,7 @@ export interface DeleteBasePathMappingRequest {
|
|
|
1978
2283
|
*/
|
|
1979
2284
|
export interface DeleteClientCertificateRequest {
|
|
1980
2285
|
/**
|
|
2286
|
+
* @public
|
|
1981
2287
|
* <p>The identifier of the ClientCertificate resource to be deleted.</p>
|
|
1982
2288
|
*/
|
|
1983
2289
|
clientCertificateId: string | undefined;
|
|
@@ -1988,10 +2294,12 @@ export interface DeleteClientCertificateRequest {
|
|
|
1988
2294
|
*/
|
|
1989
2295
|
export interface DeleteDeploymentRequest {
|
|
1990
2296
|
/**
|
|
2297
|
+
* @public
|
|
1991
2298
|
* <p>The string identifier of the associated RestApi.</p>
|
|
1992
2299
|
*/
|
|
1993
2300
|
restApiId: string | undefined;
|
|
1994
2301
|
/**
|
|
2302
|
+
* @public
|
|
1995
2303
|
* <p>The identifier of the Deployment resource to delete.</p>
|
|
1996
2304
|
*/
|
|
1997
2305
|
deploymentId: string | undefined;
|
|
@@ -2002,10 +2310,12 @@ export interface DeleteDeploymentRequest {
|
|
|
2002
2310
|
*/
|
|
2003
2311
|
export interface DeleteDocumentationPartRequest {
|
|
2004
2312
|
/**
|
|
2313
|
+
* @public
|
|
2005
2314
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2006
2315
|
*/
|
|
2007
2316
|
restApiId: string | undefined;
|
|
2008
2317
|
/**
|
|
2318
|
+
* @public
|
|
2009
2319
|
* <p>The identifier of the to-be-deleted documentation part.</p>
|
|
2010
2320
|
*/
|
|
2011
2321
|
documentationPartId: string | undefined;
|
|
@@ -2016,10 +2326,12 @@ export interface DeleteDocumentationPartRequest {
|
|
|
2016
2326
|
*/
|
|
2017
2327
|
export interface DeleteDocumentationVersionRequest {
|
|
2018
2328
|
/**
|
|
2329
|
+
* @public
|
|
2019
2330
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2020
2331
|
*/
|
|
2021
2332
|
restApiId: string | undefined;
|
|
2022
2333
|
/**
|
|
2334
|
+
* @public
|
|
2023
2335
|
* <p>The version identifier of a to-be-deleted documentation snapshot.</p>
|
|
2024
2336
|
*/
|
|
2025
2337
|
documentationVersion: string | undefined;
|
|
@@ -2030,6 +2342,7 @@ export interface DeleteDocumentationVersionRequest {
|
|
|
2030
2342
|
*/
|
|
2031
2343
|
export interface DeleteDomainNameRequest {
|
|
2032
2344
|
/**
|
|
2345
|
+
* @public
|
|
2033
2346
|
* <p>The name of the DomainName resource to be deleted.</p>
|
|
2034
2347
|
*/
|
|
2035
2348
|
domainName: string | undefined;
|
|
@@ -2071,10 +2384,12 @@ export type GatewayResponseType = (typeof GatewayResponseType)[keyof typeof Gate
|
|
|
2071
2384
|
*/
|
|
2072
2385
|
export interface DeleteGatewayResponseRequest {
|
|
2073
2386
|
/**
|
|
2387
|
+
* @public
|
|
2074
2388
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2075
2389
|
*/
|
|
2076
2390
|
restApiId: string | undefined;
|
|
2077
2391
|
/**
|
|
2392
|
+
* @public
|
|
2078
2393
|
* <p>The response type of the associated GatewayResponse.</p>
|
|
2079
2394
|
*/
|
|
2080
2395
|
responseType: GatewayResponseType | string | undefined;
|
|
@@ -2085,14 +2400,17 @@ export interface DeleteGatewayResponseRequest {
|
|
|
2085
2400
|
*/
|
|
2086
2401
|
export interface DeleteIntegrationRequest {
|
|
2087
2402
|
/**
|
|
2403
|
+
* @public
|
|
2088
2404
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2089
2405
|
*/
|
|
2090
2406
|
restApiId: string | undefined;
|
|
2091
2407
|
/**
|
|
2408
|
+
* @public
|
|
2092
2409
|
* <p>Specifies a delete integration request's resource identifier.</p>
|
|
2093
2410
|
*/
|
|
2094
2411
|
resourceId: string | undefined;
|
|
2095
2412
|
/**
|
|
2413
|
+
* @public
|
|
2096
2414
|
* <p>Specifies a delete integration request's HTTP method.</p>
|
|
2097
2415
|
*/
|
|
2098
2416
|
httpMethod: string | undefined;
|
|
@@ -2103,18 +2421,22 @@ export interface DeleteIntegrationRequest {
|
|
|
2103
2421
|
*/
|
|
2104
2422
|
export interface DeleteIntegrationResponseRequest {
|
|
2105
2423
|
/**
|
|
2424
|
+
* @public
|
|
2106
2425
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2107
2426
|
*/
|
|
2108
2427
|
restApiId: string | undefined;
|
|
2109
2428
|
/**
|
|
2429
|
+
* @public
|
|
2110
2430
|
* <p>Specifies a delete integration response request's resource identifier.</p>
|
|
2111
2431
|
*/
|
|
2112
2432
|
resourceId: string | undefined;
|
|
2113
2433
|
/**
|
|
2434
|
+
* @public
|
|
2114
2435
|
* <p>Specifies a delete integration response request's HTTP method.</p>
|
|
2115
2436
|
*/
|
|
2116
2437
|
httpMethod: string | undefined;
|
|
2117
2438
|
/**
|
|
2439
|
+
* @public
|
|
2118
2440
|
* <p>Specifies a delete integration response request's status code.</p>
|
|
2119
2441
|
*/
|
|
2120
2442
|
statusCode: string | undefined;
|
|
@@ -2125,14 +2447,17 @@ export interface DeleteIntegrationResponseRequest {
|
|
|
2125
2447
|
*/
|
|
2126
2448
|
export interface DeleteMethodRequest {
|
|
2127
2449
|
/**
|
|
2450
|
+
* @public
|
|
2128
2451
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2129
2452
|
*/
|
|
2130
2453
|
restApiId: string | undefined;
|
|
2131
2454
|
/**
|
|
2455
|
+
* @public
|
|
2132
2456
|
* <p>The Resource identifier for the Method resource.</p>
|
|
2133
2457
|
*/
|
|
2134
2458
|
resourceId: string | undefined;
|
|
2135
2459
|
/**
|
|
2460
|
+
* @public
|
|
2136
2461
|
* <p>The HTTP verb of the Method resource.</p>
|
|
2137
2462
|
*/
|
|
2138
2463
|
httpMethod: string | undefined;
|
|
@@ -2143,18 +2468,22 @@ export interface DeleteMethodRequest {
|
|
|
2143
2468
|
*/
|
|
2144
2469
|
export interface DeleteMethodResponseRequest {
|
|
2145
2470
|
/**
|
|
2471
|
+
* @public
|
|
2146
2472
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2147
2473
|
*/
|
|
2148
2474
|
restApiId: string | undefined;
|
|
2149
2475
|
/**
|
|
2476
|
+
* @public
|
|
2150
2477
|
* <p>The Resource identifier for the MethodResponse resource.</p>
|
|
2151
2478
|
*/
|
|
2152
2479
|
resourceId: string | undefined;
|
|
2153
2480
|
/**
|
|
2481
|
+
* @public
|
|
2154
2482
|
* <p>The HTTP verb of the Method resource.</p>
|
|
2155
2483
|
*/
|
|
2156
2484
|
httpMethod: string | undefined;
|
|
2157
2485
|
/**
|
|
2486
|
+
* @public
|
|
2158
2487
|
* <p>The status code identifier for the MethodResponse resource.</p>
|
|
2159
2488
|
*/
|
|
2160
2489
|
statusCode: string | undefined;
|
|
@@ -2165,10 +2494,12 @@ export interface DeleteMethodResponseRequest {
|
|
|
2165
2494
|
*/
|
|
2166
2495
|
export interface DeleteModelRequest {
|
|
2167
2496
|
/**
|
|
2497
|
+
* @public
|
|
2168
2498
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2169
2499
|
*/
|
|
2170
2500
|
restApiId: string | undefined;
|
|
2171
2501
|
/**
|
|
2502
|
+
* @public
|
|
2172
2503
|
* <p>The name of the model to delete.</p>
|
|
2173
2504
|
*/
|
|
2174
2505
|
modelName: string | undefined;
|
|
@@ -2179,10 +2510,12 @@ export interface DeleteModelRequest {
|
|
|
2179
2510
|
*/
|
|
2180
2511
|
export interface DeleteRequestValidatorRequest {
|
|
2181
2512
|
/**
|
|
2513
|
+
* @public
|
|
2182
2514
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2183
2515
|
*/
|
|
2184
2516
|
restApiId: string | undefined;
|
|
2185
2517
|
/**
|
|
2518
|
+
* @public
|
|
2186
2519
|
* <p>The identifier of the RequestValidator to be deleted.</p>
|
|
2187
2520
|
*/
|
|
2188
2521
|
requestValidatorId: string | undefined;
|
|
@@ -2193,10 +2526,12 @@ export interface DeleteRequestValidatorRequest {
|
|
|
2193
2526
|
*/
|
|
2194
2527
|
export interface DeleteResourceRequest {
|
|
2195
2528
|
/**
|
|
2529
|
+
* @public
|
|
2196
2530
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2197
2531
|
*/
|
|
2198
2532
|
restApiId: string | undefined;
|
|
2199
2533
|
/**
|
|
2534
|
+
* @public
|
|
2200
2535
|
* <p>The identifier of the Resource resource.</p>
|
|
2201
2536
|
*/
|
|
2202
2537
|
resourceId: string | undefined;
|
|
@@ -2207,6 +2542,7 @@ export interface DeleteResourceRequest {
|
|
|
2207
2542
|
*/
|
|
2208
2543
|
export interface DeleteRestApiRequest {
|
|
2209
2544
|
/**
|
|
2545
|
+
* @public
|
|
2210
2546
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2211
2547
|
*/
|
|
2212
2548
|
restApiId: string | undefined;
|
|
@@ -2217,10 +2553,12 @@ export interface DeleteRestApiRequest {
|
|
|
2217
2553
|
*/
|
|
2218
2554
|
export interface DeleteStageRequest {
|
|
2219
2555
|
/**
|
|
2556
|
+
* @public
|
|
2220
2557
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2221
2558
|
*/
|
|
2222
2559
|
restApiId: string | undefined;
|
|
2223
2560
|
/**
|
|
2561
|
+
* @public
|
|
2224
2562
|
* <p>The name of the Stage resource to delete.</p>
|
|
2225
2563
|
*/
|
|
2226
2564
|
stageName: string | undefined;
|
|
@@ -2231,6 +2569,7 @@ export interface DeleteStageRequest {
|
|
|
2231
2569
|
*/
|
|
2232
2570
|
export interface DeleteUsagePlanRequest {
|
|
2233
2571
|
/**
|
|
2572
|
+
* @public
|
|
2234
2573
|
* <p>The Id of the to-be-deleted usage plan.</p>
|
|
2235
2574
|
*/
|
|
2236
2575
|
usagePlanId: string | undefined;
|
|
@@ -2241,10 +2580,12 @@ export interface DeleteUsagePlanRequest {
|
|
|
2241
2580
|
*/
|
|
2242
2581
|
export interface DeleteUsagePlanKeyRequest {
|
|
2243
2582
|
/**
|
|
2583
|
+
* @public
|
|
2244
2584
|
* <p>The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.</p>
|
|
2245
2585
|
*/
|
|
2246
2586
|
usagePlanId: string | undefined;
|
|
2247
2587
|
/**
|
|
2588
|
+
* @public
|
|
2248
2589
|
* <p>The Id of the UsagePlanKey resource to be deleted.</p>
|
|
2249
2590
|
*/
|
|
2250
2591
|
keyId: string | undefined;
|
|
@@ -2255,6 +2596,7 @@ export interface DeleteUsagePlanKeyRequest {
|
|
|
2255
2596
|
*/
|
|
2256
2597
|
export interface DeleteVpcLinkRequest {
|
|
2257
2598
|
/**
|
|
2599
|
+
* @public
|
|
2258
2600
|
* <p>The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.</p>
|
|
2259
2601
|
*/
|
|
2260
2602
|
vpcLinkId: string | undefined;
|
|
@@ -2265,10 +2607,12 @@ export interface DeleteVpcLinkRequest {
|
|
|
2265
2607
|
*/
|
|
2266
2608
|
export interface FlushStageAuthorizersCacheRequest {
|
|
2267
2609
|
/**
|
|
2610
|
+
* @public
|
|
2268
2611
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2269
2612
|
*/
|
|
2270
2613
|
restApiId: string | undefined;
|
|
2271
2614
|
/**
|
|
2615
|
+
* @public
|
|
2272
2616
|
* <p>The name of the stage to flush.</p>
|
|
2273
2617
|
*/
|
|
2274
2618
|
stageName: string | undefined;
|
|
@@ -2279,10 +2623,12 @@ export interface FlushStageAuthorizersCacheRequest {
|
|
|
2279
2623
|
*/
|
|
2280
2624
|
export interface FlushStageCacheRequest {
|
|
2281
2625
|
/**
|
|
2626
|
+
* @public
|
|
2282
2627
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2283
2628
|
*/
|
|
2284
2629
|
restApiId: string | undefined;
|
|
2285
2630
|
/**
|
|
2631
|
+
* @public
|
|
2286
2632
|
* <p>The name of the stage to flush its cache.</p>
|
|
2287
2633
|
*/
|
|
2288
2634
|
stageName: string | undefined;
|
|
@@ -2293,26 +2639,32 @@ export interface FlushStageCacheRequest {
|
|
|
2293
2639
|
*/
|
|
2294
2640
|
export interface ClientCertificate {
|
|
2295
2641
|
/**
|
|
2642
|
+
* @public
|
|
2296
2643
|
* <p>The identifier of the client certificate.</p>
|
|
2297
2644
|
*/
|
|
2298
2645
|
clientCertificateId?: string;
|
|
2299
2646
|
/**
|
|
2647
|
+
* @public
|
|
2300
2648
|
* <p>The description of the client certificate.</p>
|
|
2301
2649
|
*/
|
|
2302
2650
|
description?: string;
|
|
2303
2651
|
/**
|
|
2652
|
+
* @public
|
|
2304
2653
|
* <p>The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .</p>
|
|
2305
2654
|
*/
|
|
2306
2655
|
pemEncodedCertificate?: string;
|
|
2307
2656
|
/**
|
|
2657
|
+
* @public
|
|
2308
2658
|
* <p>The timestamp when the client certificate was created.</p>
|
|
2309
2659
|
*/
|
|
2310
2660
|
createdDate?: Date;
|
|
2311
2661
|
/**
|
|
2662
|
+
* @public
|
|
2312
2663
|
* <p>The timestamp when the client certificate will expire.</p>
|
|
2313
2664
|
*/
|
|
2314
2665
|
expirationDate?: Date;
|
|
2315
2666
|
/**
|
|
2667
|
+
* @public
|
|
2316
2668
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
2317
2669
|
*/
|
|
2318
2670
|
tags?: Record<string, string>;
|
|
@@ -2323,10 +2675,12 @@ export interface ClientCertificate {
|
|
|
2323
2675
|
*/
|
|
2324
2676
|
export interface GenerateClientCertificateRequest {
|
|
2325
2677
|
/**
|
|
2678
|
+
* @public
|
|
2326
2679
|
* <p>The description of the ClientCertificate.</p>
|
|
2327
2680
|
*/
|
|
2328
2681
|
description?: string;
|
|
2329
2682
|
/**
|
|
2683
|
+
* @public
|
|
2330
2684
|
* <p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</p>
|
|
2331
2685
|
*/
|
|
2332
2686
|
tags?: Record<string, string>;
|
|
@@ -2343,10 +2697,12 @@ export interface GetAccountRequest {
|
|
|
2343
2697
|
*/
|
|
2344
2698
|
export interface GetApiKeyRequest {
|
|
2345
2699
|
/**
|
|
2700
|
+
* @public
|
|
2346
2701
|
* <p>The identifier of the ApiKey resource.</p>
|
|
2347
2702
|
*/
|
|
2348
2703
|
apiKey: string | undefined;
|
|
2349
2704
|
/**
|
|
2705
|
+
* @public
|
|
2350
2706
|
* <p>A boolean flag to specify whether (<code>true</code>) or not (<code>false</code>) the result contains the key value.</p>
|
|
2351
2707
|
*/
|
|
2352
2708
|
includeValue?: boolean;
|
|
@@ -2357,22 +2713,27 @@ export interface GetApiKeyRequest {
|
|
|
2357
2713
|
*/
|
|
2358
2714
|
export interface GetApiKeysRequest {
|
|
2359
2715
|
/**
|
|
2716
|
+
* @public
|
|
2360
2717
|
* <p>The current pagination position in the paged result set.</p>
|
|
2361
2718
|
*/
|
|
2362
2719
|
position?: string;
|
|
2363
2720
|
/**
|
|
2721
|
+
* @public
|
|
2364
2722
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
2365
2723
|
*/
|
|
2366
2724
|
limit?: number;
|
|
2367
2725
|
/**
|
|
2726
|
+
* @public
|
|
2368
2727
|
* <p>The name of queried API keys.</p>
|
|
2369
2728
|
*/
|
|
2370
2729
|
nameQuery?: string;
|
|
2371
2730
|
/**
|
|
2731
|
+
* @public
|
|
2372
2732
|
* <p>The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.</p>
|
|
2373
2733
|
*/
|
|
2374
2734
|
customerId?: string;
|
|
2375
2735
|
/**
|
|
2736
|
+
* @public
|
|
2376
2737
|
* <p>A boolean flag to specify whether (<code>true</code>) or not (<code>false</code>) the result contains key values.</p>
|
|
2377
2738
|
*/
|
|
2378
2739
|
includeValues?: boolean;
|
|
@@ -2383,10 +2744,12 @@ export interface GetApiKeysRequest {
|
|
|
2383
2744
|
*/
|
|
2384
2745
|
export interface GetAuthorizerRequest {
|
|
2385
2746
|
/**
|
|
2747
|
+
* @public
|
|
2386
2748
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2387
2749
|
*/
|
|
2388
2750
|
restApiId: string | undefined;
|
|
2389
2751
|
/**
|
|
2752
|
+
* @public
|
|
2390
2753
|
* <p>The identifier of the Authorizer resource.</p>
|
|
2391
2754
|
*/
|
|
2392
2755
|
authorizerId: string | undefined;
|
|
@@ -2397,14 +2760,17 @@ export interface GetAuthorizerRequest {
|
|
|
2397
2760
|
*/
|
|
2398
2761
|
export interface GetAuthorizersRequest {
|
|
2399
2762
|
/**
|
|
2763
|
+
* @public
|
|
2400
2764
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2401
2765
|
*/
|
|
2402
2766
|
restApiId: string | undefined;
|
|
2403
2767
|
/**
|
|
2768
|
+
* @public
|
|
2404
2769
|
* <p>The current pagination position in the paged result set.</p>
|
|
2405
2770
|
*/
|
|
2406
2771
|
position?: string;
|
|
2407
2772
|
/**
|
|
2773
|
+
* @public
|
|
2408
2774
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
2409
2775
|
*/
|
|
2410
2776
|
limit?: number;
|
|
@@ -2415,10 +2781,12 @@ export interface GetAuthorizersRequest {
|
|
|
2415
2781
|
*/
|
|
2416
2782
|
export interface GetBasePathMappingRequest {
|
|
2417
2783
|
/**
|
|
2784
|
+
* @public
|
|
2418
2785
|
* <p>The domain name of the BasePathMapping resource to be described.</p>
|
|
2419
2786
|
*/
|
|
2420
2787
|
domainName: string | undefined;
|
|
2421
2788
|
/**
|
|
2789
|
+
* @public
|
|
2422
2790
|
* <p>The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.</p>
|
|
2423
2791
|
*/
|
|
2424
2792
|
basePath: string | undefined;
|
|
@@ -2429,10 +2797,12 @@ export interface GetBasePathMappingRequest {
|
|
|
2429
2797
|
*/
|
|
2430
2798
|
export interface BasePathMappings {
|
|
2431
2799
|
/**
|
|
2800
|
+
* @public
|
|
2432
2801
|
* <p>The current page of elements from this collection.</p>
|
|
2433
2802
|
*/
|
|
2434
2803
|
items?: BasePathMapping[];
|
|
2435
2804
|
/**
|
|
2805
|
+
* @public
|
|
2436
2806
|
* <p>The current pagination position in the paged result set.</p>
|
|
2437
2807
|
*/
|
|
2438
2808
|
position?: string;
|
|
@@ -2443,14 +2813,17 @@ export interface BasePathMappings {
|
|
|
2443
2813
|
*/
|
|
2444
2814
|
export interface GetBasePathMappingsRequest {
|
|
2445
2815
|
/**
|
|
2816
|
+
* @public
|
|
2446
2817
|
* <p>The domain name of a BasePathMapping resource.</p>
|
|
2447
2818
|
*/
|
|
2448
2819
|
domainName: string | undefined;
|
|
2449
2820
|
/**
|
|
2821
|
+
* @public
|
|
2450
2822
|
* <p>The current pagination position in the paged result set.</p>
|
|
2451
2823
|
*/
|
|
2452
2824
|
position?: string;
|
|
2453
2825
|
/**
|
|
2826
|
+
* @public
|
|
2454
2827
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
2455
2828
|
*/
|
|
2456
2829
|
limit?: number;
|
|
@@ -2461,6 +2834,7 @@ export interface GetBasePathMappingsRequest {
|
|
|
2461
2834
|
*/
|
|
2462
2835
|
export interface GetClientCertificateRequest {
|
|
2463
2836
|
/**
|
|
2837
|
+
* @public
|
|
2464
2838
|
* <p>The identifier of the ClientCertificate resource to be described.</p>
|
|
2465
2839
|
*/
|
|
2466
2840
|
clientCertificateId: string | undefined;
|
|
@@ -2471,10 +2845,12 @@ export interface GetClientCertificateRequest {
|
|
|
2471
2845
|
*/
|
|
2472
2846
|
export interface ClientCertificates {
|
|
2473
2847
|
/**
|
|
2848
|
+
* @public
|
|
2474
2849
|
* <p>The current page of elements from this collection.</p>
|
|
2475
2850
|
*/
|
|
2476
2851
|
items?: ClientCertificate[];
|
|
2477
2852
|
/**
|
|
2853
|
+
* @public
|
|
2478
2854
|
* <p>The current pagination position in the paged result set.</p>
|
|
2479
2855
|
*/
|
|
2480
2856
|
position?: string;
|
|
@@ -2485,10 +2861,12 @@ export interface ClientCertificates {
|
|
|
2485
2861
|
*/
|
|
2486
2862
|
export interface GetClientCertificatesRequest {
|
|
2487
2863
|
/**
|
|
2864
|
+
* @public
|
|
2488
2865
|
* <p>The current pagination position in the paged result set.</p>
|
|
2489
2866
|
*/
|
|
2490
2867
|
position?: string;
|
|
2491
2868
|
/**
|
|
2869
|
+
* @public
|
|
2492
2870
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
2493
2871
|
*/
|
|
2494
2872
|
limit?: number;
|
|
@@ -2499,14 +2877,17 @@ export interface GetClientCertificatesRequest {
|
|
|
2499
2877
|
*/
|
|
2500
2878
|
export interface GetDeploymentRequest {
|
|
2501
2879
|
/**
|
|
2880
|
+
* @public
|
|
2502
2881
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2503
2882
|
*/
|
|
2504
2883
|
restApiId: string | undefined;
|
|
2505
2884
|
/**
|
|
2885
|
+
* @public
|
|
2506
2886
|
* <p>The identifier of the Deployment resource to get information about.</p>
|
|
2507
2887
|
*/
|
|
2508
2888
|
deploymentId: string | undefined;
|
|
2509
2889
|
/**
|
|
2890
|
+
* @public
|
|
2510
2891
|
* <p>A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this <code>embed</code> parameter value is a list of comma-separated strings, as in <code>GET /restapis/\{restapi_id\}/deployments/\{deployment_id\}?embed=var1,var2</code>. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the <code>"apisummary"</code> string. For example, <code>GET /restapis/\{restapi_id\}/deployments/\{deployment_id\}?embed=apisummary</code>.</p>
|
|
2511
2892
|
*/
|
|
2512
2893
|
embed?: string[];
|
|
@@ -2517,10 +2898,12 @@ export interface GetDeploymentRequest {
|
|
|
2517
2898
|
*/
|
|
2518
2899
|
export interface Deployments {
|
|
2519
2900
|
/**
|
|
2901
|
+
* @public
|
|
2520
2902
|
* <p>The current page of elements from this collection.</p>
|
|
2521
2903
|
*/
|
|
2522
2904
|
items?: Deployment[];
|
|
2523
2905
|
/**
|
|
2906
|
+
* @public
|
|
2524
2907
|
* <p>The current pagination position in the paged result set.</p>
|
|
2525
2908
|
*/
|
|
2526
2909
|
position?: string;
|
|
@@ -2531,14 +2914,17 @@ export interface Deployments {
|
|
|
2531
2914
|
*/
|
|
2532
2915
|
export interface GetDeploymentsRequest {
|
|
2533
2916
|
/**
|
|
2917
|
+
* @public
|
|
2534
2918
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2535
2919
|
*/
|
|
2536
2920
|
restApiId: string | undefined;
|
|
2537
2921
|
/**
|
|
2922
|
+
* @public
|
|
2538
2923
|
* <p>The current pagination position in the paged result set.</p>
|
|
2539
2924
|
*/
|
|
2540
2925
|
position?: string;
|
|
2541
2926
|
/**
|
|
2927
|
+
* @public
|
|
2542
2928
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
2543
2929
|
*/
|
|
2544
2930
|
limit?: number;
|
|
@@ -2549,10 +2935,12 @@ export interface GetDeploymentsRequest {
|
|
|
2549
2935
|
*/
|
|
2550
2936
|
export interface GetDocumentationPartRequest {
|
|
2551
2937
|
/**
|
|
2938
|
+
* @public
|
|
2552
2939
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2553
2940
|
*/
|
|
2554
2941
|
restApiId: string | undefined;
|
|
2555
2942
|
/**
|
|
2943
|
+
* @public
|
|
2556
2944
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2557
2945
|
*/
|
|
2558
2946
|
documentationPartId: string | undefined;
|
|
@@ -2563,10 +2951,12 @@ export interface GetDocumentationPartRequest {
|
|
|
2563
2951
|
*/
|
|
2564
2952
|
export interface DocumentationParts {
|
|
2565
2953
|
/**
|
|
2954
|
+
* @public
|
|
2566
2955
|
* <p>The current page of elements from this collection.</p>
|
|
2567
2956
|
*/
|
|
2568
2957
|
items?: DocumentationPart[];
|
|
2569
2958
|
/**
|
|
2959
|
+
* @public
|
|
2570
2960
|
* <p>The current pagination position in the paged result set.</p>
|
|
2571
2961
|
*/
|
|
2572
2962
|
position?: string;
|
|
@@ -2589,30 +2979,37 @@ export type LocationStatusType = (typeof LocationStatusType)[keyof typeof Locati
|
|
|
2589
2979
|
*/
|
|
2590
2980
|
export interface GetDocumentationPartsRequest {
|
|
2591
2981
|
/**
|
|
2982
|
+
* @public
|
|
2592
2983
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2593
2984
|
*/
|
|
2594
2985
|
restApiId: string | undefined;
|
|
2595
2986
|
/**
|
|
2987
|
+
* @public
|
|
2596
2988
|
* <p>The type of API entities of the to-be-retrieved documentation parts. </p>
|
|
2597
2989
|
*/
|
|
2598
2990
|
type?: DocumentationPartType | string;
|
|
2599
2991
|
/**
|
|
2992
|
+
* @public
|
|
2600
2993
|
* <p>The name of API entities of the to-be-retrieved documentation parts.</p>
|
|
2601
2994
|
*/
|
|
2602
2995
|
nameQuery?: string;
|
|
2603
2996
|
/**
|
|
2997
|
+
* @public
|
|
2604
2998
|
* <p>The path of API entities of the to-be-retrieved documentation parts.</p>
|
|
2605
2999
|
*/
|
|
2606
3000
|
path?: string;
|
|
2607
3001
|
/**
|
|
3002
|
+
* @public
|
|
2608
3003
|
* <p>The current pagination position in the paged result set.</p>
|
|
2609
3004
|
*/
|
|
2610
3005
|
position?: string;
|
|
2611
3006
|
/**
|
|
3007
|
+
* @public
|
|
2612
3008
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
2613
3009
|
*/
|
|
2614
3010
|
limit?: number;
|
|
2615
3011
|
/**
|
|
3012
|
+
* @public
|
|
2616
3013
|
* <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>
|
|
2617
3014
|
*/
|
|
2618
3015
|
locationStatus?: LocationStatusType | string;
|
|
@@ -2623,10 +3020,12 @@ export interface GetDocumentationPartsRequest {
|
|
|
2623
3020
|
*/
|
|
2624
3021
|
export interface GetDocumentationVersionRequest {
|
|
2625
3022
|
/**
|
|
3023
|
+
* @public
|
|
2626
3024
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2627
3025
|
*/
|
|
2628
3026
|
restApiId: string | undefined;
|
|
2629
3027
|
/**
|
|
3028
|
+
* @public
|
|
2630
3029
|
* <p>The version identifier of the to-be-retrieved documentation snapshot.</p>
|
|
2631
3030
|
*/
|
|
2632
3031
|
documentationVersion: string | undefined;
|
|
@@ -2637,10 +3036,12 @@ export interface GetDocumentationVersionRequest {
|
|
|
2637
3036
|
*/
|
|
2638
3037
|
export interface DocumentationVersions {
|
|
2639
3038
|
/**
|
|
3039
|
+
* @public
|
|
2640
3040
|
* <p>The current page of elements from this collection.</p>
|
|
2641
3041
|
*/
|
|
2642
3042
|
items?: DocumentationVersion[];
|
|
2643
3043
|
/**
|
|
3044
|
+
* @public
|
|
2644
3045
|
* <p>The current pagination position in the paged result set.</p>
|
|
2645
3046
|
*/
|
|
2646
3047
|
position?: string;
|
|
@@ -2651,14 +3052,17 @@ export interface DocumentationVersions {
|
|
|
2651
3052
|
*/
|
|
2652
3053
|
export interface GetDocumentationVersionsRequest {
|
|
2653
3054
|
/**
|
|
3055
|
+
* @public
|
|
2654
3056
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2655
3057
|
*/
|
|
2656
3058
|
restApiId: string | undefined;
|
|
2657
3059
|
/**
|
|
3060
|
+
* @public
|
|
2658
3061
|
* <p>The current pagination position in the paged result set.</p>
|
|
2659
3062
|
*/
|
|
2660
3063
|
position?: string;
|
|
2661
3064
|
/**
|
|
3065
|
+
* @public
|
|
2662
3066
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
2663
3067
|
*/
|
|
2664
3068
|
limit?: number;
|
|
@@ -2669,6 +3073,7 @@ export interface GetDocumentationVersionsRequest {
|
|
|
2669
3073
|
*/
|
|
2670
3074
|
export interface GetDomainNameRequest {
|
|
2671
3075
|
/**
|
|
3076
|
+
* @public
|
|
2672
3077
|
* <p>The name of the DomainName resource.</p>
|
|
2673
3078
|
*/
|
|
2674
3079
|
domainName: string | undefined;
|
|
@@ -2679,10 +3084,12 @@ export interface GetDomainNameRequest {
|
|
|
2679
3084
|
*/
|
|
2680
3085
|
export interface DomainNames {
|
|
2681
3086
|
/**
|
|
3087
|
+
* @public
|
|
2682
3088
|
* <p>The current page of elements from this collection.</p>
|
|
2683
3089
|
*/
|
|
2684
3090
|
items?: DomainName[];
|
|
2685
3091
|
/**
|
|
3092
|
+
* @public
|
|
2686
3093
|
* <p>The current pagination position in the paged result set.</p>
|
|
2687
3094
|
*/
|
|
2688
3095
|
position?: string;
|
|
@@ -2693,10 +3100,12 @@ export interface DomainNames {
|
|
|
2693
3100
|
*/
|
|
2694
3101
|
export interface GetDomainNamesRequest {
|
|
2695
3102
|
/**
|
|
3103
|
+
* @public
|
|
2696
3104
|
* <p>The current pagination position in the paged result set.</p>
|
|
2697
3105
|
*/
|
|
2698
3106
|
position?: string;
|
|
2699
3107
|
/**
|
|
3108
|
+
* @public
|
|
2700
3109
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
2701
3110
|
*/
|
|
2702
3111
|
limit?: number;
|
|
@@ -2707,14 +3116,17 @@ export interface GetDomainNamesRequest {
|
|
|
2707
3116
|
*/
|
|
2708
3117
|
export interface ExportResponse {
|
|
2709
3118
|
/**
|
|
3119
|
+
* @public
|
|
2710
3120
|
* <p>The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.</p>
|
|
2711
3121
|
*/
|
|
2712
3122
|
contentType?: string;
|
|
2713
3123
|
/**
|
|
3124
|
+
* @public
|
|
2714
3125
|
* <p>The content-disposition header value in the HTTP response.</p>
|
|
2715
3126
|
*/
|
|
2716
3127
|
contentDisposition?: string;
|
|
2717
3128
|
/**
|
|
3129
|
+
* @public
|
|
2718
3130
|
* <p>The binary blob response to GetExport, which contains the export.</p>
|
|
2719
3131
|
*/
|
|
2720
3132
|
body?: Uint8Array;
|
|
@@ -2725,23 +3137,28 @@ export interface ExportResponse {
|
|
|
2725
3137
|
*/
|
|
2726
3138
|
export interface GetExportRequest {
|
|
2727
3139
|
/**
|
|
3140
|
+
* @public
|
|
2728
3141
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2729
3142
|
*/
|
|
2730
3143
|
restApiId: string | undefined;
|
|
2731
3144
|
/**
|
|
3145
|
+
* @public
|
|
2732
3146
|
* <p>The name of the Stage that will be exported.</p>
|
|
2733
3147
|
*/
|
|
2734
3148
|
stageName: string | undefined;
|
|
2735
3149
|
/**
|
|
3150
|
+
* @public
|
|
2736
3151
|
* <p>The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.</p>
|
|
2737
3152
|
*/
|
|
2738
3153
|
exportType: string | undefined;
|
|
2739
3154
|
/**
|
|
3155
|
+
* @public
|
|
2740
3156
|
* <p>A key-value map of query string parameters that specify properties of the export, depending on the requested <code>exportType</code>. For <code>exportType</code>
|
|
2741
3157
|
* <code>oas30</code> and <code>swagger</code>, any combination of the following parameters are supported: <code>extensions='integrations'</code> or <code>extensions='apigateway'</code> will export the API with x-amazon-apigateway-integration extensions. <code>extensions='authorizers'</code> will export the API with x-amazon-apigateway-authorizer extensions. <code>postman</code> will export the API with Postman extensions, allowing for import to the Postman tool</p>
|
|
2742
3158
|
*/
|
|
2743
3159
|
parameters?: Record<string, string>;
|
|
2744
3160
|
/**
|
|
3161
|
+
* @public
|
|
2745
3162
|
* <p>The content-type of the export, for example <code>application/json</code>. Currently <code>application/json</code> and <code>application/yaml</code> are supported for <code>exportType</code> of<code>oas30</code> and <code>swagger</code>. This should be specified in the <code>Accept</code> header for direct API requests.</p>
|
|
2746
3163
|
*/
|
|
2747
3164
|
accepts?: string;
|
|
@@ -2752,23 +3169,28 @@ export interface GetExportRequest {
|
|
|
2752
3169
|
*/
|
|
2753
3170
|
export interface GatewayResponse {
|
|
2754
3171
|
/**
|
|
3172
|
+
* @public
|
|
2755
3173
|
* <p>The response type of the associated GatewayResponse.</p>
|
|
2756
3174
|
*/
|
|
2757
3175
|
responseType?: GatewayResponseType | string;
|
|
2758
3176
|
/**
|
|
3177
|
+
* @public
|
|
2759
3178
|
* <p>The HTTP status code for this GatewayResponse.</p>
|
|
2760
3179
|
*/
|
|
2761
3180
|
statusCode?: string;
|
|
2762
3181
|
/**
|
|
3182
|
+
* @public
|
|
2763
3183
|
* <p>Response parameters (paths, query strings and headers) of the GatewayResponse as a
|
|
2764
3184
|
* string-to-string map of key-value pairs.</p>
|
|
2765
3185
|
*/
|
|
2766
3186
|
responseParameters?: Record<string, string>;
|
|
2767
3187
|
/**
|
|
3188
|
+
* @public
|
|
2768
3189
|
* <p>Response templates of the GatewayResponse as a string-to-string map of key-value pairs.</p>
|
|
2769
3190
|
*/
|
|
2770
3191
|
responseTemplates?: Record<string, string>;
|
|
2771
3192
|
/**
|
|
3193
|
+
* @public
|
|
2772
3194
|
* <p>A Boolean flag to indicate whether this GatewayResponse is the default gateway response (<code>true</code>) or not (<code>false</code>). A default gateway response is one generated by API Gateway without any customization by an API developer. </p>
|
|
2773
3195
|
*/
|
|
2774
3196
|
defaultResponse?: boolean;
|
|
@@ -2779,10 +3201,12 @@ export interface GatewayResponse {
|
|
|
2779
3201
|
*/
|
|
2780
3202
|
export interface GetGatewayResponseRequest {
|
|
2781
3203
|
/**
|
|
3204
|
+
* @public
|
|
2782
3205
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2783
3206
|
*/
|
|
2784
3207
|
restApiId: string | undefined;
|
|
2785
3208
|
/**
|
|
3209
|
+
* @public
|
|
2786
3210
|
* <p>The response type of the associated GatewayResponse.</p>
|
|
2787
3211
|
*/
|
|
2788
3212
|
responseType: GatewayResponseType | string | undefined;
|
|
@@ -2793,10 +3217,12 @@ export interface GetGatewayResponseRequest {
|
|
|
2793
3217
|
*/
|
|
2794
3218
|
export interface GatewayResponses {
|
|
2795
3219
|
/**
|
|
3220
|
+
* @public
|
|
2796
3221
|
* <p>Returns the entire collection, because of no pagination support.</p>
|
|
2797
3222
|
*/
|
|
2798
3223
|
items?: GatewayResponse[];
|
|
2799
3224
|
/**
|
|
3225
|
+
* @public
|
|
2800
3226
|
* <p>The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.</p>
|
|
2801
3227
|
*/
|
|
2802
3228
|
position?: string;
|
|
@@ -2807,14 +3233,17 @@ export interface GatewayResponses {
|
|
|
2807
3233
|
*/
|
|
2808
3234
|
export interface GetGatewayResponsesRequest {
|
|
2809
3235
|
/**
|
|
3236
|
+
* @public
|
|
2810
3237
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2811
3238
|
*/
|
|
2812
3239
|
restApiId: string | undefined;
|
|
2813
3240
|
/**
|
|
3241
|
+
* @public
|
|
2814
3242
|
* <p>The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.</p>
|
|
2815
3243
|
*/
|
|
2816
3244
|
position?: string;
|
|
2817
3245
|
/**
|
|
3246
|
+
* @public
|
|
2818
3247
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.</p>
|
|
2819
3248
|
*/
|
|
2820
3249
|
limit?: number;
|
|
@@ -2825,14 +3254,17 @@ export interface GetGatewayResponsesRequest {
|
|
|
2825
3254
|
*/
|
|
2826
3255
|
export interface GetIntegrationRequest {
|
|
2827
3256
|
/**
|
|
3257
|
+
* @public
|
|
2828
3258
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2829
3259
|
*/
|
|
2830
3260
|
restApiId: string | undefined;
|
|
2831
3261
|
/**
|
|
3262
|
+
* @public
|
|
2832
3263
|
* <p>Specifies a get integration request's resource identifier</p>
|
|
2833
3264
|
*/
|
|
2834
3265
|
resourceId: string | undefined;
|
|
2835
3266
|
/**
|
|
3267
|
+
* @public
|
|
2836
3268
|
* <p>Specifies a get integration request's HTTP method.</p>
|
|
2837
3269
|
*/
|
|
2838
3270
|
httpMethod: string | undefined;
|
|
@@ -2843,18 +3275,22 @@ export interface GetIntegrationRequest {
|
|
|
2843
3275
|
*/
|
|
2844
3276
|
export interface GetIntegrationResponseRequest {
|
|
2845
3277
|
/**
|
|
3278
|
+
* @public
|
|
2846
3279
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2847
3280
|
*/
|
|
2848
3281
|
restApiId: string | undefined;
|
|
2849
3282
|
/**
|
|
3283
|
+
* @public
|
|
2850
3284
|
* <p>Specifies a get integration response request's resource identifier.</p>
|
|
2851
3285
|
*/
|
|
2852
3286
|
resourceId: string | undefined;
|
|
2853
3287
|
/**
|
|
3288
|
+
* @public
|
|
2854
3289
|
* <p>Specifies a get integration response request's HTTP method.</p>
|
|
2855
3290
|
*/
|
|
2856
3291
|
httpMethod: string | undefined;
|
|
2857
3292
|
/**
|
|
3293
|
+
* @public
|
|
2858
3294
|
* <p>Specifies a get integration response request's status code.</p>
|
|
2859
3295
|
*/
|
|
2860
3296
|
statusCode: string | undefined;
|
|
@@ -2865,14 +3301,17 @@ export interface GetIntegrationResponseRequest {
|
|
|
2865
3301
|
*/
|
|
2866
3302
|
export interface GetMethodRequest {
|
|
2867
3303
|
/**
|
|
3304
|
+
* @public
|
|
2868
3305
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2869
3306
|
*/
|
|
2870
3307
|
restApiId: string | undefined;
|
|
2871
3308
|
/**
|
|
3309
|
+
* @public
|
|
2872
3310
|
* <p>The Resource identifier for the Method resource.</p>
|
|
2873
3311
|
*/
|
|
2874
3312
|
resourceId: string | undefined;
|
|
2875
3313
|
/**
|
|
3314
|
+
* @public
|
|
2876
3315
|
* <p>Specifies the method request's HTTP method type.</p>
|
|
2877
3316
|
*/
|
|
2878
3317
|
httpMethod: string | undefined;
|
|
@@ -2883,18 +3322,22 @@ export interface GetMethodRequest {
|
|
|
2883
3322
|
*/
|
|
2884
3323
|
export interface GetMethodResponseRequest {
|
|
2885
3324
|
/**
|
|
3325
|
+
* @public
|
|
2886
3326
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2887
3327
|
*/
|
|
2888
3328
|
restApiId: string | undefined;
|
|
2889
3329
|
/**
|
|
3330
|
+
* @public
|
|
2890
3331
|
* <p>The Resource identifier for the MethodResponse resource.</p>
|
|
2891
3332
|
*/
|
|
2892
3333
|
resourceId: string | undefined;
|
|
2893
3334
|
/**
|
|
3335
|
+
* @public
|
|
2894
3336
|
* <p>The HTTP verb of the Method resource.</p>
|
|
2895
3337
|
*/
|
|
2896
3338
|
httpMethod: string | undefined;
|
|
2897
3339
|
/**
|
|
3340
|
+
* @public
|
|
2898
3341
|
* <p>The status code for the MethodResponse resource.</p>
|
|
2899
3342
|
*/
|
|
2900
3343
|
statusCode: string | undefined;
|
|
@@ -2905,14 +3348,17 @@ export interface GetMethodResponseRequest {
|
|
|
2905
3348
|
*/
|
|
2906
3349
|
export interface GetModelRequest {
|
|
2907
3350
|
/**
|
|
3351
|
+
* @public
|
|
2908
3352
|
* <p>The RestApi identifier under which the Model exists.</p>
|
|
2909
3353
|
*/
|
|
2910
3354
|
restApiId: string | undefined;
|
|
2911
3355
|
/**
|
|
3356
|
+
* @public
|
|
2912
3357
|
* <p>The name of the model as an identifier.</p>
|
|
2913
3358
|
*/
|
|
2914
3359
|
modelName: string | undefined;
|
|
2915
3360
|
/**
|
|
3361
|
+
* @public
|
|
2916
3362
|
* <p>A query parameter of a Boolean value to resolve (<code>true</code>) all external model references and returns a flattened model schema or not (<code>false</code>) The default is <code>false</code>.</p>
|
|
2917
3363
|
*/
|
|
2918
3364
|
flatten?: boolean;
|
|
@@ -2923,14 +3369,17 @@ export interface GetModelRequest {
|
|
|
2923
3369
|
*/
|
|
2924
3370
|
export interface GetModelsRequest {
|
|
2925
3371
|
/**
|
|
3372
|
+
* @public
|
|
2926
3373
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2927
3374
|
*/
|
|
2928
3375
|
restApiId: string | undefined;
|
|
2929
3376
|
/**
|
|
3377
|
+
* @public
|
|
2930
3378
|
* <p>The current pagination position in the paged result set.</p>
|
|
2931
3379
|
*/
|
|
2932
3380
|
position?: string;
|
|
2933
3381
|
/**
|
|
3382
|
+
* @public
|
|
2934
3383
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
2935
3384
|
*/
|
|
2936
3385
|
limit?: number;
|
|
@@ -2941,10 +3390,12 @@ export interface GetModelsRequest {
|
|
|
2941
3390
|
*/
|
|
2942
3391
|
export interface Models {
|
|
2943
3392
|
/**
|
|
3393
|
+
* @public
|
|
2944
3394
|
* <p>The current page of elements from this collection.</p>
|
|
2945
3395
|
*/
|
|
2946
3396
|
items?: Model[];
|
|
2947
3397
|
/**
|
|
3398
|
+
* @public
|
|
2948
3399
|
* <p>The current pagination position in the paged result set.</p>
|
|
2949
3400
|
*/
|
|
2950
3401
|
position?: string;
|
|
@@ -2955,10 +3406,12 @@ export interface Models {
|
|
|
2955
3406
|
*/
|
|
2956
3407
|
export interface GetModelTemplateRequest {
|
|
2957
3408
|
/**
|
|
3409
|
+
* @public
|
|
2958
3410
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2959
3411
|
*/
|
|
2960
3412
|
restApiId: string | undefined;
|
|
2961
3413
|
/**
|
|
3414
|
+
* @public
|
|
2962
3415
|
* <p>The name of the model for which to generate a template.</p>
|
|
2963
3416
|
*/
|
|
2964
3417
|
modelName: string | undefined;
|
|
@@ -2969,6 +3422,7 @@ export interface GetModelTemplateRequest {
|
|
|
2969
3422
|
*/
|
|
2970
3423
|
export interface Template {
|
|
2971
3424
|
/**
|
|
3425
|
+
* @public
|
|
2972
3426
|
* <p>The Apache Velocity Template Language (VTL) template content used for the template resource.</p>
|
|
2973
3427
|
*/
|
|
2974
3428
|
value?: string;
|
|
@@ -2979,10 +3433,12 @@ export interface Template {
|
|
|
2979
3433
|
*/
|
|
2980
3434
|
export interface GetRequestValidatorRequest {
|
|
2981
3435
|
/**
|
|
3436
|
+
* @public
|
|
2982
3437
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2983
3438
|
*/
|
|
2984
3439
|
restApiId: string | undefined;
|
|
2985
3440
|
/**
|
|
3441
|
+
* @public
|
|
2986
3442
|
* <p>The identifier of the RequestValidator to be retrieved.</p>
|
|
2987
3443
|
*/
|
|
2988
3444
|
requestValidatorId: string | undefined;
|
|
@@ -2993,14 +3449,17 @@ export interface GetRequestValidatorRequest {
|
|
|
2993
3449
|
*/
|
|
2994
3450
|
export interface GetRequestValidatorsRequest {
|
|
2995
3451
|
/**
|
|
3452
|
+
* @public
|
|
2996
3453
|
* <p>The string identifier of the associated RestApi.</p>
|
|
2997
3454
|
*/
|
|
2998
3455
|
restApiId: string | undefined;
|
|
2999
3456
|
/**
|
|
3457
|
+
* @public
|
|
3000
3458
|
* <p>The current pagination position in the paged result set.</p>
|
|
3001
3459
|
*/
|
|
3002
3460
|
position?: string;
|
|
3003
3461
|
/**
|
|
3462
|
+
* @public
|
|
3004
3463
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3005
3464
|
*/
|
|
3006
3465
|
limit?: number;
|
|
@@ -3011,10 +3470,12 @@ export interface GetRequestValidatorsRequest {
|
|
|
3011
3470
|
*/
|
|
3012
3471
|
export interface RequestValidators {
|
|
3013
3472
|
/**
|
|
3473
|
+
* @public
|
|
3014
3474
|
* <p>The current page of elements from this collection.</p>
|
|
3015
3475
|
*/
|
|
3016
3476
|
items?: RequestValidator[];
|
|
3017
3477
|
/**
|
|
3478
|
+
* @public
|
|
3018
3479
|
* <p>The current pagination position in the paged result set.</p>
|
|
3019
3480
|
*/
|
|
3020
3481
|
position?: string;
|
|
@@ -3025,14 +3486,17 @@ export interface RequestValidators {
|
|
|
3025
3486
|
*/
|
|
3026
3487
|
export interface GetResourceRequest {
|
|
3027
3488
|
/**
|
|
3489
|
+
* @public
|
|
3028
3490
|
* <p>The string identifier of the associated RestApi.</p>
|
|
3029
3491
|
*/
|
|
3030
3492
|
restApiId: string | undefined;
|
|
3031
3493
|
/**
|
|
3494
|
+
* @public
|
|
3032
3495
|
* <p>The identifier for the Resource resource.</p>
|
|
3033
3496
|
*/
|
|
3034
3497
|
resourceId: string | undefined;
|
|
3035
3498
|
/**
|
|
3499
|
+
* @public
|
|
3036
3500
|
* <p>A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This <code>embed</code> parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the <code>"methods"</code> string. For example, <code>GET /restapis/\{restapi_id\}/resources/\{resource_id\}?embed=methods</code>.</p>
|
|
3037
3501
|
*/
|
|
3038
3502
|
embed?: string[];
|
|
@@ -3043,18 +3507,22 @@ export interface GetResourceRequest {
|
|
|
3043
3507
|
*/
|
|
3044
3508
|
export interface GetResourcesRequest {
|
|
3045
3509
|
/**
|
|
3510
|
+
* @public
|
|
3046
3511
|
* <p>The string identifier of the associated RestApi.</p>
|
|
3047
3512
|
*/
|
|
3048
3513
|
restApiId: string | undefined;
|
|
3049
3514
|
/**
|
|
3515
|
+
* @public
|
|
3050
3516
|
* <p>The current pagination position in the paged result set.</p>
|
|
3051
3517
|
*/
|
|
3052
3518
|
position?: string;
|
|
3053
3519
|
/**
|
|
3520
|
+
* @public
|
|
3054
3521
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3055
3522
|
*/
|
|
3056
3523
|
limit?: number;
|
|
3057
3524
|
/**
|
|
3525
|
+
* @public
|
|
3058
3526
|
* <p>A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This <code>embed</code> parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the <code>"methods"</code> string. For example, <code>GET /restapis/\{restapi_id\}/resources?embed=methods</code>.</p>
|
|
3059
3527
|
*/
|
|
3060
3528
|
embed?: string[];
|
|
@@ -3065,10 +3533,12 @@ export interface GetResourcesRequest {
|
|
|
3065
3533
|
*/
|
|
3066
3534
|
export interface Resources {
|
|
3067
3535
|
/**
|
|
3536
|
+
* @public
|
|
3068
3537
|
* <p>The current page of elements from this collection.</p>
|
|
3069
3538
|
*/
|
|
3070
3539
|
items?: Resource[];
|
|
3071
3540
|
/**
|
|
3541
|
+
* @public
|
|
3072
3542
|
* <p>The current pagination position in the paged result set.</p>
|
|
3073
3543
|
*/
|
|
3074
3544
|
position?: string;
|
|
@@ -3079,6 +3549,7 @@ export interface Resources {
|
|
|
3079
3549
|
*/
|
|
3080
3550
|
export interface GetRestApiRequest {
|
|
3081
3551
|
/**
|
|
3552
|
+
* @public
|
|
3082
3553
|
* <p>The string identifier of the associated RestApi.</p>
|
|
3083
3554
|
*/
|
|
3084
3555
|
restApiId: string | undefined;
|
|
@@ -3089,10 +3560,12 @@ export interface GetRestApiRequest {
|
|
|
3089
3560
|
*/
|
|
3090
3561
|
export interface GetRestApisRequest {
|
|
3091
3562
|
/**
|
|
3563
|
+
* @public
|
|
3092
3564
|
* <p>The current pagination position in the paged result set.</p>
|
|
3093
3565
|
*/
|
|
3094
3566
|
position?: string;
|
|
3095
3567
|
/**
|
|
3568
|
+
* @public
|
|
3096
3569
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3097
3570
|
*/
|
|
3098
3571
|
limit?: number;
|
|
@@ -3103,10 +3576,12 @@ export interface GetRestApisRequest {
|
|
|
3103
3576
|
*/
|
|
3104
3577
|
export interface RestApis {
|
|
3105
3578
|
/**
|
|
3579
|
+
* @public
|
|
3106
3580
|
* <p>The current page of elements from this collection.</p>
|
|
3107
3581
|
*/
|
|
3108
3582
|
items?: RestApi[];
|
|
3109
3583
|
/**
|
|
3584
|
+
* @public
|
|
3110
3585
|
* <p>The current pagination position in the paged result set.</p>
|
|
3111
3586
|
*/
|
|
3112
3587
|
position?: string;
|
|
@@ -3117,18 +3592,22 @@ export interface RestApis {
|
|
|
3117
3592
|
*/
|
|
3118
3593
|
export interface GetSdkRequest {
|
|
3119
3594
|
/**
|
|
3595
|
+
* @public
|
|
3120
3596
|
* <p>The string identifier of the associated RestApi.</p>
|
|
3121
3597
|
*/
|
|
3122
3598
|
restApiId: string | undefined;
|
|
3123
3599
|
/**
|
|
3600
|
+
* @public
|
|
3124
3601
|
* <p>The name of the Stage that the SDK will use.</p>
|
|
3125
3602
|
*/
|
|
3126
3603
|
stageName: string | undefined;
|
|
3127
3604
|
/**
|
|
3605
|
+
* @public
|
|
3128
3606
|
* <p>The language for the generated SDK. Currently <code>java</code>, <code>javascript</code>, <code>android</code>, <code>objectivec</code> (for iOS), <code>swift</code> (for iOS), and <code>ruby</code> are supported.</p>
|
|
3129
3607
|
*/
|
|
3130
3608
|
sdkType: string | undefined;
|
|
3131
3609
|
/**
|
|
3610
|
+
* @public
|
|
3132
3611
|
* <p>A string-to-string key-value map of query parameters <code>sdkType</code>-dependent properties of the SDK. For <code>sdkType</code> of <code>objectivec</code> or <code>swift</code>, a parameter named <code>classPrefix</code> is required. For <code>sdkType</code> of <code>android</code>, parameters named <code>groupId</code>, <code>artifactId</code>, <code>artifactVersion</code>, and <code>invokerPackage</code> are required. For <code>sdkType</code> of <code>java</code>, parameters named <code>serviceName</code> and <code>javaPackageName</code> are required. </p>
|
|
3133
3612
|
*/
|
|
3134
3613
|
parameters?: Record<string, string>;
|
|
@@ -3139,14 +3618,17 @@ export interface GetSdkRequest {
|
|
|
3139
3618
|
*/
|
|
3140
3619
|
export interface SdkResponse {
|
|
3141
3620
|
/**
|
|
3621
|
+
* @public
|
|
3142
3622
|
* <p>The content-type header value in the HTTP response.</p>
|
|
3143
3623
|
*/
|
|
3144
3624
|
contentType?: string;
|
|
3145
3625
|
/**
|
|
3626
|
+
* @public
|
|
3146
3627
|
* <p>The content-disposition header value in the HTTP response.</p>
|
|
3147
3628
|
*/
|
|
3148
3629
|
contentDisposition?: string;
|
|
3149
3630
|
/**
|
|
3631
|
+
* @public
|
|
3150
3632
|
* <p>The binary blob response to GetSdk, which contains the generated SDK.</p>
|
|
3151
3633
|
*/
|
|
3152
3634
|
body?: Uint8Array;
|
|
@@ -3157,6 +3639,7 @@ export interface SdkResponse {
|
|
|
3157
3639
|
*/
|
|
3158
3640
|
export interface GetSdkTypeRequest {
|
|
3159
3641
|
/**
|
|
3642
|
+
* @public
|
|
3160
3643
|
* <p>The identifier of the queried SdkType instance.</p>
|
|
3161
3644
|
*/
|
|
3162
3645
|
id: string | undefined;
|
|
@@ -3167,22 +3650,27 @@ export interface GetSdkTypeRequest {
|
|
|
3167
3650
|
*/
|
|
3168
3651
|
export interface SdkConfigurationProperty {
|
|
3169
3652
|
/**
|
|
3653
|
+
* @public
|
|
3170
3654
|
* <p>The name of a an SdkType configuration property.</p>
|
|
3171
3655
|
*/
|
|
3172
3656
|
name?: string;
|
|
3173
3657
|
/**
|
|
3658
|
+
* @public
|
|
3174
3659
|
* <p>The user-friendly name of an SdkType configuration property.</p>
|
|
3175
3660
|
*/
|
|
3176
3661
|
friendlyName?: string;
|
|
3177
3662
|
/**
|
|
3663
|
+
* @public
|
|
3178
3664
|
* <p>The description of an SdkType configuration property.</p>
|
|
3179
3665
|
*/
|
|
3180
3666
|
description?: string;
|
|
3181
3667
|
/**
|
|
3668
|
+
* @public
|
|
3182
3669
|
* <p>A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (<code>true</code>) or not (<code>false</code>).</p>
|
|
3183
3670
|
*/
|
|
3184
3671
|
required?: boolean;
|
|
3185
3672
|
/**
|
|
3673
|
+
* @public
|
|
3186
3674
|
* <p>The default value of an SdkType configuration property.</p>
|
|
3187
3675
|
*/
|
|
3188
3676
|
defaultValue?: string;
|
|
@@ -3193,18 +3681,22 @@ export interface SdkConfigurationProperty {
|
|
|
3193
3681
|
*/
|
|
3194
3682
|
export interface SdkType {
|
|
3195
3683
|
/**
|
|
3684
|
+
* @public
|
|
3196
3685
|
* <p>The identifier of an SdkType instance.</p>
|
|
3197
3686
|
*/
|
|
3198
3687
|
id?: string;
|
|
3199
3688
|
/**
|
|
3689
|
+
* @public
|
|
3200
3690
|
* <p>The user-friendly name of an SdkType instance.</p>
|
|
3201
3691
|
*/
|
|
3202
3692
|
friendlyName?: string;
|
|
3203
3693
|
/**
|
|
3694
|
+
* @public
|
|
3204
3695
|
* <p>The description of an SdkType.</p>
|
|
3205
3696
|
*/
|
|
3206
3697
|
description?: string;
|
|
3207
3698
|
/**
|
|
3699
|
+
* @public
|
|
3208
3700
|
* <p>A list of configuration properties of an SdkType.</p>
|
|
3209
3701
|
*/
|
|
3210
3702
|
configurationProperties?: SdkConfigurationProperty[];
|
|
@@ -3215,10 +3707,12 @@ export interface SdkType {
|
|
|
3215
3707
|
*/
|
|
3216
3708
|
export interface GetSdkTypesRequest {
|
|
3217
3709
|
/**
|
|
3710
|
+
* @public
|
|
3218
3711
|
* <p>The current pagination position in the paged result set.</p>
|
|
3219
3712
|
*/
|
|
3220
3713
|
position?: string;
|
|
3221
3714
|
/**
|
|
3715
|
+
* @public
|
|
3222
3716
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3223
3717
|
*/
|
|
3224
3718
|
limit?: number;
|
|
@@ -3229,6 +3723,7 @@ export interface GetSdkTypesRequest {
|
|
|
3229
3723
|
*/
|
|
3230
3724
|
export interface SdkTypes {
|
|
3231
3725
|
/**
|
|
3726
|
+
* @public
|
|
3232
3727
|
* <p>The current page of elements from this collection.</p>
|
|
3233
3728
|
*/
|
|
3234
3729
|
items?: SdkType[];
|
|
@@ -3239,10 +3734,12 @@ export interface SdkTypes {
|
|
|
3239
3734
|
*/
|
|
3240
3735
|
export interface GetStageRequest {
|
|
3241
3736
|
/**
|
|
3737
|
+
* @public
|
|
3242
3738
|
* <p>The string identifier of the associated RestApi.</p>
|
|
3243
3739
|
*/
|
|
3244
3740
|
restApiId: string | undefined;
|
|
3245
3741
|
/**
|
|
3742
|
+
* @public
|
|
3246
3743
|
* <p>The name of the Stage resource to get information about.</p>
|
|
3247
3744
|
*/
|
|
3248
3745
|
stageName: string | undefined;
|
|
@@ -3253,10 +3750,12 @@ export interface GetStageRequest {
|
|
|
3253
3750
|
*/
|
|
3254
3751
|
export interface GetStagesRequest {
|
|
3255
3752
|
/**
|
|
3753
|
+
* @public
|
|
3256
3754
|
* <p>The string identifier of the associated RestApi.</p>
|
|
3257
3755
|
*/
|
|
3258
3756
|
restApiId: string | undefined;
|
|
3259
3757
|
/**
|
|
3758
|
+
* @public
|
|
3260
3759
|
* <p>The stages' deployment identifiers.</p>
|
|
3261
3760
|
*/
|
|
3262
3761
|
deploymentId?: string;
|
|
@@ -3267,6 +3766,7 @@ export interface GetStagesRequest {
|
|
|
3267
3766
|
*/
|
|
3268
3767
|
export interface Stages {
|
|
3269
3768
|
/**
|
|
3769
|
+
* @public
|
|
3270
3770
|
* <p>The current page of elements from this collection.</p>
|
|
3271
3771
|
*/
|
|
3272
3772
|
item?: Stage[];
|
|
@@ -3277,14 +3777,17 @@ export interface Stages {
|
|
|
3277
3777
|
*/
|
|
3278
3778
|
export interface GetTagsRequest {
|
|
3279
3779
|
/**
|
|
3780
|
+
* @public
|
|
3280
3781
|
* <p>The ARN of a resource that can be tagged.</p>
|
|
3281
3782
|
*/
|
|
3282
3783
|
resourceArn: string | undefined;
|
|
3283
3784
|
/**
|
|
3785
|
+
* @public
|
|
3284
3786
|
* <p>(Not currently supported) The current pagination position in the paged result set.</p>
|
|
3285
3787
|
*/
|
|
3286
3788
|
position?: string;
|
|
3287
3789
|
/**
|
|
3790
|
+
* @public
|
|
3288
3791
|
* <p>(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3289
3792
|
*/
|
|
3290
3793
|
limit?: number;
|
|
@@ -3295,6 +3798,7 @@ export interface GetTagsRequest {
|
|
|
3295
3798
|
*/
|
|
3296
3799
|
export interface Tags {
|
|
3297
3800
|
/**
|
|
3801
|
+
* @public
|
|
3298
3802
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
3299
3803
|
*/
|
|
3300
3804
|
tags?: Record<string, string>;
|
|
@@ -3305,26 +3809,32 @@ export interface Tags {
|
|
|
3305
3809
|
*/
|
|
3306
3810
|
export interface GetUsageRequest {
|
|
3307
3811
|
/**
|
|
3812
|
+
* @public
|
|
3308
3813
|
* <p>The Id of the usage plan associated with the usage data.</p>
|
|
3309
3814
|
*/
|
|
3310
3815
|
usagePlanId: string | undefined;
|
|
3311
3816
|
/**
|
|
3817
|
+
* @public
|
|
3312
3818
|
* <p>The Id of the API key associated with the resultant usage data.</p>
|
|
3313
3819
|
*/
|
|
3314
3820
|
keyId?: string;
|
|
3315
3821
|
/**
|
|
3822
|
+
* @public
|
|
3316
3823
|
* <p>The starting date (e.g., 2016-01-01) of the usage data.</p>
|
|
3317
3824
|
*/
|
|
3318
3825
|
startDate: string | undefined;
|
|
3319
3826
|
/**
|
|
3827
|
+
* @public
|
|
3320
3828
|
* <p>The ending date (e.g., 2016-12-31) of the usage data.</p>
|
|
3321
3829
|
*/
|
|
3322
3830
|
endDate: string | undefined;
|
|
3323
3831
|
/**
|
|
3832
|
+
* @public
|
|
3324
3833
|
* <p>The current pagination position in the paged result set.</p>
|
|
3325
3834
|
*/
|
|
3326
3835
|
position?: string;
|
|
3327
3836
|
/**
|
|
3837
|
+
* @public
|
|
3328
3838
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3329
3839
|
*/
|
|
3330
3840
|
limit?: number;
|
|
@@ -3335,22 +3845,27 @@ export interface GetUsageRequest {
|
|
|
3335
3845
|
*/
|
|
3336
3846
|
export interface Usage {
|
|
3337
3847
|
/**
|
|
3848
|
+
* @public
|
|
3338
3849
|
* <p>The plan Id associated with this usage data.</p>
|
|
3339
3850
|
*/
|
|
3340
3851
|
usagePlanId?: string;
|
|
3341
3852
|
/**
|
|
3853
|
+
* @public
|
|
3342
3854
|
* <p>The starting date of the usage data.</p>
|
|
3343
3855
|
*/
|
|
3344
3856
|
startDate?: string;
|
|
3345
3857
|
/**
|
|
3858
|
+
* @public
|
|
3346
3859
|
* <p>The ending date of the usage data.</p>
|
|
3347
3860
|
*/
|
|
3348
3861
|
endDate?: string;
|
|
3349
3862
|
/**
|
|
3863
|
+
* @public
|
|
3350
3864
|
* <p>The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, <code>\{..., "values" : \{ "\{api_key\}" : [ [0, 100], [10, 90], [100, 10]]\}</code>, where <code>\{api_key\}</code> stands for an API key value and the daily log entry is of the format <code>[used quota, remaining quota]</code>.</p>
|
|
3351
3865
|
*/
|
|
3352
3866
|
items?: Record<string, number[][]>;
|
|
3353
3867
|
/**
|
|
3868
|
+
* @public
|
|
3354
3869
|
* <p>The current pagination position in the paged result set.</p>
|
|
3355
3870
|
*/
|
|
3356
3871
|
position?: string;
|
|
@@ -3361,6 +3876,7 @@ export interface Usage {
|
|
|
3361
3876
|
*/
|
|
3362
3877
|
export interface GetUsagePlanRequest {
|
|
3363
3878
|
/**
|
|
3879
|
+
* @public
|
|
3364
3880
|
* <p>The identifier of the UsagePlan resource to be retrieved.</p>
|
|
3365
3881
|
*/
|
|
3366
3882
|
usagePlanId: string | undefined;
|
|
@@ -3371,10 +3887,12 @@ export interface GetUsagePlanRequest {
|
|
|
3371
3887
|
*/
|
|
3372
3888
|
export interface GetUsagePlanKeyRequest {
|
|
3373
3889
|
/**
|
|
3890
|
+
* @public
|
|
3374
3891
|
* <p>The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.</p>
|
|
3375
3892
|
*/
|
|
3376
3893
|
usagePlanId: string | undefined;
|
|
3377
3894
|
/**
|
|
3895
|
+
* @public
|
|
3378
3896
|
* <p>The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.</p>
|
|
3379
3897
|
*/
|
|
3380
3898
|
keyId: string | undefined;
|
|
@@ -3385,18 +3903,22 @@ export interface GetUsagePlanKeyRequest {
|
|
|
3385
3903
|
*/
|
|
3386
3904
|
export interface GetUsagePlanKeysRequest {
|
|
3387
3905
|
/**
|
|
3906
|
+
* @public
|
|
3388
3907
|
* <p>The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.</p>
|
|
3389
3908
|
*/
|
|
3390
3909
|
usagePlanId: string | undefined;
|
|
3391
3910
|
/**
|
|
3911
|
+
* @public
|
|
3392
3912
|
* <p>The current pagination position in the paged result set.</p>
|
|
3393
3913
|
*/
|
|
3394
3914
|
position?: string;
|
|
3395
3915
|
/**
|
|
3916
|
+
* @public
|
|
3396
3917
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3397
3918
|
*/
|
|
3398
3919
|
limit?: number;
|
|
3399
3920
|
/**
|
|
3921
|
+
* @public
|
|
3400
3922
|
* <p>A query parameter specifying the name of the to-be-returned usage plan keys.</p>
|
|
3401
3923
|
*/
|
|
3402
3924
|
nameQuery?: string;
|
|
@@ -3407,10 +3929,12 @@ export interface GetUsagePlanKeysRequest {
|
|
|
3407
3929
|
*/
|
|
3408
3930
|
export interface UsagePlanKeys {
|
|
3409
3931
|
/**
|
|
3932
|
+
* @public
|
|
3410
3933
|
* <p>The current page of elements from this collection.</p>
|
|
3411
3934
|
*/
|
|
3412
3935
|
items?: UsagePlanKey[];
|
|
3413
3936
|
/**
|
|
3937
|
+
* @public
|
|
3414
3938
|
* <p>The current pagination position in the paged result set.</p>
|
|
3415
3939
|
*/
|
|
3416
3940
|
position?: string;
|
|
@@ -3421,14 +3945,17 @@ export interface UsagePlanKeys {
|
|
|
3421
3945
|
*/
|
|
3422
3946
|
export interface GetUsagePlansRequest {
|
|
3423
3947
|
/**
|
|
3948
|
+
* @public
|
|
3424
3949
|
* <p>The current pagination position in the paged result set.</p>
|
|
3425
3950
|
*/
|
|
3426
3951
|
position?: string;
|
|
3427
3952
|
/**
|
|
3953
|
+
* @public
|
|
3428
3954
|
* <p>The identifier of the API key associated with the usage plans.</p>
|
|
3429
3955
|
*/
|
|
3430
3956
|
keyId?: string;
|
|
3431
3957
|
/**
|
|
3958
|
+
* @public
|
|
3432
3959
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3433
3960
|
*/
|
|
3434
3961
|
limit?: number;
|
|
@@ -3439,10 +3966,12 @@ export interface GetUsagePlansRequest {
|
|
|
3439
3966
|
*/
|
|
3440
3967
|
export interface UsagePlans {
|
|
3441
3968
|
/**
|
|
3969
|
+
* @public
|
|
3442
3970
|
* <p>The current page of elements from this collection.</p>
|
|
3443
3971
|
*/
|
|
3444
3972
|
items?: UsagePlan[];
|
|
3445
3973
|
/**
|
|
3974
|
+
* @public
|
|
3446
3975
|
* <p>The current pagination position in the paged result set.</p>
|
|
3447
3976
|
*/
|
|
3448
3977
|
position?: string;
|
|
@@ -3453,6 +3982,7 @@ export interface UsagePlans {
|
|
|
3453
3982
|
*/
|
|
3454
3983
|
export interface GetVpcLinkRequest {
|
|
3455
3984
|
/**
|
|
3985
|
+
* @public
|
|
3456
3986
|
* <p>The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.</p>
|
|
3457
3987
|
*/
|
|
3458
3988
|
vpcLinkId: string | undefined;
|
|
@@ -3463,10 +3993,12 @@ export interface GetVpcLinkRequest {
|
|
|
3463
3993
|
*/
|
|
3464
3994
|
export interface GetVpcLinksRequest {
|
|
3465
3995
|
/**
|
|
3996
|
+
* @public
|
|
3466
3997
|
* <p>The current pagination position in the paged result set.</p>
|
|
3467
3998
|
*/
|
|
3468
3999
|
position?: string;
|
|
3469
4000
|
/**
|
|
4001
|
+
* @public
|
|
3470
4002
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3471
4003
|
*/
|
|
3472
4004
|
limit?: number;
|
|
@@ -3477,10 +4009,12 @@ export interface GetVpcLinksRequest {
|
|
|
3477
4009
|
*/
|
|
3478
4010
|
export interface VpcLinks {
|
|
3479
4011
|
/**
|
|
4012
|
+
* @public
|
|
3480
4013
|
* <p>The current page of elements from this collection.</p>
|
|
3481
4014
|
*/
|
|
3482
4015
|
items?: VpcLink[];
|
|
3483
4016
|
/**
|
|
4017
|
+
* @public
|
|
3484
4018
|
* <p>The current pagination position in the paged result set.</p>
|
|
3485
4019
|
*/
|
|
3486
4020
|
position?: string;
|
|
@@ -3491,14 +4025,17 @@ export interface VpcLinks {
|
|
|
3491
4025
|
*/
|
|
3492
4026
|
export interface ImportApiKeysRequest {
|
|
3493
4027
|
/**
|
|
4028
|
+
* @public
|
|
3494
4029
|
* <p>The payload of the POST request to import API keys. For the payload format, see API Key File Format.</p>
|
|
3495
4030
|
*/
|
|
3496
4031
|
body: Uint8Array | undefined;
|
|
3497
4032
|
/**
|
|
4033
|
+
* @public
|
|
3498
4034
|
* <p>A query parameter to specify the input format to imported API keys. Currently, only the <code>csv</code> format is supported.</p>
|
|
3499
4035
|
*/
|
|
3500
4036
|
format: ApiKeysFormat | string | undefined;
|
|
3501
4037
|
/**
|
|
4038
|
+
* @public
|
|
3502
4039
|
* <p>A query parameter to indicate whether to rollback ApiKey importation (<code>true</code>) or not (<code>false</code>) when error is encountered.</p>
|
|
3503
4040
|
*/
|
|
3504
4041
|
failOnWarnings?: boolean;
|
|
@@ -3509,10 +4046,12 @@ export interface ImportApiKeysRequest {
|
|
|
3509
4046
|
*/
|
|
3510
4047
|
export interface DocumentationPartIds {
|
|
3511
4048
|
/**
|
|
4049
|
+
* @public
|
|
3512
4050
|
* <p>A list of the returned documentation part identifiers.</p>
|
|
3513
4051
|
*/
|
|
3514
4052
|
ids?: string[];
|
|
3515
4053
|
/**
|
|
4054
|
+
* @public
|
|
3516
4055
|
* <p>A list of warning messages reported during import of documentation parts.</p>
|
|
3517
4056
|
*/
|
|
3518
4057
|
warnings?: string[];
|
|
@@ -3535,18 +4074,22 @@ export type PutMode = (typeof PutMode)[keyof typeof PutMode];
|
|
|
3535
4074
|
*/
|
|
3536
4075
|
export interface ImportDocumentationPartsRequest {
|
|
3537
4076
|
/**
|
|
4077
|
+
* @public
|
|
3538
4078
|
* <p>The string identifier of the associated RestApi.</p>
|
|
3539
4079
|
*/
|
|
3540
4080
|
restApiId: string | undefined;
|
|
3541
4081
|
/**
|
|
4082
|
+
* @public
|
|
3542
4083
|
* <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>
|
|
3543
4084
|
*/
|
|
3544
4085
|
mode?: PutMode | string;
|
|
3545
4086
|
/**
|
|
4087
|
+
* @public
|
|
3546
4088
|
* <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>
|
|
3547
4089
|
*/
|
|
3548
4090
|
failOnWarnings?: boolean;
|
|
3549
4091
|
/**
|
|
4092
|
+
* @public
|
|
3550
4093
|
* <p>Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.</p>
|
|
3551
4094
|
*/
|
|
3552
4095
|
body: Uint8Array | undefined;
|
|
@@ -3557,11 +4100,13 @@ export interface ImportDocumentationPartsRequest {
|
|
|
3557
4100
|
*/
|
|
3558
4101
|
export interface ImportRestApiRequest {
|
|
3559
4102
|
/**
|
|
4103
|
+
* @public
|
|
3560
4104
|
* <p>A query parameter to indicate whether to rollback the API creation (<code>true</code>) or not (<code>false</code>)
|
|
3561
4105
|
* when a warning is encountered. The default value is <code>false</code>.</p>
|
|
3562
4106
|
*/
|
|
3563
4107
|
failOnWarnings?: boolean;
|
|
3564
4108
|
/**
|
|
4109
|
+
* @public
|
|
3565
4110
|
* <p>A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.</p>
|
|
3566
4111
|
* <p> To exclude DocumentationParts from the import, set <code>parameters</code> as <code>ignore=documentation</code>.</p>
|
|
3567
4112
|
* <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>
|
|
@@ -3571,6 +4116,7 @@ export interface ImportRestApiRequest {
|
|
|
3571
4116
|
*/
|
|
3572
4117
|
parameters?: Record<string, string>;
|
|
3573
4118
|
/**
|
|
4119
|
+
* @public
|
|
3574
4120
|
* <p>The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.</p>
|
|
3575
4121
|
*/
|
|
3576
4122
|
body: Uint8Array | undefined;
|
|
@@ -3581,22 +4127,27 @@ export interface ImportRestApiRequest {
|
|
|
3581
4127
|
*/
|
|
3582
4128
|
export interface PutGatewayResponseRequest {
|
|
3583
4129
|
/**
|
|
4130
|
+
* @public
|
|
3584
4131
|
* <p>The string identifier of the associated RestApi.</p>
|
|
3585
4132
|
*/
|
|
3586
4133
|
restApiId: string | undefined;
|
|
3587
4134
|
/**
|
|
4135
|
+
* @public
|
|
3588
4136
|
* <p>The response type of the associated GatewayResponse</p>
|
|
3589
4137
|
*/
|
|
3590
4138
|
responseType: GatewayResponseType | string | undefined;
|
|
3591
4139
|
/**
|
|
4140
|
+
* @public
|
|
3592
4141
|
* <p>The HTTP status code of the GatewayResponse.</p>
|
|
3593
4142
|
*/
|
|
3594
4143
|
statusCode?: string;
|
|
3595
4144
|
/**
|
|
4145
|
+
* @public
|
|
3596
4146
|
* <p>Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.</p>
|
|
3597
4147
|
*/
|
|
3598
4148
|
responseParameters?: Record<string, string>;
|
|
3599
4149
|
/**
|
|
4150
|
+
* @public
|
|
3600
4151
|
* <p>Response templates of the GatewayResponse as a string-to-string map of key-value pairs.</p>
|
|
3601
4152
|
*/
|
|
3602
4153
|
responseTemplates?: Record<string, string>;
|
|
@@ -3607,26 +4158,32 @@ export interface PutGatewayResponseRequest {
|
|
|
3607
4158
|
*/
|
|
3608
4159
|
export interface PutIntegrationRequest {
|
|
3609
4160
|
/**
|
|
4161
|
+
* @public
|
|
3610
4162
|
* <p>The string identifier of the associated RestApi.</p>
|
|
3611
4163
|
*/
|
|
3612
4164
|
restApiId: string | undefined;
|
|
3613
4165
|
/**
|
|
4166
|
+
* @public
|
|
3614
4167
|
* <p>Specifies a put integration request's resource ID.</p>
|
|
3615
4168
|
*/
|
|
3616
4169
|
resourceId: string | undefined;
|
|
3617
4170
|
/**
|
|
4171
|
+
* @public
|
|
3618
4172
|
* <p>Specifies the HTTP method for the integration.</p>
|
|
3619
4173
|
*/
|
|
3620
4174
|
httpMethod: string | undefined;
|
|
3621
4175
|
/**
|
|
4176
|
+
* @public
|
|
3622
4177
|
* <p>Specifies a put integration input's type.</p>
|
|
3623
4178
|
*/
|
|
3624
4179
|
type: IntegrationType | string | undefined;
|
|
3625
4180
|
/**
|
|
4181
|
+
* @public
|
|
3626
4182
|
* <p>The HTTP method for the integration.</p>
|
|
3627
4183
|
*/
|
|
3628
4184
|
integrationHttpMethod?: string;
|
|
3629
4185
|
/**
|
|
4186
|
+
* @public
|
|
3630
4187
|
* <p>Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or
|
|
3631
4188
|
* <code>HTTP_PROXY</code> integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the
|
|
3632
4189
|
* RFC-3986 specification, for either standard integration, where <code>connectionType</code> is not <code>VPC_LINK</code>,
|
|
@@ -3646,48 +4203,59 @@ export interface PutIntegrationRequest {
|
|
|
3646
4203
|
*/
|
|
3647
4204
|
uri?: string;
|
|
3648
4205
|
/**
|
|
4206
|
+
* @public
|
|
3649
4207
|
* <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>
|
|
3650
4208
|
*/
|
|
3651
4209
|
connectionType?: ConnectionType | string;
|
|
3652
4210
|
/**
|
|
4211
|
+
* @public
|
|
3653
4212
|
* <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>
|
|
3654
4213
|
*/
|
|
3655
4214
|
connectionId?: string;
|
|
3656
4215
|
/**
|
|
4216
|
+
* @public
|
|
3657
4217
|
* <p>Specifies whether credentials are required for a put integration.</p>
|
|
3658
4218
|
*/
|
|
3659
4219
|
credentials?: string;
|
|
3660
4220
|
/**
|
|
4221
|
+
* @public
|
|
3661
4222
|
* <p>A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of <code>method.request.\{location\}.\{name\}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> must be a valid and unique method request parameter name.</p>
|
|
3662
4223
|
*/
|
|
3663
4224
|
requestParameters?: Record<string, string>;
|
|
3664
4225
|
/**
|
|
4226
|
+
* @public
|
|
3665
4227
|
* <p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.</p>
|
|
3666
4228
|
*/
|
|
3667
4229
|
requestTemplates?: Record<string, string>;
|
|
3668
4230
|
/**
|
|
4231
|
+
* @public
|
|
3669
4232
|
* <p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the <code>requestTemplates</code> property on the Integration resource. There are three valid values: <code>WHEN_NO_MATCH</code>, <code>WHEN_NO_TEMPLATES</code>, and <code>NEVER</code>.
|
|
3670
4233
|
* </p>
|
|
3671
4234
|
*/
|
|
3672
4235
|
passthroughBehavior?: string;
|
|
3673
4236
|
/**
|
|
4237
|
+
* @public
|
|
3674
4238
|
* <p>Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the <code>cacheNamespace</code>. You can specify the same <code>cacheNamespace</code> across resources to return the same cached data for requests to different resources.</p>
|
|
3675
4239
|
*/
|
|
3676
4240
|
cacheNamespace?: string;
|
|
3677
4241
|
/**
|
|
4242
|
+
* @public
|
|
3678
4243
|
* <p>A list of request parameters whose values API Gateway caches. To be valid values for <code>cacheKeyParameters</code>, these parameters must also be specified for Method <code>requestParameters</code>.</p>
|
|
3679
4244
|
*/
|
|
3680
4245
|
cacheKeyParameters?: string[];
|
|
3681
4246
|
/**
|
|
4247
|
+
* @public
|
|
3682
4248
|
* <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>
|
|
3683
4249
|
* <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>
|
|
3684
4250
|
*/
|
|
3685
4251
|
contentHandling?: ContentHandlingStrategy | string;
|
|
3686
4252
|
/**
|
|
4253
|
+
* @public
|
|
3687
4254
|
* <p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.</p>
|
|
3688
4255
|
*/
|
|
3689
4256
|
timeoutInMillis?: number;
|
|
3690
4257
|
/**
|
|
4258
|
+
* @public
|
|
3691
4259
|
* <p>Specifies the TLS configuration for an integration.</p>
|
|
3692
4260
|
*/
|
|
3693
4261
|
tlsConfig?: TlsConfig;
|
|
@@ -3698,35 +4266,43 @@ export interface PutIntegrationRequest {
|
|
|
3698
4266
|
*/
|
|
3699
4267
|
export interface PutIntegrationResponseRequest {
|
|
3700
4268
|
/**
|
|
4269
|
+
* @public
|
|
3701
4270
|
* <p>The string identifier of the associated RestApi.</p>
|
|
3702
4271
|
*/
|
|
3703
4272
|
restApiId: string | undefined;
|
|
3704
4273
|
/**
|
|
4274
|
+
* @public
|
|
3705
4275
|
* <p>Specifies a put integration response request's resource identifier.</p>
|
|
3706
4276
|
*/
|
|
3707
4277
|
resourceId: string | undefined;
|
|
3708
4278
|
/**
|
|
4279
|
+
* @public
|
|
3709
4280
|
* <p>Specifies a put integration response request's HTTP method.</p>
|
|
3710
4281
|
*/
|
|
3711
4282
|
httpMethod: string | undefined;
|
|
3712
4283
|
/**
|
|
4284
|
+
* @public
|
|
3713
4285
|
* <p>Specifies the status code that is used to map the integration response to an existing MethodResponse.</p>
|
|
3714
4286
|
*/
|
|
3715
4287
|
statusCode: string | undefined;
|
|
3716
4288
|
/**
|
|
4289
|
+
* @public
|
|
3717
4290
|
* <p>Specifies the selection pattern of a put integration response.</p>
|
|
3718
4291
|
*/
|
|
3719
4292
|
selectionPattern?: string;
|
|
3720
4293
|
/**
|
|
4294
|
+
* @public
|
|
3721
4295
|
* <p>A key-value map specifying response parameters that are passed to the method response from the back end.
|
|
3722
4296
|
* The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of <code>method.response.header.\{name\}</code>, where <code>name</code> is a valid and unique header name. The mapped non-static value must match the pattern of <code>integration.response.header.\{name\}</code> or <code>integration.response.body.\{JSON-expression\}</code>, where <code>name</code> must be a valid and unique response header name and <code>JSON-expression</code> a valid JSON expression without the <code>$</code> prefix.</p>
|
|
3723
4297
|
*/
|
|
3724
4298
|
responseParameters?: Record<string, string>;
|
|
3725
4299
|
/**
|
|
4300
|
+
* @public
|
|
3726
4301
|
* <p>Specifies a put integration response's templates.</p>
|
|
3727
4302
|
*/
|
|
3728
4303
|
responseTemplates?: Record<string, string>;
|
|
3729
4304
|
/**
|
|
4305
|
+
* @public
|
|
3730
4306
|
* <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>
|
|
3731
4307
|
* <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>
|
|
3732
4308
|
*/
|
|
@@ -3738,46 +4314,57 @@ export interface PutIntegrationResponseRequest {
|
|
|
3738
4314
|
*/
|
|
3739
4315
|
export interface PutMethodRequest {
|
|
3740
4316
|
/**
|
|
4317
|
+
* @public
|
|
3741
4318
|
* <p>The string identifier of the associated RestApi.</p>
|
|
3742
4319
|
*/
|
|
3743
4320
|
restApiId: string | undefined;
|
|
3744
4321
|
/**
|
|
4322
|
+
* @public
|
|
3745
4323
|
* <p>The Resource identifier for the new Method resource.</p>
|
|
3746
4324
|
*/
|
|
3747
4325
|
resourceId: string | undefined;
|
|
3748
4326
|
/**
|
|
4327
|
+
* @public
|
|
3749
4328
|
* <p>Specifies the method request's HTTP method type.</p>
|
|
3750
4329
|
*/
|
|
3751
4330
|
httpMethod: string | undefined;
|
|
3752
4331
|
/**
|
|
4332
|
+
* @public
|
|
3753
4333
|
* <p>The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool.</p>
|
|
3754
4334
|
*/
|
|
3755
4335
|
authorizationType: string | undefined;
|
|
3756
4336
|
/**
|
|
4337
|
+
* @public
|
|
3757
4338
|
* <p>Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>
|
|
3758
4339
|
*/
|
|
3759
4340
|
authorizerId?: string;
|
|
3760
4341
|
/**
|
|
4342
|
+
* @public
|
|
3761
4343
|
* <p>Specifies whether the method required a valid ApiKey.</p>
|
|
3762
4344
|
*/
|
|
3763
4345
|
apiKeyRequired?: boolean;
|
|
3764
4346
|
/**
|
|
4347
|
+
* @public
|
|
3765
4348
|
* <p>A human-friendly operation identifier for the method. For example, you can assign the <code>operationName</code> of <code>ListPets</code> for the <code>GET /pets</code> method in the <code>PetStore</code> example.</p>
|
|
3766
4349
|
*/
|
|
3767
4350
|
operationName?: string;
|
|
3768
4351
|
/**
|
|
4352
|
+
* @public
|
|
3769
4353
|
* <p>A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of <code>method.request.\{location\}.\{name\}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (<code>true</code>) or optional (<code>false</code>). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.</p>
|
|
3770
4354
|
*/
|
|
3771
4355
|
requestParameters?: Record<string, boolean>;
|
|
3772
4356
|
/**
|
|
4357
|
+
* @public
|
|
3773
4358
|
* <p>Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.</p>
|
|
3774
4359
|
*/
|
|
3775
4360
|
requestModels?: Record<string, string>;
|
|
3776
4361
|
/**
|
|
4362
|
+
* @public
|
|
3777
4363
|
* <p>The identifier of a RequestValidator for validating the method request.</p>
|
|
3778
4364
|
*/
|
|
3779
4365
|
requestValidatorId?: string;
|
|
3780
4366
|
/**
|
|
4367
|
+
* @public
|
|
3781
4368
|
* <p>A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOLS</code> authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>
|
|
3782
4369
|
*/
|
|
3783
4370
|
authorizationScopes?: string[];
|
|
@@ -3788,26 +4375,32 @@ export interface PutMethodRequest {
|
|
|
3788
4375
|
*/
|
|
3789
4376
|
export interface PutMethodResponseRequest {
|
|
3790
4377
|
/**
|
|
4378
|
+
* @public
|
|
3791
4379
|
* <p>The string identifier of the associated RestApi.</p>
|
|
3792
4380
|
*/
|
|
3793
4381
|
restApiId: string | undefined;
|
|
3794
4382
|
/**
|
|
4383
|
+
* @public
|
|
3795
4384
|
* <p>The Resource identifier for the Method resource.</p>
|
|
3796
4385
|
*/
|
|
3797
4386
|
resourceId: string | undefined;
|
|
3798
4387
|
/**
|
|
4388
|
+
* @public
|
|
3799
4389
|
* <p>The HTTP verb of the Method resource.</p>
|
|
3800
4390
|
*/
|
|
3801
4391
|
httpMethod: string | undefined;
|
|
3802
4392
|
/**
|
|
4393
|
+
* @public
|
|
3803
4394
|
* <p>The method response's status code.</p>
|
|
3804
4395
|
*/
|
|
3805
4396
|
statusCode: string | undefined;
|
|
3806
4397
|
/**
|
|
4398
|
+
* @public
|
|
3807
4399
|
* <p>A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of <code>method.response.header.\{name\}</code>, where <code>name</code> is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in <code>integration.response.header.\{name\}</code>, a static value enclosed within a pair of single quotes (e.g., <code>'application/json'</code>), or a JSON expression from the back-end response payload in the form of <code>integration.response.body.\{JSON-expression\}</code>, where <code>JSON-expression</code> is a valid JSON expression without the <code>$</code> prefix.)</p>
|
|
3808
4400
|
*/
|
|
3809
4401
|
responseParameters?: Record<string, boolean>;
|
|
3810
4402
|
/**
|
|
4403
|
+
* @public
|
|
3811
4404
|
* <p>Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.</p>
|
|
3812
4405
|
*/
|
|
3813
4406
|
responseModels?: Record<string, string>;
|
|
@@ -3818,24 +4411,29 @@ export interface PutMethodResponseRequest {
|
|
|
3818
4411
|
*/
|
|
3819
4412
|
export interface PutRestApiRequest {
|
|
3820
4413
|
/**
|
|
4414
|
+
* @public
|
|
3821
4415
|
* <p>The string identifier of the associated RestApi.</p>
|
|
3822
4416
|
*/
|
|
3823
4417
|
restApiId: string | undefined;
|
|
3824
4418
|
/**
|
|
4419
|
+
* @public
|
|
3825
4420
|
* <p>The <code>mode</code> query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default,
|
|
3826
4421
|
* the update mode is "merge".</p>
|
|
3827
4422
|
*/
|
|
3828
4423
|
mode?: PutMode | string;
|
|
3829
4424
|
/**
|
|
4425
|
+
* @public
|
|
3830
4426
|
* <p>A query parameter to indicate whether to rollback the API update (<code>true</code>) or not (<code>false</code>)
|
|
3831
4427
|
* when a warning is encountered. The default value is <code>false</code>.</p>
|
|
3832
4428
|
*/
|
|
3833
4429
|
failOnWarnings?: boolean;
|
|
3834
4430
|
/**
|
|
4431
|
+
* @public
|
|
3835
4432
|
* <p>Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set <code>ignore=documentation</code> as a <code>parameters</code> value, as in the AWS CLI command of <code>aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'</code>.</p>
|
|
3836
4433
|
*/
|
|
3837
4434
|
parameters?: Record<string, string>;
|
|
3838
4435
|
/**
|
|
4436
|
+
* @public
|
|
3839
4437
|
* <p>The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.</p>
|
|
3840
4438
|
*/
|
|
3841
4439
|
body: Uint8Array | undefined;
|
|
@@ -3846,10 +4444,12 @@ export interface PutRestApiRequest {
|
|
|
3846
4444
|
*/
|
|
3847
4445
|
export interface TagResourceRequest {
|
|
3848
4446
|
/**
|
|
4447
|
+
* @public
|
|
3849
4448
|
* <p>The ARN of a resource that can be tagged.</p>
|
|
3850
4449
|
*/
|
|
3851
4450
|
resourceArn: string | undefined;
|
|
3852
4451
|
/**
|
|
4452
|
+
* @public
|
|
3853
4453
|
* <p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</p>
|
|
3854
4454
|
*/
|
|
3855
4455
|
tags: Record<string, string> | undefined;
|
|
@@ -3860,34 +4460,42 @@ export interface TagResourceRequest {
|
|
|
3860
4460
|
*/
|
|
3861
4461
|
export interface TestInvokeAuthorizerRequest {
|
|
3862
4462
|
/**
|
|
4463
|
+
* @public
|
|
3863
4464
|
* <p>The string identifier of the associated RestApi.</p>
|
|
3864
4465
|
*/
|
|
3865
4466
|
restApiId: string | undefined;
|
|
3866
4467
|
/**
|
|
4468
|
+
* @public
|
|
3867
4469
|
* <p>Specifies a test invoke authorizer request's Authorizer ID.</p>
|
|
3868
4470
|
*/
|
|
3869
4471
|
authorizerId: string | undefined;
|
|
3870
4472
|
/**
|
|
4473
|
+
* @public
|
|
3871
4474
|
* <p>A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.</p>
|
|
3872
4475
|
*/
|
|
3873
4476
|
headers?: Record<string, string>;
|
|
3874
4477
|
/**
|
|
4478
|
+
* @public
|
|
3875
4479
|
* <p>The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.</p>
|
|
3876
4480
|
*/
|
|
3877
4481
|
multiValueHeaders?: Record<string, string[]>;
|
|
3878
4482
|
/**
|
|
4483
|
+
* @public
|
|
3879
4484
|
* <p>The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.</p>
|
|
3880
4485
|
*/
|
|
3881
4486
|
pathWithQueryString?: string;
|
|
3882
4487
|
/**
|
|
4488
|
+
* @public
|
|
3883
4489
|
* <p>The simulated request body of an incoming invocation request.</p>
|
|
3884
4490
|
*/
|
|
3885
4491
|
body?: string;
|
|
3886
4492
|
/**
|
|
4493
|
+
* @public
|
|
3887
4494
|
* <p>A key-value map of stage variables to simulate an invocation on a deployed Stage.</p>
|
|
3888
4495
|
*/
|
|
3889
4496
|
stageVariables?: Record<string, string>;
|
|
3890
4497
|
/**
|
|
4498
|
+
* @public
|
|
3891
4499
|
* <p>A key-value map of additional context variables.</p>
|
|
3892
4500
|
*/
|
|
3893
4501
|
additionalContext?: Record<string, string>;
|
|
@@ -3898,30 +4506,37 @@ export interface TestInvokeAuthorizerRequest {
|
|
|
3898
4506
|
*/
|
|
3899
4507
|
export interface TestInvokeAuthorizerResponse {
|
|
3900
4508
|
/**
|
|
4509
|
+
* @public
|
|
3901
4510
|
* <p>The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.</p>
|
|
3902
4511
|
*/
|
|
3903
4512
|
clientStatus?: number;
|
|
3904
4513
|
/**
|
|
4514
|
+
* @public
|
|
3905
4515
|
* <p>The API Gateway execution log for the test authorizer request.</p>
|
|
3906
4516
|
*/
|
|
3907
4517
|
log?: string;
|
|
3908
4518
|
/**
|
|
4519
|
+
* @public
|
|
3909
4520
|
* <p>The execution latency of the test authorizer request.</p>
|
|
3910
4521
|
*/
|
|
3911
4522
|
latency?: number;
|
|
3912
4523
|
/**
|
|
4524
|
+
* @public
|
|
3913
4525
|
* <p>The principal identity returned by the Authorizer</p>
|
|
3914
4526
|
*/
|
|
3915
4527
|
principalId?: string;
|
|
3916
4528
|
/**
|
|
4529
|
+
* @public
|
|
3917
4530
|
* <p>The JSON policy document returned by the Authorizer</p>
|
|
3918
4531
|
*/
|
|
3919
4532
|
policy?: string;
|
|
3920
4533
|
/**
|
|
4534
|
+
* @public
|
|
3921
4535
|
* <p>The authorization response.</p>
|
|
3922
4536
|
*/
|
|
3923
4537
|
authorization?: Record<string, string[]>;
|
|
3924
4538
|
/**
|
|
4539
|
+
* @public
|
|
3925
4540
|
* <p>The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.</p>
|
|
3926
4541
|
*/
|
|
3927
4542
|
claims?: Record<string, string>;
|
|
@@ -3932,38 +4547,47 @@ export interface TestInvokeAuthorizerResponse {
|
|
|
3932
4547
|
*/
|
|
3933
4548
|
export interface TestInvokeMethodRequest {
|
|
3934
4549
|
/**
|
|
4550
|
+
* @public
|
|
3935
4551
|
* <p>The string identifier of the associated RestApi.</p>
|
|
3936
4552
|
*/
|
|
3937
4553
|
restApiId: string | undefined;
|
|
3938
4554
|
/**
|
|
4555
|
+
* @public
|
|
3939
4556
|
* <p>Specifies a test invoke method request's resource ID.</p>
|
|
3940
4557
|
*/
|
|
3941
4558
|
resourceId: string | undefined;
|
|
3942
4559
|
/**
|
|
4560
|
+
* @public
|
|
3943
4561
|
* <p>Specifies a test invoke method request's HTTP method.</p>
|
|
3944
4562
|
*/
|
|
3945
4563
|
httpMethod: string | undefined;
|
|
3946
4564
|
/**
|
|
4565
|
+
* @public
|
|
3947
4566
|
* <p>The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.</p>
|
|
3948
4567
|
*/
|
|
3949
4568
|
pathWithQueryString?: string;
|
|
3950
4569
|
/**
|
|
4570
|
+
* @public
|
|
3951
4571
|
* <p>The simulated request body of an incoming invocation request.</p>
|
|
3952
4572
|
*/
|
|
3953
4573
|
body?: string;
|
|
3954
4574
|
/**
|
|
4575
|
+
* @public
|
|
3955
4576
|
* <p>A key-value map of headers to simulate an incoming invocation request.</p>
|
|
3956
4577
|
*/
|
|
3957
4578
|
headers?: Record<string, string>;
|
|
3958
4579
|
/**
|
|
4580
|
+
* @public
|
|
3959
4581
|
* <p>The headers as a map from string to list of values to simulate an incoming invocation request.</p>
|
|
3960
4582
|
*/
|
|
3961
4583
|
multiValueHeaders?: Record<string, string[]>;
|
|
3962
4584
|
/**
|
|
4585
|
+
* @public
|
|
3963
4586
|
* <p>A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.</p>
|
|
3964
4587
|
*/
|
|
3965
4588
|
clientCertificateId?: string;
|
|
3966
4589
|
/**
|
|
4590
|
+
* @public
|
|
3967
4591
|
* <p>A key-value map of stage variables to simulate an invocation on a deployed Stage.</p>
|
|
3968
4592
|
*/
|
|
3969
4593
|
stageVariables?: Record<string, string>;
|
|
@@ -3974,26 +4598,32 @@ export interface TestInvokeMethodRequest {
|
|
|
3974
4598
|
*/
|
|
3975
4599
|
export interface TestInvokeMethodResponse {
|
|
3976
4600
|
/**
|
|
4601
|
+
* @public
|
|
3977
4602
|
* <p>The HTTP status code.</p>
|
|
3978
4603
|
*/
|
|
3979
4604
|
status?: number;
|
|
3980
4605
|
/**
|
|
4606
|
+
* @public
|
|
3981
4607
|
* <p>The body of the HTTP response.</p>
|
|
3982
4608
|
*/
|
|
3983
4609
|
body?: string;
|
|
3984
4610
|
/**
|
|
4611
|
+
* @public
|
|
3985
4612
|
* <p>The headers of the HTTP response.</p>
|
|
3986
4613
|
*/
|
|
3987
4614
|
headers?: Record<string, string>;
|
|
3988
4615
|
/**
|
|
4616
|
+
* @public
|
|
3989
4617
|
* <p>The headers of the HTTP response as a map from string to list of values.</p>
|
|
3990
4618
|
*/
|
|
3991
4619
|
multiValueHeaders?: Record<string, string[]>;
|
|
3992
4620
|
/**
|
|
4621
|
+
* @public
|
|
3993
4622
|
* <p>The API Gateway execution log for the test invoke request.</p>
|
|
3994
4623
|
*/
|
|
3995
4624
|
log?: string;
|
|
3996
4625
|
/**
|
|
4626
|
+
* @public
|
|
3997
4627
|
* <p>The execution latency of the test invoke request.</p>
|
|
3998
4628
|
*/
|
|
3999
4629
|
latency?: number;
|
|
@@ -4004,10 +4634,12 @@ export interface TestInvokeMethodResponse {
|
|
|
4004
4634
|
*/
|
|
4005
4635
|
export interface UntagResourceRequest {
|
|
4006
4636
|
/**
|
|
4637
|
+
* @public
|
|
4007
4638
|
* <p>The ARN of a resource that can be tagged.</p>
|
|
4008
4639
|
*/
|
|
4009
4640
|
resourceArn: string | undefined;
|
|
4010
4641
|
/**
|
|
4642
|
+
* @public
|
|
4011
4643
|
* <p>The Tag keys to delete.</p>
|
|
4012
4644
|
*/
|
|
4013
4645
|
tagKeys: string[] | undefined;
|
|
@@ -4034,6 +4666,7 @@ export type Op = (typeof Op)[keyof typeof Op];
|
|
|
4034
4666
|
*/
|
|
4035
4667
|
export interface PatchOperation {
|
|
4036
4668
|
/**
|
|
4669
|
+
* @public
|
|
4037
4670
|
* <p>An update operation to be performed with this PATCH request. The valid value can be
|
|
4038
4671
|
* add, remove, replace or copy. Not all valid operations are supported for a given
|
|
4039
4672
|
* resource. Support of the operations depends on specific operational contexts. Attempts
|
|
@@ -4041,6 +4674,7 @@ export interface PatchOperation {
|
|
|
4041
4674
|
*/
|
|
4042
4675
|
op?: Op | string;
|
|
4043
4676
|
/**
|
|
4677
|
+
* @public
|
|
4044
4678
|
* <p>The op operation's target, as identified by a JSON Pointer value that references a
|
|
4045
4679
|
* location within the targeted resource. For example, if the target resource has an
|
|
4046
4680
|
* updateable property of \{"name":"value"\}, the path for this property is /name. If the
|
|
@@ -4051,12 +4685,14 @@ export interface PatchOperation {
|
|
|
4051
4685
|
*/
|
|
4052
4686
|
path?: string;
|
|
4053
4687
|
/**
|
|
4688
|
+
* @public
|
|
4054
4689
|
* <p>The new target value of the update operation. It is applicable for the add or replace
|
|
4055
4690
|
* operation. When using AWS CLI to update a property of a JSON value, enclose the JSON
|
|
4056
4691
|
* object with a pair of single quotes in a Linux shell, e.g., '\{"a": ...\}'.</p>
|
|
4057
4692
|
*/
|
|
4058
4693
|
value?: string;
|
|
4059
4694
|
/**
|
|
4695
|
+
* @public
|
|
4060
4696
|
* <p>The copy update operation's source as identified by a JSON-Pointer value referencing
|
|
4061
4697
|
* the location within the targeted resource to copy the value from. For example, to
|
|
4062
4698
|
* promote a canary deployment, you copy the canary deployment ID to the affiliated
|
|
@@ -4071,6 +4707,7 @@ export interface PatchOperation {
|
|
|
4071
4707
|
*/
|
|
4072
4708
|
export interface UpdateAccountRequest {
|
|
4073
4709
|
/**
|
|
4710
|
+
* @public
|
|
4074
4711
|
* <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>
|
|
4075
4712
|
*/
|
|
4076
4713
|
patchOperations?: PatchOperation[];
|
|
@@ -4081,10 +4718,12 @@ export interface UpdateAccountRequest {
|
|
|
4081
4718
|
*/
|
|
4082
4719
|
export interface UpdateApiKeyRequest {
|
|
4083
4720
|
/**
|
|
4721
|
+
* @public
|
|
4084
4722
|
* <p>The identifier of the ApiKey resource to be updated.</p>
|
|
4085
4723
|
*/
|
|
4086
4724
|
apiKey: string | undefined;
|
|
4087
4725
|
/**
|
|
4726
|
+
* @public
|
|
4088
4727
|
* <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>
|
|
4089
4728
|
*/
|
|
4090
4729
|
patchOperations?: PatchOperation[];
|
|
@@ -4095,14 +4734,17 @@ export interface UpdateApiKeyRequest {
|
|
|
4095
4734
|
*/
|
|
4096
4735
|
export interface UpdateAuthorizerRequest {
|
|
4097
4736
|
/**
|
|
4737
|
+
* @public
|
|
4098
4738
|
* <p>The string identifier of the associated RestApi.</p>
|
|
4099
4739
|
*/
|
|
4100
4740
|
restApiId: string | undefined;
|
|
4101
4741
|
/**
|
|
4742
|
+
* @public
|
|
4102
4743
|
* <p>The identifier of the Authorizer resource.</p>
|
|
4103
4744
|
*/
|
|
4104
4745
|
authorizerId: string | undefined;
|
|
4105
4746
|
/**
|
|
4747
|
+
* @public
|
|
4106
4748
|
* <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>
|
|
4107
4749
|
*/
|
|
4108
4750
|
patchOperations?: PatchOperation[];
|
|
@@ -4113,15 +4755,18 @@ export interface UpdateAuthorizerRequest {
|
|
|
4113
4755
|
*/
|
|
4114
4756
|
export interface UpdateBasePathMappingRequest {
|
|
4115
4757
|
/**
|
|
4758
|
+
* @public
|
|
4116
4759
|
* <p>The domain name of the BasePathMapping resource to change.</p>
|
|
4117
4760
|
*/
|
|
4118
4761
|
domainName: string | undefined;
|
|
4119
4762
|
/**
|
|
4763
|
+
* @public
|
|
4120
4764
|
* <p>The base path of the BasePathMapping resource to change.</p>
|
|
4121
4765
|
* <p>To specify an empty base path, set this parameter to <code>'(none)'</code>.</p>
|
|
4122
4766
|
*/
|
|
4123
4767
|
basePath: string | undefined;
|
|
4124
4768
|
/**
|
|
4769
|
+
* @public
|
|
4125
4770
|
* <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>
|
|
4126
4771
|
*/
|
|
4127
4772
|
patchOperations?: PatchOperation[];
|
|
@@ -4132,10 +4777,12 @@ export interface UpdateBasePathMappingRequest {
|
|
|
4132
4777
|
*/
|
|
4133
4778
|
export interface UpdateClientCertificateRequest {
|
|
4134
4779
|
/**
|
|
4780
|
+
* @public
|
|
4135
4781
|
* <p>The identifier of the ClientCertificate resource to be updated.</p>
|
|
4136
4782
|
*/
|
|
4137
4783
|
clientCertificateId: string | undefined;
|
|
4138
4784
|
/**
|
|
4785
|
+
* @public
|
|
4139
4786
|
* <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>
|
|
4140
4787
|
*/
|
|
4141
4788
|
patchOperations?: PatchOperation[];
|
|
@@ -4146,14 +4793,17 @@ export interface UpdateClientCertificateRequest {
|
|
|
4146
4793
|
*/
|
|
4147
4794
|
export interface UpdateDeploymentRequest {
|
|
4148
4795
|
/**
|
|
4796
|
+
* @public
|
|
4149
4797
|
* <p>The string identifier of the associated RestApi.</p>
|
|
4150
4798
|
*/
|
|
4151
4799
|
restApiId: string | undefined;
|
|
4152
4800
|
/**
|
|
4801
|
+
* @public
|
|
4153
4802
|
* <p>The replacement identifier for the Deployment resource to change information about.</p>
|
|
4154
4803
|
*/
|
|
4155
4804
|
deploymentId: string | undefined;
|
|
4156
4805
|
/**
|
|
4806
|
+
* @public
|
|
4157
4807
|
* <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>
|
|
4158
4808
|
*/
|
|
4159
4809
|
patchOperations?: PatchOperation[];
|
|
@@ -4164,14 +4814,17 @@ export interface UpdateDeploymentRequest {
|
|
|
4164
4814
|
*/
|
|
4165
4815
|
export interface UpdateDocumentationPartRequest {
|
|
4166
4816
|
/**
|
|
4817
|
+
* @public
|
|
4167
4818
|
* <p>The string identifier of the associated RestApi.</p>
|
|
4168
4819
|
*/
|
|
4169
4820
|
restApiId: string | undefined;
|
|
4170
4821
|
/**
|
|
4822
|
+
* @public
|
|
4171
4823
|
* <p>The identifier of the to-be-updated documentation part.</p>
|
|
4172
4824
|
*/
|
|
4173
4825
|
documentationPartId: string | undefined;
|
|
4174
4826
|
/**
|
|
4827
|
+
* @public
|
|
4175
4828
|
* <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>
|
|
4176
4829
|
*/
|
|
4177
4830
|
patchOperations?: PatchOperation[];
|
|
@@ -4182,14 +4835,17 @@ export interface UpdateDocumentationPartRequest {
|
|
|
4182
4835
|
*/
|
|
4183
4836
|
export interface UpdateDocumentationVersionRequest {
|
|
4184
4837
|
/**
|
|
4838
|
+
* @public
|
|
4185
4839
|
* <p>The string identifier of the associated RestApi..</p>
|
|
4186
4840
|
*/
|
|
4187
4841
|
restApiId: string | undefined;
|
|
4188
4842
|
/**
|
|
4843
|
+
* @public
|
|
4189
4844
|
* <p>The version identifier of the to-be-updated documentation version.</p>
|
|
4190
4845
|
*/
|
|
4191
4846
|
documentationVersion: string | undefined;
|
|
4192
4847
|
/**
|
|
4848
|
+
* @public
|
|
4193
4849
|
* <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>
|
|
4194
4850
|
*/
|
|
4195
4851
|
patchOperations?: PatchOperation[];
|
|
@@ -4200,10 +4856,12 @@ export interface UpdateDocumentationVersionRequest {
|
|
|
4200
4856
|
*/
|
|
4201
4857
|
export interface UpdateDomainNameRequest {
|
|
4202
4858
|
/**
|
|
4859
|
+
* @public
|
|
4203
4860
|
* <p>The name of the DomainName resource to be changed.</p>
|
|
4204
4861
|
*/
|
|
4205
4862
|
domainName: string | undefined;
|
|
4206
4863
|
/**
|
|
4864
|
+
* @public
|
|
4207
4865
|
* <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>
|
|
4208
4866
|
*/
|
|
4209
4867
|
patchOperations?: PatchOperation[];
|
|
@@ -4214,14 +4872,17 @@ export interface UpdateDomainNameRequest {
|
|
|
4214
4872
|
*/
|
|
4215
4873
|
export interface UpdateGatewayResponseRequest {
|
|
4216
4874
|
/**
|
|
4875
|
+
* @public
|
|
4217
4876
|
* <p>The string identifier of the associated RestApi.</p>
|
|
4218
4877
|
*/
|
|
4219
4878
|
restApiId: string | undefined;
|
|
4220
4879
|
/**
|
|
4880
|
+
* @public
|
|
4221
4881
|
* <p>The response type of the associated GatewayResponse.</p>
|
|
4222
4882
|
*/
|
|
4223
4883
|
responseType: GatewayResponseType | string | undefined;
|
|
4224
4884
|
/**
|
|
4885
|
+
* @public
|
|
4225
4886
|
* <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>
|
|
4226
4887
|
*/
|
|
4227
4888
|
patchOperations?: PatchOperation[];
|
|
@@ -4232,18 +4893,22 @@ export interface UpdateGatewayResponseRequest {
|
|
|
4232
4893
|
*/
|
|
4233
4894
|
export interface UpdateIntegrationRequest {
|
|
4234
4895
|
/**
|
|
4896
|
+
* @public
|
|
4235
4897
|
* <p>The string identifier of the associated RestApi.</p>
|
|
4236
4898
|
*/
|
|
4237
4899
|
restApiId: string | undefined;
|
|
4238
4900
|
/**
|
|
4901
|
+
* @public
|
|
4239
4902
|
* <p>Represents an update integration request's resource identifier.</p>
|
|
4240
4903
|
*/
|
|
4241
4904
|
resourceId: string | undefined;
|
|
4242
4905
|
/**
|
|
4906
|
+
* @public
|
|
4243
4907
|
* <p>Represents an update integration request's HTTP method.</p>
|
|
4244
4908
|
*/
|
|
4245
4909
|
httpMethod: string | undefined;
|
|
4246
4910
|
/**
|
|
4911
|
+
* @public
|
|
4247
4912
|
* <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>
|
|
4248
4913
|
*/
|
|
4249
4914
|
patchOperations?: PatchOperation[];
|
|
@@ -4254,22 +4919,27 @@ export interface UpdateIntegrationRequest {
|
|
|
4254
4919
|
*/
|
|
4255
4920
|
export interface UpdateIntegrationResponseRequest {
|
|
4256
4921
|
/**
|
|
4922
|
+
* @public
|
|
4257
4923
|
* <p>The string identifier of the associated RestApi.</p>
|
|
4258
4924
|
*/
|
|
4259
4925
|
restApiId: string | undefined;
|
|
4260
4926
|
/**
|
|
4927
|
+
* @public
|
|
4261
4928
|
* <p>Specifies an update integration response request's resource identifier.</p>
|
|
4262
4929
|
*/
|
|
4263
4930
|
resourceId: string | undefined;
|
|
4264
4931
|
/**
|
|
4932
|
+
* @public
|
|
4265
4933
|
* <p>Specifies an update integration response request's HTTP method.</p>
|
|
4266
4934
|
*/
|
|
4267
4935
|
httpMethod: string | undefined;
|
|
4268
4936
|
/**
|
|
4937
|
+
* @public
|
|
4269
4938
|
* <p>Specifies an update integration response request's status code.</p>
|
|
4270
4939
|
*/
|
|
4271
4940
|
statusCode: string | undefined;
|
|
4272
4941
|
/**
|
|
4942
|
+
* @public
|
|
4273
4943
|
* <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>
|
|
4274
4944
|
*/
|
|
4275
4945
|
patchOperations?: PatchOperation[];
|
|
@@ -4280,18 +4950,22 @@ export interface UpdateIntegrationResponseRequest {
|
|
|
4280
4950
|
*/
|
|
4281
4951
|
export interface UpdateMethodRequest {
|
|
4282
4952
|
/**
|
|
4953
|
+
* @public
|
|
4283
4954
|
* <p>The string identifier of the associated RestApi.</p>
|
|
4284
4955
|
*/
|
|
4285
4956
|
restApiId: string | undefined;
|
|
4286
4957
|
/**
|
|
4958
|
+
* @public
|
|
4287
4959
|
* <p>The Resource identifier for the Method resource.</p>
|
|
4288
4960
|
*/
|
|
4289
4961
|
resourceId: string | undefined;
|
|
4290
4962
|
/**
|
|
4963
|
+
* @public
|
|
4291
4964
|
* <p>The HTTP verb of the Method resource.</p>
|
|
4292
4965
|
*/
|
|
4293
4966
|
httpMethod: string | undefined;
|
|
4294
4967
|
/**
|
|
4968
|
+
* @public
|
|
4295
4969
|
* <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>
|
|
4296
4970
|
*/
|
|
4297
4971
|
patchOperations?: PatchOperation[];
|
|
@@ -4302,22 +4976,27 @@ export interface UpdateMethodRequest {
|
|
|
4302
4976
|
*/
|
|
4303
4977
|
export interface UpdateMethodResponseRequest {
|
|
4304
4978
|
/**
|
|
4979
|
+
* @public
|
|
4305
4980
|
* <p>The string identifier of the associated RestApi.</p>
|
|
4306
4981
|
*/
|
|
4307
4982
|
restApiId: string | undefined;
|
|
4308
4983
|
/**
|
|
4984
|
+
* @public
|
|
4309
4985
|
* <p>The Resource identifier for the MethodResponse resource.</p>
|
|
4310
4986
|
*/
|
|
4311
4987
|
resourceId: string | undefined;
|
|
4312
4988
|
/**
|
|
4989
|
+
* @public
|
|
4313
4990
|
* <p>The HTTP verb of the Method resource.</p>
|
|
4314
4991
|
*/
|
|
4315
4992
|
httpMethod: string | undefined;
|
|
4316
4993
|
/**
|
|
4994
|
+
* @public
|
|
4317
4995
|
* <p>The status code for the MethodResponse resource.</p>
|
|
4318
4996
|
*/
|
|
4319
4997
|
statusCode: string | undefined;
|
|
4320
4998
|
/**
|
|
4999
|
+
* @public
|
|
4321
5000
|
* <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>
|
|
4322
5001
|
*/
|
|
4323
5002
|
patchOperations?: PatchOperation[];
|
|
@@ -4328,14 +5007,17 @@ export interface UpdateMethodResponseRequest {
|
|
|
4328
5007
|
*/
|
|
4329
5008
|
export interface UpdateModelRequest {
|
|
4330
5009
|
/**
|
|
5010
|
+
* @public
|
|
4331
5011
|
* <p>The string identifier of the associated RestApi.</p>
|
|
4332
5012
|
*/
|
|
4333
5013
|
restApiId: string | undefined;
|
|
4334
5014
|
/**
|
|
5015
|
+
* @public
|
|
4335
5016
|
* <p>The name of the model to update.</p>
|
|
4336
5017
|
*/
|
|
4337
5018
|
modelName: string | undefined;
|
|
4338
5019
|
/**
|
|
5020
|
+
* @public
|
|
4339
5021
|
* <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>
|
|
4340
5022
|
*/
|
|
4341
5023
|
patchOperations?: PatchOperation[];
|
|
@@ -4346,14 +5028,17 @@ export interface UpdateModelRequest {
|
|
|
4346
5028
|
*/
|
|
4347
5029
|
export interface UpdateRequestValidatorRequest {
|
|
4348
5030
|
/**
|
|
5031
|
+
* @public
|
|
4349
5032
|
* <p>The string identifier of the associated RestApi.</p>
|
|
4350
5033
|
*/
|
|
4351
5034
|
restApiId: string | undefined;
|
|
4352
5035
|
/**
|
|
5036
|
+
* @public
|
|
4353
5037
|
* <p>The identifier of RequestValidator to be updated.</p>
|
|
4354
5038
|
*/
|
|
4355
5039
|
requestValidatorId: string | undefined;
|
|
4356
5040
|
/**
|
|
5041
|
+
* @public
|
|
4357
5042
|
* <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>
|
|
4358
5043
|
*/
|
|
4359
5044
|
patchOperations?: PatchOperation[];
|
|
@@ -4364,14 +5049,17 @@ export interface UpdateRequestValidatorRequest {
|
|
|
4364
5049
|
*/
|
|
4365
5050
|
export interface UpdateResourceRequest {
|
|
4366
5051
|
/**
|
|
5052
|
+
* @public
|
|
4367
5053
|
* <p>The string identifier of the associated RestApi.</p>
|
|
4368
5054
|
*/
|
|
4369
5055
|
restApiId: string | undefined;
|
|
4370
5056
|
/**
|
|
5057
|
+
* @public
|
|
4371
5058
|
* <p>The identifier of the Resource resource.</p>
|
|
4372
5059
|
*/
|
|
4373
5060
|
resourceId: string | undefined;
|
|
4374
5061
|
/**
|
|
5062
|
+
* @public
|
|
4375
5063
|
* <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>
|
|
4376
5064
|
*/
|
|
4377
5065
|
patchOperations?: PatchOperation[];
|
|
@@ -4382,10 +5070,12 @@ export interface UpdateResourceRequest {
|
|
|
4382
5070
|
*/
|
|
4383
5071
|
export interface UpdateRestApiRequest {
|
|
4384
5072
|
/**
|
|
5073
|
+
* @public
|
|
4385
5074
|
* <p>The string identifier of the associated RestApi.</p>
|
|
4386
5075
|
*/
|
|
4387
5076
|
restApiId: string | undefined;
|
|
4388
5077
|
/**
|
|
5078
|
+
* @public
|
|
4389
5079
|
* <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>
|
|
4390
5080
|
*/
|
|
4391
5081
|
patchOperations?: PatchOperation[];
|
|
@@ -4396,14 +5086,17 @@ export interface UpdateRestApiRequest {
|
|
|
4396
5086
|
*/
|
|
4397
5087
|
export interface UpdateStageRequest {
|
|
4398
5088
|
/**
|
|
5089
|
+
* @public
|
|
4399
5090
|
* <p>The string identifier of the associated RestApi.</p>
|
|
4400
5091
|
*/
|
|
4401
5092
|
restApiId: string | undefined;
|
|
4402
5093
|
/**
|
|
5094
|
+
* @public
|
|
4403
5095
|
* <p>The name of the Stage resource to change information about.</p>
|
|
4404
5096
|
*/
|
|
4405
5097
|
stageName: string | undefined;
|
|
4406
5098
|
/**
|
|
5099
|
+
* @public
|
|
4407
5100
|
* <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>
|
|
4408
5101
|
*/
|
|
4409
5102
|
patchOperations?: PatchOperation[];
|
|
@@ -4414,14 +5107,17 @@ export interface UpdateStageRequest {
|
|
|
4414
5107
|
*/
|
|
4415
5108
|
export interface UpdateUsageRequest {
|
|
4416
5109
|
/**
|
|
5110
|
+
* @public
|
|
4417
5111
|
* <p>The Id of the usage plan associated with the usage data.</p>
|
|
4418
5112
|
*/
|
|
4419
5113
|
usagePlanId: string | undefined;
|
|
4420
5114
|
/**
|
|
5115
|
+
* @public
|
|
4421
5116
|
* <p>The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.</p>
|
|
4422
5117
|
*/
|
|
4423
5118
|
keyId: string | undefined;
|
|
4424
5119
|
/**
|
|
5120
|
+
* @public
|
|
4425
5121
|
* <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>
|
|
4426
5122
|
*/
|
|
4427
5123
|
patchOperations?: PatchOperation[];
|
|
@@ -4432,10 +5128,12 @@ export interface UpdateUsageRequest {
|
|
|
4432
5128
|
*/
|
|
4433
5129
|
export interface UpdateUsagePlanRequest {
|
|
4434
5130
|
/**
|
|
5131
|
+
* @public
|
|
4435
5132
|
* <p>The Id of the to-be-updated usage plan.</p>
|
|
4436
5133
|
*/
|
|
4437
5134
|
usagePlanId: string | undefined;
|
|
4438
5135
|
/**
|
|
5136
|
+
* @public
|
|
4439
5137
|
* <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>
|
|
4440
5138
|
*/
|
|
4441
5139
|
patchOperations?: PatchOperation[];
|
|
@@ -4446,10 +5144,12 @@ export interface UpdateUsagePlanRequest {
|
|
|
4446
5144
|
*/
|
|
4447
5145
|
export interface UpdateVpcLinkRequest {
|
|
4448
5146
|
/**
|
|
5147
|
+
* @public
|
|
4449
5148
|
* <p>The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.</p>
|
|
4450
5149
|
*/
|
|
4451
5150
|
vpcLinkId: string | undefined;
|
|
4452
5151
|
/**
|
|
5152
|
+
* @public
|
|
4453
5153
|
* <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>
|
|
4454
5154
|
*/
|
|
4455
5155
|
patchOperations?: PatchOperation[];
|