@aws-sdk/client-api-gateway 3.687.0 → 3.691.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 +486 -486
- package/dist-types/ts3.4/models/models_0.d.ts +488 -486
- package/package.json +7 -7
|
@@ -9,12 +9,12 @@ export interface AccessLogSettings {
|
|
|
9
9
|
* <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
10
|
* @public
|
|
11
11
|
*/
|
|
12
|
-
format?: string;
|
|
12
|
+
format?: string | undefined;
|
|
13
13
|
/**
|
|
14
14
|
* <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>
|
|
15
15
|
* @public
|
|
16
16
|
*/
|
|
17
|
-
destinationArn?: string;
|
|
17
|
+
destinationArn?: string | undefined;
|
|
18
18
|
}
|
|
19
19
|
/**
|
|
20
20
|
* <p> The API request rate limits.</p>
|
|
@@ -25,12 +25,12 @@ export interface ThrottleSettings {
|
|
|
25
25
|
* <p>The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.</p>
|
|
26
26
|
* @public
|
|
27
27
|
*/
|
|
28
|
-
burstLimit?: number;
|
|
28
|
+
burstLimit?: number | undefined;
|
|
29
29
|
/**
|
|
30
30
|
* <p>The API target request rate limit.</p>
|
|
31
31
|
* @public
|
|
32
32
|
*/
|
|
33
|
-
rateLimit?: number;
|
|
33
|
+
rateLimit?: number | undefined;
|
|
34
34
|
}
|
|
35
35
|
/**
|
|
36
36
|
* <p>Represents an AWS account that is associated with API Gateway.</p>
|
|
@@ -41,22 +41,22 @@ export interface Account {
|
|
|
41
41
|
* <p>The ARN of an Amazon CloudWatch role for the current Account. </p>
|
|
42
42
|
* @public
|
|
43
43
|
*/
|
|
44
|
-
cloudwatchRoleArn?: string;
|
|
44
|
+
cloudwatchRoleArn?: string | undefined;
|
|
45
45
|
/**
|
|
46
46
|
* <p>Specifies the API request limits configured for the current Account.</p>
|
|
47
47
|
* @public
|
|
48
48
|
*/
|
|
49
|
-
throttleSettings?: ThrottleSettings;
|
|
49
|
+
throttleSettings?: ThrottleSettings | undefined;
|
|
50
50
|
/**
|
|
51
51
|
* <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>
|
|
52
52
|
* @public
|
|
53
53
|
*/
|
|
54
|
-
features?: string[];
|
|
54
|
+
features?: string[] | undefined;
|
|
55
55
|
/**
|
|
56
56
|
* <p>The version of the API keys used for the account.</p>
|
|
57
57
|
* @public
|
|
58
58
|
*/
|
|
59
|
-
apiKeyVersion?: string;
|
|
59
|
+
apiKeyVersion?: string | undefined;
|
|
60
60
|
}
|
|
61
61
|
/**
|
|
62
62
|
* <p>A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.</p>
|
|
@@ -67,52 +67,52 @@ export interface ApiKey {
|
|
|
67
67
|
* <p>The identifier of the API Key.</p>
|
|
68
68
|
* @public
|
|
69
69
|
*/
|
|
70
|
-
id?: string;
|
|
70
|
+
id?: string | undefined;
|
|
71
71
|
/**
|
|
72
72
|
* <p>The value of the API Key.</p>
|
|
73
73
|
* @public
|
|
74
74
|
*/
|
|
75
|
-
value?: string;
|
|
75
|
+
value?: string | undefined;
|
|
76
76
|
/**
|
|
77
77
|
* <p>The name of the API Key.</p>
|
|
78
78
|
* @public
|
|
79
79
|
*/
|
|
80
|
-
name?: string;
|
|
80
|
+
name?: string | undefined;
|
|
81
81
|
/**
|
|
82
82
|
* <p>An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.</p>
|
|
83
83
|
* @public
|
|
84
84
|
*/
|
|
85
|
-
customerId?: string;
|
|
85
|
+
customerId?: string | undefined;
|
|
86
86
|
/**
|
|
87
87
|
* <p>The description of the API Key.</p>
|
|
88
88
|
* @public
|
|
89
89
|
*/
|
|
90
|
-
description?: string;
|
|
90
|
+
description?: string | undefined;
|
|
91
91
|
/**
|
|
92
92
|
* <p>Specifies whether the API Key can be used by callers.</p>
|
|
93
93
|
* @public
|
|
94
94
|
*/
|
|
95
|
-
enabled?: boolean;
|
|
95
|
+
enabled?: boolean | undefined;
|
|
96
96
|
/**
|
|
97
97
|
* <p>The timestamp when the API Key was created.</p>
|
|
98
98
|
* @public
|
|
99
99
|
*/
|
|
100
|
-
createdDate?: Date;
|
|
100
|
+
createdDate?: Date | undefined;
|
|
101
101
|
/**
|
|
102
102
|
* <p>The timestamp when the API Key was last updated.</p>
|
|
103
103
|
* @public
|
|
104
104
|
*/
|
|
105
|
-
lastUpdatedDate?: Date;
|
|
105
|
+
lastUpdatedDate?: Date | undefined;
|
|
106
106
|
/**
|
|
107
107
|
* <p>A list of Stage resources that are associated with the ApiKey resource.</p>
|
|
108
108
|
* @public
|
|
109
109
|
*/
|
|
110
|
-
stageKeys?: string[];
|
|
110
|
+
stageKeys?: string[] | undefined;
|
|
111
111
|
/**
|
|
112
112
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
113
113
|
* @public
|
|
114
114
|
*/
|
|
115
|
-
tags?: Record<string, string
|
|
115
|
+
tags?: Record<string, string> | undefined;
|
|
116
116
|
}
|
|
117
117
|
/**
|
|
118
118
|
* <p>The identifier of an ApiKey used in a UsagePlan.</p>
|
|
@@ -123,12 +123,12 @@ export interface ApiKeyIds {
|
|
|
123
123
|
* <p>A list of all the ApiKey identifiers.</p>
|
|
124
124
|
* @public
|
|
125
125
|
*/
|
|
126
|
-
ids?: string[];
|
|
126
|
+
ids?: string[] | undefined;
|
|
127
127
|
/**
|
|
128
128
|
* <p>A list of warning messages.</p>
|
|
129
129
|
* @public
|
|
130
130
|
*/
|
|
131
|
-
warnings?: string[];
|
|
131
|
+
warnings?: string[] | undefined;
|
|
132
132
|
}
|
|
133
133
|
/**
|
|
134
134
|
* <p>Represents a collection of API keys as represented by an ApiKeys resource.</p>
|
|
@@ -139,17 +139,17 @@ export interface ApiKeys {
|
|
|
139
139
|
* <p>A list of warning messages logged during the import of API keys when the <code>failOnWarnings</code> option is set to true.</p>
|
|
140
140
|
* @public
|
|
141
141
|
*/
|
|
142
|
-
warnings?: string[];
|
|
142
|
+
warnings?: string[] | undefined;
|
|
143
143
|
/**
|
|
144
144
|
* <p>The current page of elements from this collection.</p>
|
|
145
145
|
* @public
|
|
146
146
|
*/
|
|
147
|
-
items?: ApiKey[];
|
|
147
|
+
items?: ApiKey[] | undefined;
|
|
148
148
|
/**
|
|
149
149
|
* <p>The current pagination position in the paged result set.</p>
|
|
150
150
|
* @public
|
|
151
151
|
*/
|
|
152
|
-
position?: string;
|
|
152
|
+
position?: string | undefined;
|
|
153
153
|
}
|
|
154
154
|
/**
|
|
155
155
|
* @public
|
|
@@ -183,17 +183,17 @@ export interface ApiStage {
|
|
|
183
183
|
* <p>API Id of the associated API stage in a usage plan.</p>
|
|
184
184
|
* @public
|
|
185
185
|
*/
|
|
186
|
-
apiId?: string;
|
|
186
|
+
apiId?: string | undefined;
|
|
187
187
|
/**
|
|
188
188
|
* <p>API stage name of the associated API stage in a usage plan.</p>
|
|
189
189
|
* @public
|
|
190
190
|
*/
|
|
191
|
-
stage?: string;
|
|
191
|
+
stage?: string | undefined;
|
|
192
192
|
/**
|
|
193
193
|
* <p>Map containing method level throttling information for API stage in a usage plan.</p>
|
|
194
194
|
* @public
|
|
195
195
|
*/
|
|
196
|
-
throttle?: Record<string, ThrottleSettings
|
|
196
|
+
throttle?: Record<string, ThrottleSettings> | undefined;
|
|
197
197
|
}
|
|
198
198
|
/**
|
|
199
199
|
* @public
|
|
@@ -217,37 +217,37 @@ export interface Authorizer {
|
|
|
217
217
|
* <p>The identifier for the authorizer resource.</p>
|
|
218
218
|
* @public
|
|
219
219
|
*/
|
|
220
|
-
id?: string;
|
|
220
|
+
id?: string | undefined;
|
|
221
221
|
/**
|
|
222
222
|
* <p>The name of the authorizer.</p>
|
|
223
223
|
* @public
|
|
224
224
|
*/
|
|
225
|
-
name?: string;
|
|
225
|
+
name?: string | undefined;
|
|
226
226
|
/**
|
|
227
227
|
* <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>
|
|
228
228
|
* @public
|
|
229
229
|
*/
|
|
230
|
-
type?: AuthorizerType;
|
|
230
|
+
type?: AuthorizerType | undefined;
|
|
231
231
|
/**
|
|
232
232
|
* <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>
|
|
233
233
|
* @public
|
|
234
234
|
*/
|
|
235
|
-
providerARNs?: string[];
|
|
235
|
+
providerARNs?: string[] | undefined;
|
|
236
236
|
/**
|
|
237
237
|
* <p>Optional customer-defined field, used in OpenAPI imports and exports without functional impact.</p>
|
|
238
238
|
* @public
|
|
239
239
|
*/
|
|
240
|
-
authType?: string;
|
|
240
|
+
authType?: string | undefined;
|
|
241
241
|
/**
|
|
242
242
|
* <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>
|
|
243
243
|
* @public
|
|
244
244
|
*/
|
|
245
|
-
authorizerUri?: string;
|
|
245
|
+
authorizerUri?: string | undefined;
|
|
246
246
|
/**
|
|
247
247
|
* <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>
|
|
248
248
|
* @public
|
|
249
249
|
*/
|
|
250
|
-
authorizerCredentials?: string;
|
|
250
|
+
authorizerCredentials?: string | undefined;
|
|
251
251
|
/**
|
|
252
252
|
* <p>The identity source for which authorization is requested. For a <code>TOKEN</code> or
|
|
253
253
|
* <code>COGNITO_USER_POOLS</code> authorizer, this is required and specifies the request
|
|
@@ -266,17 +266,17 @@ export interface Authorizer {
|
|
|
266
266
|
* authorization caching is not enabled, this property is optional. </p>
|
|
267
267
|
* @public
|
|
268
268
|
*/
|
|
269
|
-
identitySource?: string;
|
|
269
|
+
identitySource?: string | undefined;
|
|
270
270
|
/**
|
|
271
271
|
* <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>
|
|
272
272
|
* @public
|
|
273
273
|
*/
|
|
274
|
-
identityValidationExpression?: string;
|
|
274
|
+
identityValidationExpression?: string | undefined;
|
|
275
275
|
/**
|
|
276
276
|
* <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>
|
|
277
277
|
* @public
|
|
278
278
|
*/
|
|
279
|
-
authorizerResultTtlInSeconds?: number;
|
|
279
|
+
authorizerResultTtlInSeconds?: number | undefined;
|
|
280
280
|
}
|
|
281
281
|
/**
|
|
282
282
|
* <p>Represents a collection of Authorizer resources.</p>
|
|
@@ -287,12 +287,12 @@ export interface Authorizers {
|
|
|
287
287
|
* <p>The current page of elements from this collection.</p>
|
|
288
288
|
* @public
|
|
289
289
|
*/
|
|
290
|
-
items?: Authorizer[];
|
|
290
|
+
items?: Authorizer[] | undefined;
|
|
291
291
|
/**
|
|
292
292
|
* <p>The current pagination position in the paged result set.</p>
|
|
293
293
|
* @public
|
|
294
294
|
*/
|
|
295
|
-
position?: string;
|
|
295
|
+
position?: string | undefined;
|
|
296
296
|
}
|
|
297
297
|
/**
|
|
298
298
|
* <p>The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
|
|
@@ -327,12 +327,12 @@ export interface StageKey {
|
|
|
327
327
|
* <p>The string identifier of the associated RestApi.</p>
|
|
328
328
|
* @public
|
|
329
329
|
*/
|
|
330
|
-
restApiId?: string;
|
|
330
|
+
restApiId?: string | undefined;
|
|
331
331
|
/**
|
|
332
332
|
* <p>The stage name associated with the stage key.</p>
|
|
333
333
|
* @public
|
|
334
334
|
*/
|
|
335
|
-
stageName?: string;
|
|
335
|
+
stageName?: string | undefined;
|
|
336
336
|
}
|
|
337
337
|
/**
|
|
338
338
|
* <p>Request to create an ApiKey resource.</p>
|
|
@@ -343,42 +343,42 @@ export interface CreateApiKeyRequest {
|
|
|
343
343
|
* <p>The name of the ApiKey.</p>
|
|
344
344
|
* @public
|
|
345
345
|
*/
|
|
346
|
-
name?: string;
|
|
346
|
+
name?: string | undefined;
|
|
347
347
|
/**
|
|
348
348
|
* <p>The description of the ApiKey.</p>
|
|
349
349
|
* @public
|
|
350
350
|
*/
|
|
351
|
-
description?: string;
|
|
351
|
+
description?: string | undefined;
|
|
352
352
|
/**
|
|
353
353
|
* <p>Specifies whether the ApiKey can be used by callers.</p>
|
|
354
354
|
* @public
|
|
355
355
|
*/
|
|
356
|
-
enabled?: boolean;
|
|
356
|
+
enabled?: boolean | undefined;
|
|
357
357
|
/**
|
|
358
358
|
* <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>
|
|
359
359
|
* @public
|
|
360
360
|
*/
|
|
361
|
-
generateDistinctId?: boolean;
|
|
361
|
+
generateDistinctId?: boolean | undefined;
|
|
362
362
|
/**
|
|
363
363
|
* <p>Specifies a value of the API key.</p>
|
|
364
364
|
* @public
|
|
365
365
|
*/
|
|
366
|
-
value?: string;
|
|
366
|
+
value?: string | undefined;
|
|
367
367
|
/**
|
|
368
368
|
* <p>DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.</p>
|
|
369
369
|
* @public
|
|
370
370
|
*/
|
|
371
|
-
stageKeys?: StageKey[];
|
|
371
|
+
stageKeys?: StageKey[] | undefined;
|
|
372
372
|
/**
|
|
373
373
|
* <p>An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.</p>
|
|
374
374
|
* @public
|
|
375
375
|
*/
|
|
376
|
-
customerId?: string;
|
|
376
|
+
customerId?: string | undefined;
|
|
377
377
|
/**
|
|
378
378
|
* <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>
|
|
379
379
|
* @public
|
|
380
380
|
*/
|
|
381
|
-
tags?: Record<string, string
|
|
381
|
+
tags?: Record<string, string> | undefined;
|
|
382
382
|
}
|
|
383
383
|
/**
|
|
384
384
|
* <p>The request exceeded the rate limit. Retry after the specified time period.</p>
|
|
@@ -387,7 +387,7 @@ export interface CreateApiKeyRequest {
|
|
|
387
387
|
export declare class LimitExceededException extends __BaseException {
|
|
388
388
|
readonly name: "LimitExceededException";
|
|
389
389
|
readonly $fault: "client";
|
|
390
|
-
retryAfterSeconds?: string;
|
|
390
|
+
retryAfterSeconds?: string | undefined;
|
|
391
391
|
/**
|
|
392
392
|
* @internal
|
|
393
393
|
*/
|
|
@@ -412,7 +412,7 @@ export declare class NotFoundException extends __BaseException {
|
|
|
412
412
|
export declare class TooManyRequestsException extends __BaseException {
|
|
413
413
|
readonly name: "TooManyRequestsException";
|
|
414
414
|
readonly $fault: "client";
|
|
415
|
-
retryAfterSeconds?: string;
|
|
415
|
+
retryAfterSeconds?: string | undefined;
|
|
416
416
|
/**
|
|
417
417
|
* @internal
|
|
418
418
|
*/
|
|
@@ -454,22 +454,22 @@ export interface CreateAuthorizerRequest {
|
|
|
454
454
|
* <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>
|
|
455
455
|
* @public
|
|
456
456
|
*/
|
|
457
|
-
providerARNs?: string[];
|
|
457
|
+
providerARNs?: string[] | undefined;
|
|
458
458
|
/**
|
|
459
459
|
* <p>Optional customer-defined field, used in OpenAPI imports and exports without functional impact.</p>
|
|
460
460
|
* @public
|
|
461
461
|
*/
|
|
462
|
-
authType?: string;
|
|
462
|
+
authType?: string | undefined;
|
|
463
463
|
/**
|
|
464
464
|
* <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>
|
|
465
465
|
* @public
|
|
466
466
|
*/
|
|
467
|
-
authorizerUri?: string;
|
|
467
|
+
authorizerUri?: string | undefined;
|
|
468
468
|
/**
|
|
469
469
|
* <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>
|
|
470
470
|
* @public
|
|
471
471
|
*/
|
|
472
|
-
authorizerCredentials?: string;
|
|
472
|
+
authorizerCredentials?: string | undefined;
|
|
473
473
|
/**
|
|
474
474
|
* <p>The identity source for which authorization is requested. For a <code>TOKEN</code> or
|
|
475
475
|
* <code>COGNITO_USER_POOLS</code> authorizer, this is required and specifies the request
|
|
@@ -490,17 +490,17 @@ export interface CreateAuthorizerRequest {
|
|
|
490
490
|
* optional.</p>
|
|
491
491
|
* @public
|
|
492
492
|
*/
|
|
493
|
-
identitySource?: string;
|
|
493
|
+
identitySource?: string | undefined;
|
|
494
494
|
/**
|
|
495
495
|
* <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>
|
|
496
496
|
* @public
|
|
497
497
|
*/
|
|
498
|
-
identityValidationExpression?: string;
|
|
498
|
+
identityValidationExpression?: string | undefined;
|
|
499
499
|
/**
|
|
500
500
|
* <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>
|
|
501
501
|
* @public
|
|
502
502
|
*/
|
|
503
|
-
authorizerResultTtlInSeconds?: number;
|
|
503
|
+
authorizerResultTtlInSeconds?: number | undefined;
|
|
504
504
|
}
|
|
505
505
|
/**
|
|
506
506
|
* <p>Represents the base path that callers of the API must provide as part of the URL after the domain name.</p>
|
|
@@ -511,17 +511,17 @@ export interface BasePathMapping {
|
|
|
511
511
|
* <p>The base path name that callers of the API must provide as part of the URL after the domain name.</p>
|
|
512
512
|
* @public
|
|
513
513
|
*/
|
|
514
|
-
basePath?: string;
|
|
514
|
+
basePath?: string | undefined;
|
|
515
515
|
/**
|
|
516
516
|
* <p>The string identifier of the associated RestApi.</p>
|
|
517
517
|
* @public
|
|
518
518
|
*/
|
|
519
|
-
restApiId?: string;
|
|
519
|
+
restApiId?: string | undefined;
|
|
520
520
|
/**
|
|
521
521
|
* <p>The name of the associated stage.</p>
|
|
522
522
|
* @public
|
|
523
523
|
*/
|
|
524
|
-
stage?: string;
|
|
524
|
+
stage?: string | undefined;
|
|
525
525
|
}
|
|
526
526
|
/**
|
|
527
527
|
* <p>Requests API Gateway to create a new BasePathMapping resource.</p>
|
|
@@ -537,7 +537,7 @@ export interface CreateBasePathMappingRequest {
|
|
|
537
537
|
* <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>
|
|
538
538
|
* @public
|
|
539
539
|
*/
|
|
540
|
-
basePath?: string;
|
|
540
|
+
basePath?: string | undefined;
|
|
541
541
|
/**
|
|
542
542
|
* <p>The string identifier of the associated RestApi.</p>
|
|
543
543
|
* @public
|
|
@@ -547,7 +547,7 @@ export interface CreateBasePathMappingRequest {
|
|
|
547
547
|
* <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>
|
|
548
548
|
* @public
|
|
549
549
|
*/
|
|
550
|
-
stage?: string;
|
|
550
|
+
stage?: string | undefined;
|
|
551
551
|
}
|
|
552
552
|
/**
|
|
553
553
|
* @public
|
|
@@ -576,17 +576,17 @@ export interface DeploymentCanarySettings {
|
|
|
576
576
|
* <p>The percentage (0.0-100.0) of traffic routed to the canary deployment.</p>
|
|
577
577
|
* @public
|
|
578
578
|
*/
|
|
579
|
-
percentTraffic?: number;
|
|
579
|
+
percentTraffic?: number | undefined;
|
|
580
580
|
/**
|
|
581
581
|
* <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>
|
|
582
582
|
* @public
|
|
583
583
|
*/
|
|
584
|
-
stageVariableOverrides?: Record<string, string
|
|
584
|
+
stageVariableOverrides?: Record<string, string> | undefined;
|
|
585
585
|
/**
|
|
586
586
|
* <p>A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.</p>
|
|
587
587
|
* @public
|
|
588
588
|
*/
|
|
589
|
-
useStageCache?: boolean;
|
|
589
|
+
useStageCache?: boolean | undefined;
|
|
590
590
|
}
|
|
591
591
|
/**
|
|
592
592
|
* <p>Requests API Gateway to create a Deployment resource.</p>
|
|
@@ -602,44 +602,44 @@ export interface CreateDeploymentRequest {
|
|
|
602
602
|
* <p>The name of the Stage resource for the Deployment resource to create.</p>
|
|
603
603
|
* @public
|
|
604
604
|
*/
|
|
605
|
-
stageName?: string;
|
|
605
|
+
stageName?: string | undefined;
|
|
606
606
|
/**
|
|
607
607
|
* <p>The description of the Stage resource for the Deployment resource to create.</p>
|
|
608
608
|
* @public
|
|
609
609
|
*/
|
|
610
|
-
stageDescription?: string;
|
|
610
|
+
stageDescription?: string | undefined;
|
|
611
611
|
/**
|
|
612
612
|
* <p>The description for the Deployment resource to create.</p>
|
|
613
613
|
* @public
|
|
614
614
|
*/
|
|
615
|
-
description?: string;
|
|
615
|
+
description?: string | undefined;
|
|
616
616
|
/**
|
|
617
617
|
* <p>Enables a cache cluster for the Stage resource specified in the input.</p>
|
|
618
618
|
* @public
|
|
619
619
|
*/
|
|
620
|
-
cacheClusterEnabled?: boolean;
|
|
620
|
+
cacheClusterEnabled?: boolean | undefined;
|
|
621
621
|
/**
|
|
622
622
|
* <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>
|
|
623
623
|
* @public
|
|
624
624
|
*/
|
|
625
|
-
cacheClusterSize?: CacheClusterSize;
|
|
625
|
+
cacheClusterSize?: CacheClusterSize | undefined;
|
|
626
626
|
/**
|
|
627
627
|
* <p>A map that defines the stage variables for the Stage resource that is associated
|
|
628
628
|
* with the new deployment. Variable names can have alphanumeric and underscore characters, and the values
|
|
629
629
|
* must match <code>[A-Za-z0-9-._~:/?#&=,]+</code>.</p>
|
|
630
630
|
* @public
|
|
631
631
|
*/
|
|
632
|
-
variables?: Record<string, string
|
|
632
|
+
variables?: Record<string, string> | undefined;
|
|
633
633
|
/**
|
|
634
634
|
* <p>The input configuration for the canary deployment when the deployment is a canary release deployment. </p>
|
|
635
635
|
* @public
|
|
636
636
|
*/
|
|
637
|
-
canarySettings?: DeploymentCanarySettings;
|
|
637
|
+
canarySettings?: DeploymentCanarySettings | undefined;
|
|
638
638
|
/**
|
|
639
639
|
* <p>Specifies whether active tracing with X-ray is enabled for the Stage.</p>
|
|
640
640
|
* @public
|
|
641
641
|
*/
|
|
642
|
-
tracingEnabled?: boolean;
|
|
642
|
+
tracingEnabled?: boolean | undefined;
|
|
643
643
|
}
|
|
644
644
|
/**
|
|
645
645
|
* <p>Represents a summary of a Method resource, given a particular date and time.</p>
|
|
@@ -650,12 +650,12 @@ export interface MethodSnapshot {
|
|
|
650
650
|
* <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>
|
|
651
651
|
* @public
|
|
652
652
|
*/
|
|
653
|
-
authorizationType?: string;
|
|
653
|
+
authorizationType?: string | undefined;
|
|
654
654
|
/**
|
|
655
655
|
* <p>Specifies whether the method requires a valid ApiKey.</p>
|
|
656
656
|
* @public
|
|
657
657
|
*/
|
|
658
|
-
apiKeyRequired?: boolean;
|
|
658
|
+
apiKeyRequired?: boolean | undefined;
|
|
659
659
|
}
|
|
660
660
|
/**
|
|
661
661
|
* <p>An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.</p>
|
|
@@ -666,22 +666,22 @@ export interface Deployment {
|
|
|
666
666
|
* <p>The identifier for the deployment resource.</p>
|
|
667
667
|
* @public
|
|
668
668
|
*/
|
|
669
|
-
id?: string;
|
|
669
|
+
id?: string | undefined;
|
|
670
670
|
/**
|
|
671
671
|
* <p>The description for the deployment resource.</p>
|
|
672
672
|
* @public
|
|
673
673
|
*/
|
|
674
|
-
description?: string;
|
|
674
|
+
description?: string | undefined;
|
|
675
675
|
/**
|
|
676
676
|
* <p>The date and time that the deployment resource was created.</p>
|
|
677
677
|
* @public
|
|
678
678
|
*/
|
|
679
|
-
createdDate?: Date;
|
|
679
|
+
createdDate?: Date | undefined;
|
|
680
680
|
/**
|
|
681
681
|
* <p>A summary of the RestApi at the date and time that the deployment resource was created.</p>
|
|
682
682
|
* @public
|
|
683
683
|
*/
|
|
684
|
-
apiSummary?: Record<string, Record<string, MethodSnapshot
|
|
684
|
+
apiSummary?: Record<string, Record<string, MethodSnapshot>> | undefined;
|
|
685
685
|
}
|
|
686
686
|
/**
|
|
687
687
|
* <p>The requested service is not available. For details see the accompanying error message. Retry after the specified time period.</p>
|
|
@@ -690,7 +690,7 @@ export interface Deployment {
|
|
|
690
690
|
export declare class ServiceUnavailableException extends __BaseException {
|
|
691
691
|
readonly name: "ServiceUnavailableException";
|
|
692
692
|
readonly $fault: "server";
|
|
693
|
-
retryAfterSeconds?: string;
|
|
693
|
+
retryAfterSeconds?: string | undefined;
|
|
694
694
|
/**
|
|
695
695
|
* @internal
|
|
696
696
|
*/
|
|
@@ -732,22 +732,22 @@ export interface DocumentationPartLocation {
|
|
|
732
732
|
* <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>
|
|
733
733
|
* @public
|
|
734
734
|
*/
|
|
735
|
-
path?: string;
|
|
735
|
+
path?: string | undefined;
|
|
736
736
|
/**
|
|
737
737
|
* <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>
|
|
738
738
|
* @public
|
|
739
739
|
*/
|
|
740
|
-
method?: string;
|
|
740
|
+
method?: string | undefined;
|
|
741
741
|
/**
|
|
742
742
|
* <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>
|
|
743
743
|
* @public
|
|
744
744
|
*/
|
|
745
|
-
statusCode?: string;
|
|
745
|
+
statusCode?: string | undefined;
|
|
746
746
|
/**
|
|
747
747
|
* <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>
|
|
748
748
|
* @public
|
|
749
749
|
*/
|
|
750
|
-
name?: string;
|
|
750
|
+
name?: string | undefined;
|
|
751
751
|
}
|
|
752
752
|
/**
|
|
753
753
|
* <p>Creates a new documentation part of a given API.</p>
|
|
@@ -779,17 +779,17 @@ export interface DocumentationPart {
|
|
|
779
779
|
* <p>The DocumentationPart identifier, generated by API Gateway when the <code>DocumentationPart</code> is created.</p>
|
|
780
780
|
* @public
|
|
781
781
|
*/
|
|
782
|
-
id?: string;
|
|
782
|
+
id?: string | undefined;
|
|
783
783
|
/**
|
|
784
784
|
* <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>
|
|
785
785
|
* @public
|
|
786
786
|
*/
|
|
787
|
-
location?: DocumentationPartLocation;
|
|
787
|
+
location?: DocumentationPartLocation | undefined;
|
|
788
788
|
/**
|
|
789
789
|
* <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>
|
|
790
790
|
* @public
|
|
791
791
|
*/
|
|
792
|
-
properties?: string;
|
|
792
|
+
properties?: string | undefined;
|
|
793
793
|
}
|
|
794
794
|
/**
|
|
795
795
|
* <p>Creates a new documentation version of a given API.</p>
|
|
@@ -810,12 +810,12 @@ export interface CreateDocumentationVersionRequest {
|
|
|
810
810
|
* <p>The stage name to be associated with the new documentation snapshot.</p>
|
|
811
811
|
* @public
|
|
812
812
|
*/
|
|
813
|
-
stageName?: string;
|
|
813
|
+
stageName?: string | undefined;
|
|
814
814
|
/**
|
|
815
815
|
* <p>A description about the new documentation snapshot.</p>
|
|
816
816
|
* @public
|
|
817
817
|
*/
|
|
818
|
-
description?: string;
|
|
818
|
+
description?: string | undefined;
|
|
819
819
|
}
|
|
820
820
|
/**
|
|
821
821
|
* <p>A snapshot of the documentation of an API.</p>
|
|
@@ -826,17 +826,17 @@ export interface DocumentationVersion {
|
|
|
826
826
|
* <p>The version identifier of the API documentation snapshot.</p>
|
|
827
827
|
* @public
|
|
828
828
|
*/
|
|
829
|
-
version?: string;
|
|
829
|
+
version?: string | undefined;
|
|
830
830
|
/**
|
|
831
831
|
* <p>The date when the API documentation snapshot is created.</p>
|
|
832
832
|
* @public
|
|
833
833
|
*/
|
|
834
|
-
createdDate?: Date;
|
|
834
|
+
createdDate?: Date | undefined;
|
|
835
835
|
/**
|
|
836
836
|
* <p>The description of the API documentation snapshot.</p>
|
|
837
837
|
* @public
|
|
838
838
|
*/
|
|
839
|
-
description?: string;
|
|
839
|
+
description?: string | undefined;
|
|
840
840
|
}
|
|
841
841
|
/**
|
|
842
842
|
* @public
|
|
@@ -860,12 +860,12 @@ export interface EndpointConfiguration {
|
|
|
860
860
|
* <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>
|
|
861
861
|
* @public
|
|
862
862
|
*/
|
|
863
|
-
types?: EndpointType[];
|
|
863
|
+
types?: EndpointType[] | undefined;
|
|
864
864
|
/**
|
|
865
865
|
* <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>
|
|
866
866
|
* @public
|
|
867
867
|
*/
|
|
868
|
-
vpcEndpointIds?: string[];
|
|
868
|
+
vpcEndpointIds?: string[] | undefined;
|
|
869
869
|
}
|
|
870
870
|
/**
|
|
871
871
|
* <p>The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway
|
|
@@ -882,12 +882,12 @@ export interface MutualTlsAuthenticationInput {
|
|
|
882
882
|
* permissions to access the S3 object.</p>
|
|
883
883
|
* @public
|
|
884
884
|
*/
|
|
885
|
-
truststoreUri?: string;
|
|
885
|
+
truststoreUri?: string | undefined;
|
|
886
886
|
/**
|
|
887
887
|
* <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>
|
|
888
888
|
* @public
|
|
889
889
|
*/
|
|
890
|
-
truststoreVersion?: string;
|
|
890
|
+
truststoreVersion?: string | undefined;
|
|
891
891
|
}
|
|
892
892
|
/**
|
|
893
893
|
* @public
|
|
@@ -915,66 +915,66 @@ export interface CreateDomainNameRequest {
|
|
|
915
915
|
* <p>The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.</p>
|
|
916
916
|
* @public
|
|
917
917
|
*/
|
|
918
|
-
certificateName?: string;
|
|
918
|
+
certificateName?: string | undefined;
|
|
919
919
|
/**
|
|
920
920
|
* <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>
|
|
921
921
|
* @public
|
|
922
922
|
*/
|
|
923
|
-
certificateBody?: string;
|
|
923
|
+
certificateBody?: string | undefined;
|
|
924
924
|
/**
|
|
925
925
|
* <p>[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.</p>
|
|
926
926
|
* @public
|
|
927
927
|
*/
|
|
928
|
-
certificatePrivateKey?: string;
|
|
928
|
+
certificatePrivateKey?: string | undefined;
|
|
929
929
|
/**
|
|
930
930
|
* <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>
|
|
931
931
|
* @public
|
|
932
932
|
*/
|
|
933
|
-
certificateChain?: string;
|
|
933
|
+
certificateChain?: string | undefined;
|
|
934
934
|
/**
|
|
935
935
|
* <p>The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name. Certificate Manager is the only supported source.</p>
|
|
936
936
|
* @public
|
|
937
937
|
*/
|
|
938
|
-
certificateArn?: string;
|
|
938
|
+
certificateArn?: string | undefined;
|
|
939
939
|
/**
|
|
940
940
|
* <p>The user-friendly name of the certificate that will be used by regional endpoint for this domain name.</p>
|
|
941
941
|
* @public
|
|
942
942
|
*/
|
|
943
|
-
regionalCertificateName?: string;
|
|
943
|
+
regionalCertificateName?: string | undefined;
|
|
944
944
|
/**
|
|
945
945
|
* <p>The reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name. Certificate Manager is the only supported source.</p>
|
|
946
946
|
* @public
|
|
947
947
|
*/
|
|
948
|
-
regionalCertificateArn?: string;
|
|
948
|
+
regionalCertificateArn?: string | undefined;
|
|
949
949
|
/**
|
|
950
950
|
* <p>The endpoint configuration of this DomainName showing the endpoint types of the domain name. </p>
|
|
951
951
|
* @public
|
|
952
952
|
*/
|
|
953
|
-
endpointConfiguration?: EndpointConfiguration;
|
|
953
|
+
endpointConfiguration?: EndpointConfiguration | undefined;
|
|
954
954
|
/**
|
|
955
955
|
* <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>
|
|
956
956
|
* @public
|
|
957
957
|
*/
|
|
958
|
-
tags?: Record<string, string
|
|
958
|
+
tags?: Record<string, string> | undefined;
|
|
959
959
|
/**
|
|
960
960
|
* <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>
|
|
961
961
|
* @public
|
|
962
962
|
*/
|
|
963
|
-
securityPolicy?: SecurityPolicy;
|
|
963
|
+
securityPolicy?: SecurityPolicy | undefined;
|
|
964
964
|
/**
|
|
965
965
|
* <p>The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway
|
|
966
966
|
* performs two-way authentication between the client and the server. Clients must present a
|
|
967
967
|
* trusted certificate to access your API.</p>
|
|
968
968
|
* @public
|
|
969
969
|
*/
|
|
970
|
-
mutualTlsAuthentication?: MutualTlsAuthenticationInput;
|
|
970
|
+
mutualTlsAuthentication?: MutualTlsAuthenticationInput | undefined;
|
|
971
971
|
/**
|
|
972
972
|
* <p>The ARN of the public certificate issued by ACM to validate ownership of your custom
|
|
973
973
|
* domain. Only required when configuring mutual TLS and using an ACM imported or private CA
|
|
974
974
|
* certificate ARN as the regionalCertificateArn.</p>
|
|
975
975
|
* @public
|
|
976
976
|
*/
|
|
977
|
-
ownershipVerificationCertificateArn?: string;
|
|
977
|
+
ownershipVerificationCertificateArn?: string | undefined;
|
|
978
978
|
}
|
|
979
979
|
/**
|
|
980
980
|
* @public
|
|
@@ -1006,12 +1006,12 @@ export interface MutualTlsAuthentication {
|
|
|
1006
1006
|
* permissions to access the S3 object.</p>
|
|
1007
1007
|
* @public
|
|
1008
1008
|
*/
|
|
1009
|
-
truststoreUri?: string;
|
|
1009
|
+
truststoreUri?: string | undefined;
|
|
1010
1010
|
/**
|
|
1011
1011
|
* <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>
|
|
1012
1012
|
* @public
|
|
1013
1013
|
*/
|
|
1014
|
-
truststoreVersion?: string;
|
|
1014
|
+
truststoreVersion?: string | undefined;
|
|
1015
1015
|
/**
|
|
1016
1016
|
* <p>A list of warnings that API Gateway returns while processing your truststore. Invalid
|
|
1017
1017
|
* certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able
|
|
@@ -1019,7 +1019,7 @@ export interface MutualTlsAuthentication {
|
|
|
1019
1019
|
* domain name to use the new version.</p>
|
|
1020
1020
|
* @public
|
|
1021
1021
|
*/
|
|
1022
|
-
truststoreWarnings?: string[];
|
|
1022
|
+
truststoreWarnings?: string[] | undefined;
|
|
1023
1023
|
}
|
|
1024
1024
|
/**
|
|
1025
1025
|
* <p>Represents a custom domain name as a user-friendly host name of an API (RestApi).</p>
|
|
@@ -1030,91 +1030,91 @@ export interface DomainName {
|
|
|
1030
1030
|
* <p>The custom domain name as an API host name, for example, <code>my-api.example.com</code>.</p>
|
|
1031
1031
|
* @public
|
|
1032
1032
|
*/
|
|
1033
|
-
domainName?: string;
|
|
1033
|
+
domainName?: string | undefined;
|
|
1034
1034
|
/**
|
|
1035
1035
|
* <p>The name of the certificate that will be used by edge-optimized endpoint for this domain name.</p>
|
|
1036
1036
|
* @public
|
|
1037
1037
|
*/
|
|
1038
|
-
certificateName?: string;
|
|
1038
|
+
certificateName?: string | undefined;
|
|
1039
1039
|
/**
|
|
1040
1040
|
* <p>The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name. Certificate Manager is the only supported source.</p>
|
|
1041
1041
|
* @public
|
|
1042
1042
|
*/
|
|
1043
|
-
certificateArn?: string;
|
|
1043
|
+
certificateArn?: string | undefined;
|
|
1044
1044
|
/**
|
|
1045
1045
|
* <p>The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded. API Gateway doesn't change this value if you update the certificate.</p>
|
|
1046
1046
|
* @public
|
|
1047
1047
|
*/
|
|
1048
|
-
certificateUploadDate?: Date;
|
|
1048
|
+
certificateUploadDate?: Date | undefined;
|
|
1049
1049
|
/**
|
|
1050
1050
|
* <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>
|
|
1051
1051
|
* @public
|
|
1052
1052
|
*/
|
|
1053
|
-
regionalDomainName?: string;
|
|
1053
|
+
regionalDomainName?: string | undefined;
|
|
1054
1054
|
/**
|
|
1055
1055
|
* <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>
|
|
1056
1056
|
* @public
|
|
1057
1057
|
*/
|
|
1058
|
-
regionalHostedZoneId?: string;
|
|
1058
|
+
regionalHostedZoneId?: string | undefined;
|
|
1059
1059
|
/**
|
|
1060
1060
|
* <p>The name of the certificate that will be used for validating the regional domain name.</p>
|
|
1061
1061
|
* @public
|
|
1062
1062
|
*/
|
|
1063
|
-
regionalCertificateName?: string;
|
|
1063
|
+
regionalCertificateName?: string | undefined;
|
|
1064
1064
|
/**
|
|
1065
1065
|
* <p>The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.</p>
|
|
1066
1066
|
* @public
|
|
1067
1067
|
*/
|
|
1068
|
-
regionalCertificateArn?: string;
|
|
1068
|
+
regionalCertificateArn?: string | undefined;
|
|
1069
1069
|
/**
|
|
1070
1070
|
* <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>
|
|
1071
1071
|
* @public
|
|
1072
1072
|
*/
|
|
1073
|
-
distributionDomainName?: string;
|
|
1073
|
+
distributionDomainName?: string | undefined;
|
|
1074
1074
|
/**
|
|
1075
1075
|
* <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>
|
|
1076
1076
|
* @public
|
|
1077
1077
|
*/
|
|
1078
|
-
distributionHostedZoneId?: string;
|
|
1078
|
+
distributionHostedZoneId?: string | undefined;
|
|
1079
1079
|
/**
|
|
1080
1080
|
* <p>The endpoint configuration of this DomainName showing the endpoint types of the domain name. </p>
|
|
1081
1081
|
* @public
|
|
1082
1082
|
*/
|
|
1083
|
-
endpointConfiguration?: EndpointConfiguration;
|
|
1083
|
+
endpointConfiguration?: EndpointConfiguration | undefined;
|
|
1084
1084
|
/**
|
|
1085
1085
|
* <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>
|
|
1086
1086
|
* @public
|
|
1087
1087
|
*/
|
|
1088
|
-
domainNameStatus?: DomainNameStatus;
|
|
1088
|
+
domainNameStatus?: DomainNameStatus | undefined;
|
|
1089
1089
|
/**
|
|
1090
1090
|
* <p>An optional text message containing detailed information about status of the DomainName migration.</p>
|
|
1091
1091
|
* @public
|
|
1092
1092
|
*/
|
|
1093
|
-
domainNameStatusMessage?: string;
|
|
1093
|
+
domainNameStatusMessage?: string | undefined;
|
|
1094
1094
|
/**
|
|
1095
1095
|
* <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>
|
|
1096
1096
|
* @public
|
|
1097
1097
|
*/
|
|
1098
|
-
securityPolicy?: SecurityPolicy;
|
|
1098
|
+
securityPolicy?: SecurityPolicy | undefined;
|
|
1099
1099
|
/**
|
|
1100
1100
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
1101
1101
|
* @public
|
|
1102
1102
|
*/
|
|
1103
|
-
tags?: Record<string, string
|
|
1103
|
+
tags?: Record<string, string> | undefined;
|
|
1104
1104
|
/**
|
|
1105
1105
|
* <p>The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway
|
|
1106
1106
|
* performs two-way authentication between the client and the server. Clients must present a
|
|
1107
1107
|
* trusted certificate to access your API.</p>
|
|
1108
1108
|
* @public
|
|
1109
1109
|
*/
|
|
1110
|
-
mutualTlsAuthentication?: MutualTlsAuthentication;
|
|
1110
|
+
mutualTlsAuthentication?: MutualTlsAuthentication | undefined;
|
|
1111
1111
|
/**
|
|
1112
1112
|
* <p>The ARN of the public certificate issued by ACM to validate ownership of your custom
|
|
1113
1113
|
* domain. Only required when configuring mutual TLS and using an ACM imported or private CA
|
|
1114
1114
|
* certificate ARN as the regionalCertificateArn.</p>
|
|
1115
1115
|
* @public
|
|
1116
1116
|
*/
|
|
1117
|
-
ownershipVerificationCertificateArn?: string;
|
|
1117
|
+
ownershipVerificationCertificateArn?: string | undefined;
|
|
1118
1118
|
}
|
|
1119
1119
|
/**
|
|
1120
1120
|
* <p>Request to add a new Model to an existing RestApi resource.</p>
|
|
@@ -1135,12 +1135,12 @@ export interface CreateModelRequest {
|
|
|
1135
1135
|
* <p>The description of the model.</p>
|
|
1136
1136
|
* @public
|
|
1137
1137
|
*/
|
|
1138
|
-
description?: string;
|
|
1138
|
+
description?: string | undefined;
|
|
1139
1139
|
/**
|
|
1140
1140
|
* <p>The schema for the model. For <code>application/json</code> models, this should be JSON schema draft 4 model. The maximum size of the model is 400 KB.</p>
|
|
1141
1141
|
* @public
|
|
1142
1142
|
*/
|
|
1143
|
-
schema?: string;
|
|
1143
|
+
schema?: string | undefined;
|
|
1144
1144
|
/**
|
|
1145
1145
|
* <p>The content-type for the model.</p>
|
|
1146
1146
|
* @public
|
|
@@ -1156,27 +1156,27 @@ export interface Model {
|
|
|
1156
1156
|
* <p>The identifier for the model resource.</p>
|
|
1157
1157
|
* @public
|
|
1158
1158
|
*/
|
|
1159
|
-
id?: string;
|
|
1159
|
+
id?: string | undefined;
|
|
1160
1160
|
/**
|
|
1161
1161
|
* <p>The name of the model. Must be an alphanumeric string.</p>
|
|
1162
1162
|
* @public
|
|
1163
1163
|
*/
|
|
1164
|
-
name?: string;
|
|
1164
|
+
name?: string | undefined;
|
|
1165
1165
|
/**
|
|
1166
1166
|
* <p>The description of the model.</p>
|
|
1167
1167
|
* @public
|
|
1168
1168
|
*/
|
|
1169
|
-
description?: string;
|
|
1169
|
+
description?: string | undefined;
|
|
1170
1170
|
/**
|
|
1171
1171
|
* <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>
|
|
1172
1172
|
* @public
|
|
1173
1173
|
*/
|
|
1174
|
-
schema?: string;
|
|
1174
|
+
schema?: string | undefined;
|
|
1175
1175
|
/**
|
|
1176
1176
|
* <p>The content-type for the model.</p>
|
|
1177
1177
|
* @public
|
|
1178
1178
|
*/
|
|
1179
|
-
contentType?: string;
|
|
1179
|
+
contentType?: string | undefined;
|
|
1180
1180
|
}
|
|
1181
1181
|
/**
|
|
1182
1182
|
* <p>Creates a RequestValidator of a given RestApi.</p>
|
|
@@ -1192,17 +1192,17 @@ export interface CreateRequestValidatorRequest {
|
|
|
1192
1192
|
* <p>The name of the to-be-created RequestValidator.</p>
|
|
1193
1193
|
* @public
|
|
1194
1194
|
*/
|
|
1195
|
-
name?: string;
|
|
1195
|
+
name?: string | undefined;
|
|
1196
1196
|
/**
|
|
1197
1197
|
* <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>
|
|
1198
1198
|
* @public
|
|
1199
1199
|
*/
|
|
1200
|
-
validateRequestBody?: boolean;
|
|
1200
|
+
validateRequestBody?: boolean | undefined;
|
|
1201
1201
|
/**
|
|
1202
1202
|
* <p>A Boolean flag to indicate whether to validate request parameters, <code>true</code>, or not <code>false</code>.</p>
|
|
1203
1203
|
* @public
|
|
1204
1204
|
*/
|
|
1205
|
-
validateRequestParameters?: boolean;
|
|
1205
|
+
validateRequestParameters?: boolean | undefined;
|
|
1206
1206
|
}
|
|
1207
1207
|
/**
|
|
1208
1208
|
* <p>A set of validation rules for incoming Method requests.</p>
|
|
@@ -1213,22 +1213,22 @@ export interface RequestValidator {
|
|
|
1213
1213
|
* <p>The identifier of this RequestValidator.</p>
|
|
1214
1214
|
* @public
|
|
1215
1215
|
*/
|
|
1216
|
-
id?: string;
|
|
1216
|
+
id?: string | undefined;
|
|
1217
1217
|
/**
|
|
1218
1218
|
* <p>The name of this RequestValidator</p>
|
|
1219
1219
|
* @public
|
|
1220
1220
|
*/
|
|
1221
|
-
name?: string;
|
|
1221
|
+
name?: string | undefined;
|
|
1222
1222
|
/**
|
|
1223
1223
|
* <p>A Boolean flag to indicate whether to validate a request body according to the configured Model schema.</p>
|
|
1224
1224
|
* @public
|
|
1225
1225
|
*/
|
|
1226
|
-
validateRequestBody?: boolean;
|
|
1226
|
+
validateRequestBody?: boolean | undefined;
|
|
1227
1227
|
/**
|
|
1228
1228
|
* <p>A Boolean flag to indicate whether to validate request parameters (<code>true</code>) or not (<code>false</code>).</p>
|
|
1229
1229
|
* @public
|
|
1230
1230
|
*/
|
|
1231
|
-
validateRequestParameters?: boolean;
|
|
1231
|
+
validateRequestParameters?: boolean | undefined;
|
|
1232
1232
|
}
|
|
1233
1233
|
/**
|
|
1234
1234
|
* <p>Requests API Gateway to create a Resource resource.</p>
|
|
@@ -1284,29 +1284,29 @@ export interface IntegrationResponse {
|
|
|
1284
1284
|
* <p>Specifies the status code that is used to map the integration response to an existing MethodResponse.</p>
|
|
1285
1285
|
* @public
|
|
1286
1286
|
*/
|
|
1287
|
-
statusCode?: string;
|
|
1287
|
+
statusCode?: string | undefined;
|
|
1288
1288
|
/**
|
|
1289
1289
|
* <p>Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the <code>.+</code> regex to match error response. However, make sure that the error response does not contain any newline (<code>\n</code>) character in such cases. If the back end is an Lambda function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services back ends, the HTTP status code is matched.</p>
|
|
1290
1290
|
* @public
|
|
1291
1291
|
*/
|
|
1292
|
-
selectionPattern?: string;
|
|
1292
|
+
selectionPattern?: string | undefined;
|
|
1293
1293
|
/**
|
|
1294
1294
|
* <p>A key-value map specifying response parameters that are passed to the method response from the back end.
|
|
1295
1295
|
* 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>
|
|
1296
1296
|
* @public
|
|
1297
1297
|
*/
|
|
1298
|
-
responseParameters?: Record<string, string
|
|
1298
|
+
responseParameters?: Record<string, string> | undefined;
|
|
1299
1299
|
/**
|
|
1300
1300
|
* <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>
|
|
1301
1301
|
* @public
|
|
1302
1302
|
*/
|
|
1303
|
-
responseTemplates?: Record<string, string
|
|
1303
|
+
responseTemplates?: Record<string, string> | undefined;
|
|
1304
1304
|
/**
|
|
1305
1305
|
* <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>
|
|
1306
1306
|
* <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>
|
|
1307
1307
|
* @public
|
|
1308
1308
|
*/
|
|
1309
|
-
contentHandling?: ContentHandlingStrategy;
|
|
1309
|
+
contentHandling?: ContentHandlingStrategy | undefined;
|
|
1310
1310
|
}
|
|
1311
1311
|
/**
|
|
1312
1312
|
* <p>Specifies the TLS configuration for an integration.</p>
|
|
@@ -1327,7 +1327,7 @@ export interface TlsConfig {
|
|
|
1327
1327
|
* </important>
|
|
1328
1328
|
* @public
|
|
1329
1329
|
*/
|
|
1330
|
-
insecureSkipVerification?: boolean;
|
|
1330
|
+
insecureSkipVerification?: boolean | undefined;
|
|
1331
1331
|
}
|
|
1332
1332
|
/**
|
|
1333
1333
|
* @public
|
|
@@ -1354,12 +1354,12 @@ export interface Integration {
|
|
|
1354
1354
|
* <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>
|
|
1355
1355
|
* @public
|
|
1356
1356
|
*/
|
|
1357
|
-
type?: IntegrationType;
|
|
1357
|
+
type?: IntegrationType | undefined;
|
|
1358
1358
|
/**
|
|
1359
1359
|
* <p>Specifies the integration's HTTP method type. For the Type property, if you specify <code>MOCK</code>, this property is optional. For Lambda integrations, you must set the integration method to <code>POST</code>. For all other types, you must specify this property.</p>
|
|
1360
1360
|
* @public
|
|
1361
1361
|
*/
|
|
1362
|
-
httpMethod?: string;
|
|
1362
|
+
httpMethod?: string | undefined;
|
|
1363
1363
|
/**
|
|
1364
1364
|
* <p>Specifies Uniform Resource Identifier (URI) of the integration endpoint.</p>
|
|
1365
1365
|
* <p>For <code>HTTP</code> or <code>HTTP_PROXY</code> integrations, the URI must be a fully formed, encoded HTTP(S) URL
|
|
@@ -1379,32 +1379,32 @@ export interface Integration {
|
|
|
1379
1379
|
* </p>
|
|
1380
1380
|
* @public
|
|
1381
1381
|
*/
|
|
1382
|
-
uri?: string;
|
|
1382
|
+
uri?: string | undefined;
|
|
1383
1383
|
/**
|
|
1384
1384
|
* <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>
|
|
1385
1385
|
* @public
|
|
1386
1386
|
*/
|
|
1387
|
-
connectionType?: ConnectionType;
|
|
1387
|
+
connectionType?: ConnectionType | undefined;
|
|
1388
1388
|
/**
|
|
1389
1389
|
* <p>The ID of the VpcLink used for the integration when <code>connectionType=VPC_LINK</code> and undefined, otherwise.</p>
|
|
1390
1390
|
* @public
|
|
1391
1391
|
*/
|
|
1392
|
-
connectionId?: string;
|
|
1392
|
+
connectionId?: string | undefined;
|
|
1393
1393
|
/**
|
|
1394
1394
|
* <p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string <code>arn:aws:iam::\*:user/\*</code>. To use resource-based permissions on supported Amazon Web Services services, specify null.</p>
|
|
1395
1395
|
* @public
|
|
1396
1396
|
*/
|
|
1397
|
-
credentials?: string;
|
|
1397
|
+
credentials?: string | undefined;
|
|
1398
1398
|
/**
|
|
1399
1399
|
* <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>
|
|
1400
1400
|
* @public
|
|
1401
1401
|
*/
|
|
1402
|
-
requestParameters?: Record<string, string
|
|
1402
|
+
requestParameters?: Record<string, string> | undefined;
|
|
1403
1403
|
/**
|
|
1404
1404
|
* <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>
|
|
1405
1405
|
* @public
|
|
1406
1406
|
*/
|
|
1407
|
-
requestTemplates?: Record<string, string
|
|
1407
|
+
requestTemplates?: Record<string, string> | undefined;
|
|
1408
1408
|
/**
|
|
1409
1409
|
* <p>Specifies how the method request body of an unmapped content type will be passed through
|
|
1410
1410
|
* the integration request to the back end without transformation. A content type is unmapped if
|
|
@@ -1423,38 +1423,38 @@ export interface Integration {
|
|
|
1423
1423
|
* request.</p>
|
|
1424
1424
|
* @public
|
|
1425
1425
|
*/
|
|
1426
|
-
passthroughBehavior?: string;
|
|
1426
|
+
passthroughBehavior?: string | undefined;
|
|
1427
1427
|
/**
|
|
1428
1428
|
* <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>
|
|
1429
1429
|
* <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>
|
|
1430
1430
|
* @public
|
|
1431
1431
|
*/
|
|
1432
|
-
contentHandling?: ContentHandlingStrategy;
|
|
1432
|
+
contentHandling?: ContentHandlingStrategy | undefined;
|
|
1433
1433
|
/**
|
|
1434
1434
|
* <p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.</p>
|
|
1435
1435
|
* @public
|
|
1436
1436
|
*/
|
|
1437
|
-
timeoutInMillis?: number;
|
|
1437
|
+
timeoutInMillis?: number | undefined;
|
|
1438
1438
|
/**
|
|
1439
1439
|
* <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>
|
|
1440
1440
|
* @public
|
|
1441
1441
|
*/
|
|
1442
|
-
cacheNamespace?: string;
|
|
1442
|
+
cacheNamespace?: string | undefined;
|
|
1443
1443
|
/**
|
|
1444
1444
|
* <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>
|
|
1445
1445
|
* @public
|
|
1446
1446
|
*/
|
|
1447
|
-
cacheKeyParameters?: string[];
|
|
1447
|
+
cacheKeyParameters?: string[] | undefined;
|
|
1448
1448
|
/**
|
|
1449
1449
|
* <p>Specifies the integration's responses.</p>
|
|
1450
1450
|
* @public
|
|
1451
1451
|
*/
|
|
1452
|
-
integrationResponses?: Record<string, IntegrationResponse
|
|
1452
|
+
integrationResponses?: Record<string, IntegrationResponse> | undefined;
|
|
1453
1453
|
/**
|
|
1454
1454
|
* <p>Specifies the TLS configuration for an integration.</p>
|
|
1455
1455
|
* @public
|
|
1456
1456
|
*/
|
|
1457
|
-
tlsConfig?: TlsConfig;
|
|
1457
|
+
tlsConfig?: TlsConfig | undefined;
|
|
1458
1458
|
}
|
|
1459
1459
|
/**
|
|
1460
1460
|
* <p>Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template. </p>
|
|
@@ -1465,17 +1465,17 @@ export interface MethodResponse {
|
|
|
1465
1465
|
* <p>The method response's status code.</p>
|
|
1466
1466
|
* @public
|
|
1467
1467
|
*/
|
|
1468
|
-
statusCode?: string;
|
|
1468
|
+
statusCode?: string | undefined;
|
|
1469
1469
|
/**
|
|
1470
1470
|
* <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>
|
|
1471
1471
|
* @public
|
|
1472
1472
|
*/
|
|
1473
|
-
responseParameters?: Record<string, boolean
|
|
1473
|
+
responseParameters?: Record<string, boolean> | undefined;
|
|
1474
1474
|
/**
|
|
1475
1475
|
* <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>
|
|
1476
1476
|
* @public
|
|
1477
1477
|
*/
|
|
1478
|
-
responseModels?: Record<string, string
|
|
1478
|
+
responseModels?: Record<string, string> | undefined;
|
|
1479
1479
|
}
|
|
1480
1480
|
/**
|
|
1481
1481
|
* <p>
|
|
@@ -1493,57 +1493,57 @@ export interface Method {
|
|
|
1493
1493
|
* <p>The method's HTTP verb.</p>
|
|
1494
1494
|
* @public
|
|
1495
1495
|
*/
|
|
1496
|
-
httpMethod?: string;
|
|
1496
|
+
httpMethod?: string | undefined;
|
|
1497
1497
|
/**
|
|
1498
1498
|
* <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>
|
|
1499
1499
|
* @public
|
|
1500
1500
|
*/
|
|
1501
|
-
authorizationType?: string;
|
|
1501
|
+
authorizationType?: string | undefined;
|
|
1502
1502
|
/**
|
|
1503
1503
|
* <p>The identifier of an Authorizer to use on this method. The <code>authorizationType</code> must be <code>CUSTOM</code>.</p>
|
|
1504
1504
|
* @public
|
|
1505
1505
|
*/
|
|
1506
|
-
authorizerId?: string;
|
|
1506
|
+
authorizerId?: string | undefined;
|
|
1507
1507
|
/**
|
|
1508
1508
|
* <p>A boolean flag specifying whether a valid ApiKey is required to invoke this method.</p>
|
|
1509
1509
|
* @public
|
|
1510
1510
|
*/
|
|
1511
|
-
apiKeyRequired?: boolean;
|
|
1511
|
+
apiKeyRequired?: boolean | undefined;
|
|
1512
1512
|
/**
|
|
1513
1513
|
* <p>The identifier of a RequestValidator for request validation.</p>
|
|
1514
1514
|
* @public
|
|
1515
1515
|
*/
|
|
1516
|
-
requestValidatorId?: string;
|
|
1516
|
+
requestValidatorId?: string | undefined;
|
|
1517
1517
|
/**
|
|
1518
1518
|
* <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>
|
|
1519
1519
|
* @public
|
|
1520
1520
|
*/
|
|
1521
|
-
operationName?: string;
|
|
1521
|
+
operationName?: string | undefined;
|
|
1522
1522
|
/**
|
|
1523
1523
|
* <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>
|
|
1524
1524
|
* @public
|
|
1525
1525
|
*/
|
|
1526
|
-
requestParameters?: Record<string, boolean
|
|
1526
|
+
requestParameters?: Record<string, boolean> | undefined;
|
|
1527
1527
|
/**
|
|
1528
1528
|
* <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>
|
|
1529
1529
|
* @public
|
|
1530
1530
|
*/
|
|
1531
|
-
requestModels?: Record<string, string
|
|
1531
|
+
requestModels?: Record<string, string> | undefined;
|
|
1532
1532
|
/**
|
|
1533
1533
|
* <p>Gets a method response associated with a given HTTP status code. </p>
|
|
1534
1534
|
* @public
|
|
1535
1535
|
*/
|
|
1536
|
-
methodResponses?: Record<string, MethodResponse
|
|
1536
|
+
methodResponses?: Record<string, MethodResponse> | undefined;
|
|
1537
1537
|
/**
|
|
1538
1538
|
* <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>
|
|
1539
1539
|
* @public
|
|
1540
1540
|
*/
|
|
1541
|
-
methodIntegration?: Integration;
|
|
1541
|
+
methodIntegration?: Integration | undefined;
|
|
1542
1542
|
/**
|
|
1543
1543
|
* <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>
|
|
1544
1544
|
* @public
|
|
1545
1545
|
*/
|
|
1546
|
-
authorizationScopes?: string[];
|
|
1546
|
+
authorizationScopes?: string[] | undefined;
|
|
1547
1547
|
}
|
|
1548
1548
|
/**
|
|
1549
1549
|
* <p>Represents an API resource.</p>
|
|
@@ -1554,27 +1554,27 @@ export interface Resource {
|
|
|
1554
1554
|
* <p>The resource's identifier.</p>
|
|
1555
1555
|
* @public
|
|
1556
1556
|
*/
|
|
1557
|
-
id?: string;
|
|
1557
|
+
id?: string | undefined;
|
|
1558
1558
|
/**
|
|
1559
1559
|
* <p>The parent resource's identifier.</p>
|
|
1560
1560
|
* @public
|
|
1561
1561
|
*/
|
|
1562
|
-
parentId?: string;
|
|
1562
|
+
parentId?: string | undefined;
|
|
1563
1563
|
/**
|
|
1564
1564
|
* <p>The last path segment for this resource.</p>
|
|
1565
1565
|
* @public
|
|
1566
1566
|
*/
|
|
1567
|
-
pathPart?: string;
|
|
1567
|
+
pathPart?: string | undefined;
|
|
1568
1568
|
/**
|
|
1569
1569
|
* <p>The full path for this resource.</p>
|
|
1570
1570
|
* @public
|
|
1571
1571
|
*/
|
|
1572
|
-
path?: string;
|
|
1572
|
+
path?: string | undefined;
|
|
1573
1573
|
/**
|
|
1574
1574
|
* <p>Gets an API resource's method of a given HTTP verb.</p>
|
|
1575
1575
|
* @public
|
|
1576
1576
|
*/
|
|
1577
|
-
resourceMethods?: Record<string, Method
|
|
1577
|
+
resourceMethods?: Record<string, Method> | undefined;
|
|
1578
1578
|
}
|
|
1579
1579
|
/**
|
|
1580
1580
|
* <p>The POST Request to add a new RestApi resource to your collection.</p>
|
|
@@ -1590,27 +1590,27 @@ export interface CreateRestApiRequest {
|
|
|
1590
1590
|
* <p>The description of the RestApi.</p>
|
|
1591
1591
|
* @public
|
|
1592
1592
|
*/
|
|
1593
|
-
description?: string;
|
|
1593
|
+
description?: string | undefined;
|
|
1594
1594
|
/**
|
|
1595
1595
|
* <p>A version identifier for the API.</p>
|
|
1596
1596
|
* @public
|
|
1597
1597
|
*/
|
|
1598
|
-
version?: string;
|
|
1598
|
+
version?: string | undefined;
|
|
1599
1599
|
/**
|
|
1600
1600
|
* <p>The ID of the RestApi that you want to clone from.</p>
|
|
1601
1601
|
* @public
|
|
1602
1602
|
*/
|
|
1603
|
-
cloneFrom?: string;
|
|
1603
|
+
cloneFrom?: string | undefined;
|
|
1604
1604
|
/**
|
|
1605
1605
|
* <p>The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.</p>
|
|
1606
1606
|
* @public
|
|
1607
1607
|
*/
|
|
1608
|
-
binaryMediaTypes?: string[];
|
|
1608
|
+
binaryMediaTypes?: string[] | undefined;
|
|
1609
1609
|
/**
|
|
1610
1610
|
* <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>
|
|
1611
1611
|
* @public
|
|
1612
1612
|
*/
|
|
1613
|
-
minimumCompressionSize?: number;
|
|
1613
|
+
minimumCompressionSize?: number | undefined;
|
|
1614
1614
|
/**
|
|
1615
1615
|
* <p>The source of the API key for metering requests according to a usage plan. Valid values
|
|
1616
1616
|
* are: <code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a
|
|
@@ -1618,22 +1618,22 @@ export interface CreateRestApiRequest {
|
|
|
1618
1618
|
* from a custom authorizer.</p>
|
|
1619
1619
|
* @public
|
|
1620
1620
|
*/
|
|
1621
|
-
apiKeySource?: ApiKeySourceType;
|
|
1621
|
+
apiKeySource?: ApiKeySourceType | undefined;
|
|
1622
1622
|
/**
|
|
1623
1623
|
* <p>The endpoint configuration of this RestApi showing the endpoint types of the API. </p>
|
|
1624
1624
|
* @public
|
|
1625
1625
|
*/
|
|
1626
|
-
endpointConfiguration?: EndpointConfiguration;
|
|
1626
|
+
endpointConfiguration?: EndpointConfiguration | undefined;
|
|
1627
1627
|
/**
|
|
1628
1628
|
* <p>A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.</p>
|
|
1629
1629
|
* @public
|
|
1630
1630
|
*/
|
|
1631
|
-
policy?: string;
|
|
1631
|
+
policy?: string | undefined;
|
|
1632
1632
|
/**
|
|
1633
1633
|
* <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>
|
|
1634
1634
|
* @public
|
|
1635
1635
|
*/
|
|
1636
|
-
tags?: Record<string, string
|
|
1636
|
+
tags?: Record<string, string> | undefined;
|
|
1637
1637
|
/**
|
|
1638
1638
|
* <p>Specifies whether clients can invoke your API by using the default <code>execute-api</code> endpoint.
|
|
1639
1639
|
* By default, clients can invoke your API with the default
|
|
@@ -1641,7 +1641,7 @@ export interface CreateRestApiRequest {
|
|
|
1641
1641
|
* custom domain name to invoke your API, disable the default endpoint</p>
|
|
1642
1642
|
* @public
|
|
1643
1643
|
*/
|
|
1644
|
-
disableExecuteApiEndpoint?: boolean;
|
|
1644
|
+
disableExecuteApiEndpoint?: boolean | undefined;
|
|
1645
1645
|
}
|
|
1646
1646
|
/**
|
|
1647
1647
|
* <p>Represents a REST API.</p>
|
|
@@ -1652,42 +1652,42 @@ export interface RestApi {
|
|
|
1652
1652
|
* <p>The API's identifier. This identifier is unique across all of your APIs in API Gateway.</p>
|
|
1653
1653
|
* @public
|
|
1654
1654
|
*/
|
|
1655
|
-
id?: string;
|
|
1655
|
+
id?: string | undefined;
|
|
1656
1656
|
/**
|
|
1657
1657
|
* <p>The API's name.</p>
|
|
1658
1658
|
* @public
|
|
1659
1659
|
*/
|
|
1660
|
-
name?: string;
|
|
1660
|
+
name?: string | undefined;
|
|
1661
1661
|
/**
|
|
1662
1662
|
* <p>The API's description.</p>
|
|
1663
1663
|
* @public
|
|
1664
1664
|
*/
|
|
1665
|
-
description?: string;
|
|
1665
|
+
description?: string | undefined;
|
|
1666
1666
|
/**
|
|
1667
1667
|
* <p>The timestamp when the API was created.</p>
|
|
1668
1668
|
* @public
|
|
1669
1669
|
*/
|
|
1670
|
-
createdDate?: Date;
|
|
1670
|
+
createdDate?: Date | undefined;
|
|
1671
1671
|
/**
|
|
1672
1672
|
* <p>A version identifier for the API.</p>
|
|
1673
1673
|
* @public
|
|
1674
1674
|
*/
|
|
1675
|
-
version?: string;
|
|
1675
|
+
version?: string | undefined;
|
|
1676
1676
|
/**
|
|
1677
1677
|
* <p>The warning messages reported when <code>failonwarnings</code> is turned on during API import.</p>
|
|
1678
1678
|
* @public
|
|
1679
1679
|
*/
|
|
1680
|
-
warnings?: string[];
|
|
1680
|
+
warnings?: string[] | undefined;
|
|
1681
1681
|
/**
|
|
1682
1682
|
* <p>The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.</p>
|
|
1683
1683
|
* @public
|
|
1684
1684
|
*/
|
|
1685
|
-
binaryMediaTypes?: string[];
|
|
1685
|
+
binaryMediaTypes?: string[] | undefined;
|
|
1686
1686
|
/**
|
|
1687
1687
|
* <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>
|
|
1688
1688
|
* @public
|
|
1689
1689
|
*/
|
|
1690
|
-
minimumCompressionSize?: number;
|
|
1690
|
+
minimumCompressionSize?: number | undefined;
|
|
1691
1691
|
/**
|
|
1692
1692
|
* <p>The source of the API key for metering requests according to a usage plan. Valid values
|
|
1693
1693
|
* are: ><code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a
|
|
@@ -1695,22 +1695,22 @@ export interface RestApi {
|
|
|
1695
1695
|
* from a custom authorizer.</p>
|
|
1696
1696
|
* @public
|
|
1697
1697
|
*/
|
|
1698
|
-
apiKeySource?: ApiKeySourceType;
|
|
1698
|
+
apiKeySource?: ApiKeySourceType | undefined;
|
|
1699
1699
|
/**
|
|
1700
1700
|
* <p>The endpoint configuration of this RestApi showing the endpoint types of the API. </p>
|
|
1701
1701
|
* @public
|
|
1702
1702
|
*/
|
|
1703
|
-
endpointConfiguration?: EndpointConfiguration;
|
|
1703
|
+
endpointConfiguration?: EndpointConfiguration | undefined;
|
|
1704
1704
|
/**
|
|
1705
1705
|
* <p>A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.</p>
|
|
1706
1706
|
* @public
|
|
1707
1707
|
*/
|
|
1708
|
-
policy?: string;
|
|
1708
|
+
policy?: string | undefined;
|
|
1709
1709
|
/**
|
|
1710
1710
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
1711
1711
|
* @public
|
|
1712
1712
|
*/
|
|
1713
|
-
tags?: Record<string, string
|
|
1713
|
+
tags?: Record<string, string> | undefined;
|
|
1714
1714
|
/**
|
|
1715
1715
|
* <p>Specifies whether clients can invoke your API by using the default <code>execute-api</code> endpoint.
|
|
1716
1716
|
* By default, clients can invoke your API with the default
|
|
@@ -1718,12 +1718,12 @@ export interface RestApi {
|
|
|
1718
1718
|
* custom domain name to invoke your API, disable the default endpoint.</p>
|
|
1719
1719
|
* @public
|
|
1720
1720
|
*/
|
|
1721
|
-
disableExecuteApiEndpoint?: boolean;
|
|
1721
|
+
disableExecuteApiEndpoint?: boolean | undefined;
|
|
1722
1722
|
/**
|
|
1723
1723
|
* <p>The API's root resource ID.</p>
|
|
1724
1724
|
* @public
|
|
1725
1725
|
*/
|
|
1726
|
-
rootResourceId?: string;
|
|
1726
|
+
rootResourceId?: string | undefined;
|
|
1727
1727
|
}
|
|
1728
1728
|
/**
|
|
1729
1729
|
* <p>Configuration settings of a canary deployment.</p>
|
|
@@ -1734,22 +1734,22 @@ export interface CanarySettings {
|
|
|
1734
1734
|
* <p>The percent (0-100) of traffic diverted to a canary deployment.</p>
|
|
1735
1735
|
* @public
|
|
1736
1736
|
*/
|
|
1737
|
-
percentTraffic?: number;
|
|
1737
|
+
percentTraffic?: number | undefined;
|
|
1738
1738
|
/**
|
|
1739
1739
|
* <p>The ID of the canary deployment.</p>
|
|
1740
1740
|
* @public
|
|
1741
1741
|
*/
|
|
1742
|
-
deploymentId?: string;
|
|
1742
|
+
deploymentId?: string | undefined;
|
|
1743
1743
|
/**
|
|
1744
1744
|
* <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>
|
|
1745
1745
|
* @public
|
|
1746
1746
|
*/
|
|
1747
|
-
stageVariableOverrides?: Record<string, string
|
|
1747
|
+
stageVariableOverrides?: Record<string, string> | undefined;
|
|
1748
1748
|
/**
|
|
1749
1749
|
* <p>A Boolean flag to indicate whether the canary deployment uses the stage cache or not.</p>
|
|
1750
1750
|
* @public
|
|
1751
1751
|
*/
|
|
1752
|
-
useStageCache?: boolean;
|
|
1752
|
+
useStageCache?: boolean | undefined;
|
|
1753
1753
|
}
|
|
1754
1754
|
/**
|
|
1755
1755
|
* <p>Requests API Gateway to create a Stage resource.</p>
|
|
@@ -1775,44 +1775,44 @@ export interface CreateStageRequest {
|
|
|
1775
1775
|
* <p>The description of the Stage resource.</p>
|
|
1776
1776
|
* @public
|
|
1777
1777
|
*/
|
|
1778
|
-
description?: string;
|
|
1778
|
+
description?: string | undefined;
|
|
1779
1779
|
/**
|
|
1780
1780
|
* <p>Whether cache clustering is enabled for the stage.</p>
|
|
1781
1781
|
* @public
|
|
1782
1782
|
*/
|
|
1783
|
-
cacheClusterEnabled?: boolean;
|
|
1783
|
+
cacheClusterEnabled?: boolean | undefined;
|
|
1784
1784
|
/**
|
|
1785
1785
|
* <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>
|
|
1786
1786
|
* @public
|
|
1787
1787
|
*/
|
|
1788
|
-
cacheClusterSize?: CacheClusterSize;
|
|
1788
|
+
cacheClusterSize?: CacheClusterSize | undefined;
|
|
1789
1789
|
/**
|
|
1790
1790
|
* <p>A map that defines the stage variables for the new Stage resource. Variable names
|
|
1791
1791
|
* can have alphanumeric and underscore characters, and the values must match
|
|
1792
1792
|
* <code>[A-Za-z0-9-._~:/?#&=,]+</code>.</p>
|
|
1793
1793
|
* @public
|
|
1794
1794
|
*/
|
|
1795
|
-
variables?: Record<string, string
|
|
1795
|
+
variables?: Record<string, string> | undefined;
|
|
1796
1796
|
/**
|
|
1797
1797
|
* <p>The version of the associated API documentation.</p>
|
|
1798
1798
|
* @public
|
|
1799
1799
|
*/
|
|
1800
|
-
documentationVersion?: string;
|
|
1800
|
+
documentationVersion?: string | undefined;
|
|
1801
1801
|
/**
|
|
1802
1802
|
* <p>The canary deployment settings of this stage.</p>
|
|
1803
1803
|
* @public
|
|
1804
1804
|
*/
|
|
1805
|
-
canarySettings?: CanarySettings;
|
|
1805
|
+
canarySettings?: CanarySettings | undefined;
|
|
1806
1806
|
/**
|
|
1807
1807
|
* <p>Specifies whether active tracing with X-ray is enabled for the Stage.</p>
|
|
1808
1808
|
* @public
|
|
1809
1809
|
*/
|
|
1810
|
-
tracingEnabled?: boolean;
|
|
1810
|
+
tracingEnabled?: boolean | undefined;
|
|
1811
1811
|
/**
|
|
1812
1812
|
* <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>
|
|
1813
1813
|
* @public
|
|
1814
1814
|
*/
|
|
1815
|
-
tags?: Record<string, string
|
|
1815
|
+
tags?: Record<string, string> | undefined;
|
|
1816
1816
|
}
|
|
1817
1817
|
/**
|
|
1818
1818
|
* @public
|
|
@@ -1851,52 +1851,52 @@ export interface MethodSetting {
|
|
|
1851
1851
|
* <p>Specifies whether Amazon CloudWatch metrics are enabled for this method.</p>
|
|
1852
1852
|
* @public
|
|
1853
1853
|
*/
|
|
1854
|
-
metricsEnabled?: boolean;
|
|
1854
|
+
metricsEnabled?: boolean | undefined;
|
|
1855
1855
|
/**
|
|
1856
1856
|
* <p>Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are <code>OFF</code>, <code>ERROR</code>, and <code>INFO</code>. Choose <code>ERROR</code> to write only error-level entries to CloudWatch Logs, or choose <code>INFO</code> to include all <code>ERROR</code> events as well as extra informational events.</p>
|
|
1857
1857
|
* @public
|
|
1858
1858
|
*/
|
|
1859
|
-
loggingLevel?: string;
|
|
1859
|
+
loggingLevel?: string | undefined;
|
|
1860
1860
|
/**
|
|
1861
1861
|
* <p>Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.</p>
|
|
1862
1862
|
* @public
|
|
1863
1863
|
*/
|
|
1864
|
-
dataTraceEnabled?: boolean;
|
|
1864
|
+
dataTraceEnabled?: boolean | undefined;
|
|
1865
1865
|
/**
|
|
1866
1866
|
* <p>Specifies the throttling burst limit.</p>
|
|
1867
1867
|
* @public
|
|
1868
1868
|
*/
|
|
1869
|
-
throttlingBurstLimit?: number;
|
|
1869
|
+
throttlingBurstLimit?: number | undefined;
|
|
1870
1870
|
/**
|
|
1871
1871
|
* <p>Specifies the throttling rate limit.</p>
|
|
1872
1872
|
* @public
|
|
1873
1873
|
*/
|
|
1874
|
-
throttlingRateLimit?: number;
|
|
1874
|
+
throttlingRateLimit?: number | undefined;
|
|
1875
1875
|
/**
|
|
1876
1876
|
* <p>Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.</p>
|
|
1877
1877
|
* @public
|
|
1878
1878
|
*/
|
|
1879
|
-
cachingEnabled?: boolean;
|
|
1879
|
+
cachingEnabled?: boolean | undefined;
|
|
1880
1880
|
/**
|
|
1881
1881
|
* <p>Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.</p>
|
|
1882
1882
|
* @public
|
|
1883
1883
|
*/
|
|
1884
|
-
cacheTtlInSeconds?: number;
|
|
1884
|
+
cacheTtlInSeconds?: number | undefined;
|
|
1885
1885
|
/**
|
|
1886
1886
|
* <p>Specifies whether the cached responses are encrypted.</p>
|
|
1887
1887
|
* @public
|
|
1888
1888
|
*/
|
|
1889
|
-
cacheDataEncrypted?: boolean;
|
|
1889
|
+
cacheDataEncrypted?: boolean | undefined;
|
|
1890
1890
|
/**
|
|
1891
1891
|
* <p>Specifies whether authorization is required for a cache invalidation request.</p>
|
|
1892
1892
|
* @public
|
|
1893
1893
|
*/
|
|
1894
|
-
requireAuthorizationForCacheControl?: boolean;
|
|
1894
|
+
requireAuthorizationForCacheControl?: boolean | undefined;
|
|
1895
1895
|
/**
|
|
1896
1896
|
* <p>Specifies how to handle unauthorized requests for cache invalidation.</p>
|
|
1897
1897
|
* @public
|
|
1898
1898
|
*/
|
|
1899
|
-
unauthorizedCacheControlHeaderStrategy?: UnauthorizedCacheControlHeaderStrategy;
|
|
1899
|
+
unauthorizedCacheControlHeaderStrategy?: UnauthorizedCacheControlHeaderStrategy | undefined;
|
|
1900
1900
|
}
|
|
1901
1901
|
/**
|
|
1902
1902
|
* <p>Represents a unique identifier for a version of a deployed RestApi that is callable by users.</p>
|
|
@@ -1907,88 +1907,88 @@ export interface Stage {
|
|
|
1907
1907
|
* <p>The identifier of the Deployment that the stage points to.</p>
|
|
1908
1908
|
* @public
|
|
1909
1909
|
*/
|
|
1910
|
-
deploymentId?: string;
|
|
1910
|
+
deploymentId?: string | undefined;
|
|
1911
1911
|
/**
|
|
1912
1912
|
* <p>The identifier of a client certificate for an API stage.</p>
|
|
1913
1913
|
* @public
|
|
1914
1914
|
*/
|
|
1915
|
-
clientCertificateId?: string;
|
|
1915
|
+
clientCertificateId?: string | undefined;
|
|
1916
1916
|
/**
|
|
1917
1917
|
* <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>
|
|
1918
1918
|
* @public
|
|
1919
1919
|
*/
|
|
1920
|
-
stageName?: string;
|
|
1920
|
+
stageName?: string | undefined;
|
|
1921
1921
|
/**
|
|
1922
1922
|
* <p>The stage's description.</p>
|
|
1923
1923
|
* @public
|
|
1924
1924
|
*/
|
|
1925
|
-
description?: string;
|
|
1925
|
+
description?: string | undefined;
|
|
1926
1926
|
/**
|
|
1927
1927
|
* <p>Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set <code>CachingEnabled</code> to <code>true</code> for a method. </p>
|
|
1928
1928
|
* @public
|
|
1929
1929
|
*/
|
|
1930
|
-
cacheClusterEnabled?: boolean;
|
|
1930
|
+
cacheClusterEnabled?: boolean | undefined;
|
|
1931
1931
|
/**
|
|
1932
1932
|
* <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>
|
|
1933
1933
|
* @public
|
|
1934
1934
|
*/
|
|
1935
|
-
cacheClusterSize?: CacheClusterSize;
|
|
1935
|
+
cacheClusterSize?: CacheClusterSize | undefined;
|
|
1936
1936
|
/**
|
|
1937
1937
|
* <p>The status of the cache cluster for the stage, if enabled.</p>
|
|
1938
1938
|
* @public
|
|
1939
1939
|
*/
|
|
1940
|
-
cacheClusterStatus?: CacheClusterStatus;
|
|
1940
|
+
cacheClusterStatus?: CacheClusterStatus | undefined;
|
|
1941
1941
|
/**
|
|
1942
1942
|
* <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>
|
|
1943
1943
|
* @public
|
|
1944
1944
|
*/
|
|
1945
|
-
methodSettings?: Record<string, MethodSetting
|
|
1945
|
+
methodSettings?: Record<string, MethodSetting> | undefined;
|
|
1946
1946
|
/**
|
|
1947
1947
|
* <p>A map that defines the stage variables for a Stage resource. Variable names can
|
|
1948
1948
|
* have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&=,]+</code>.</p>
|
|
1949
1949
|
* @public
|
|
1950
1950
|
*/
|
|
1951
|
-
variables?: Record<string, string
|
|
1951
|
+
variables?: Record<string, string> | undefined;
|
|
1952
1952
|
/**
|
|
1953
1953
|
* <p>The version of the associated API documentation.</p>
|
|
1954
1954
|
* @public
|
|
1955
1955
|
*/
|
|
1956
|
-
documentationVersion?: string;
|
|
1956
|
+
documentationVersion?: string | undefined;
|
|
1957
1957
|
/**
|
|
1958
1958
|
* <p>Settings for logging access in this stage.</p>
|
|
1959
1959
|
* @public
|
|
1960
1960
|
*/
|
|
1961
|
-
accessLogSettings?: AccessLogSettings;
|
|
1961
|
+
accessLogSettings?: AccessLogSettings | undefined;
|
|
1962
1962
|
/**
|
|
1963
1963
|
* <p>Settings for the canary deployment in this stage.</p>
|
|
1964
1964
|
* @public
|
|
1965
1965
|
*/
|
|
1966
|
-
canarySettings?: CanarySettings;
|
|
1966
|
+
canarySettings?: CanarySettings | undefined;
|
|
1967
1967
|
/**
|
|
1968
1968
|
* <p>Specifies whether active tracing with X-ray is enabled for the Stage.</p>
|
|
1969
1969
|
* @public
|
|
1970
1970
|
*/
|
|
1971
|
-
tracingEnabled?: boolean;
|
|
1971
|
+
tracingEnabled?: boolean | undefined;
|
|
1972
1972
|
/**
|
|
1973
1973
|
* <p>The ARN of the WebAcl associated with the Stage.</p>
|
|
1974
1974
|
* @public
|
|
1975
1975
|
*/
|
|
1976
|
-
webAclArn?: string;
|
|
1976
|
+
webAclArn?: string | undefined;
|
|
1977
1977
|
/**
|
|
1978
1978
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
1979
1979
|
* @public
|
|
1980
1980
|
*/
|
|
1981
|
-
tags?: Record<string, string
|
|
1981
|
+
tags?: Record<string, string> | undefined;
|
|
1982
1982
|
/**
|
|
1983
1983
|
* <p>The timestamp when the stage was created.</p>
|
|
1984
1984
|
* @public
|
|
1985
1985
|
*/
|
|
1986
|
-
createdDate?: Date;
|
|
1986
|
+
createdDate?: Date | undefined;
|
|
1987
1987
|
/**
|
|
1988
1988
|
* <p>The timestamp when the stage last updated.</p>
|
|
1989
1989
|
* @public
|
|
1990
1990
|
*/
|
|
1991
|
-
lastUpdatedDate?: Date;
|
|
1991
|
+
lastUpdatedDate?: Date | undefined;
|
|
1992
1992
|
}
|
|
1993
1993
|
/**
|
|
1994
1994
|
* @public
|
|
@@ -2012,17 +2012,17 @@ export interface QuotaSettings {
|
|
|
2012
2012
|
* <p>The target maximum number of requests that can be made in a given time period.</p>
|
|
2013
2013
|
* @public
|
|
2014
2014
|
*/
|
|
2015
|
-
limit?: number;
|
|
2015
|
+
limit?: number | undefined;
|
|
2016
2016
|
/**
|
|
2017
2017
|
* <p>The number of requests subtracted from the given limit in the initial time period.</p>
|
|
2018
2018
|
* @public
|
|
2019
2019
|
*/
|
|
2020
|
-
offset?: number;
|
|
2020
|
+
offset?: number | undefined;
|
|
2021
2021
|
/**
|
|
2022
2022
|
* <p>The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".</p>
|
|
2023
2023
|
* @public
|
|
2024
2024
|
*/
|
|
2025
|
-
period?: QuotaPeriodType;
|
|
2025
|
+
period?: QuotaPeriodType | undefined;
|
|
2026
2026
|
}
|
|
2027
2027
|
/**
|
|
2028
2028
|
* <p>The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.</p>
|
|
@@ -2038,27 +2038,27 @@ export interface CreateUsagePlanRequest {
|
|
|
2038
2038
|
* <p>The description of the usage plan.</p>
|
|
2039
2039
|
* @public
|
|
2040
2040
|
*/
|
|
2041
|
-
description?: string;
|
|
2041
|
+
description?: string | undefined;
|
|
2042
2042
|
/**
|
|
2043
2043
|
* <p>The associated API stages of the usage plan.</p>
|
|
2044
2044
|
* @public
|
|
2045
2045
|
*/
|
|
2046
|
-
apiStages?: ApiStage[];
|
|
2046
|
+
apiStages?: ApiStage[] | undefined;
|
|
2047
2047
|
/**
|
|
2048
2048
|
* <p>The throttling limits of the usage plan.</p>
|
|
2049
2049
|
* @public
|
|
2050
2050
|
*/
|
|
2051
|
-
throttle?: ThrottleSettings;
|
|
2051
|
+
throttle?: ThrottleSettings | undefined;
|
|
2052
2052
|
/**
|
|
2053
2053
|
* <p>The quota of the usage plan.</p>
|
|
2054
2054
|
* @public
|
|
2055
2055
|
*/
|
|
2056
|
-
quota?: QuotaSettings;
|
|
2056
|
+
quota?: QuotaSettings | undefined;
|
|
2057
2057
|
/**
|
|
2058
2058
|
* <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>
|
|
2059
2059
|
* @public
|
|
2060
2060
|
*/
|
|
2061
|
-
tags?: Record<string, string
|
|
2061
|
+
tags?: Record<string, string> | undefined;
|
|
2062
2062
|
}
|
|
2063
2063
|
/**
|
|
2064
2064
|
* <p>Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set.
|
|
@@ -2072,42 +2072,42 @@ export interface UsagePlan {
|
|
|
2072
2072
|
* <p>The identifier of a UsagePlan resource.</p>
|
|
2073
2073
|
* @public
|
|
2074
2074
|
*/
|
|
2075
|
-
id?: string;
|
|
2075
|
+
id?: string | undefined;
|
|
2076
2076
|
/**
|
|
2077
2077
|
* <p>The name of a usage plan.</p>
|
|
2078
2078
|
* @public
|
|
2079
2079
|
*/
|
|
2080
|
-
name?: string;
|
|
2080
|
+
name?: string | undefined;
|
|
2081
2081
|
/**
|
|
2082
2082
|
* <p>The description of a usage plan.</p>
|
|
2083
2083
|
* @public
|
|
2084
2084
|
*/
|
|
2085
|
-
description?: string;
|
|
2085
|
+
description?: string | undefined;
|
|
2086
2086
|
/**
|
|
2087
2087
|
* <p>The associated API stages of a usage plan.</p>
|
|
2088
2088
|
* @public
|
|
2089
2089
|
*/
|
|
2090
|
-
apiStages?: ApiStage[];
|
|
2090
|
+
apiStages?: ApiStage[] | undefined;
|
|
2091
2091
|
/**
|
|
2092
2092
|
* <p>A map containing method level throttling information for API stage in a usage plan.</p>
|
|
2093
2093
|
* @public
|
|
2094
2094
|
*/
|
|
2095
|
-
throttle?: ThrottleSettings;
|
|
2095
|
+
throttle?: ThrottleSettings | undefined;
|
|
2096
2096
|
/**
|
|
2097
2097
|
* <p>The target maximum number of permitted requests per a given unit time interval.</p>
|
|
2098
2098
|
* @public
|
|
2099
2099
|
*/
|
|
2100
|
-
quota?: QuotaSettings;
|
|
2100
|
+
quota?: QuotaSettings | undefined;
|
|
2101
2101
|
/**
|
|
2102
2102
|
* <p>The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.</p>
|
|
2103
2103
|
* @public
|
|
2104
2104
|
*/
|
|
2105
|
-
productCode?: string;
|
|
2105
|
+
productCode?: string | undefined;
|
|
2106
2106
|
/**
|
|
2107
2107
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
2108
2108
|
* @public
|
|
2109
2109
|
*/
|
|
2110
|
-
tags?: Record<string, string
|
|
2110
|
+
tags?: Record<string, string> | undefined;
|
|
2111
2111
|
}
|
|
2112
2112
|
/**
|
|
2113
2113
|
* <p>The POST request to create a usage plan key for adding an existing API key to a usage plan.</p>
|
|
@@ -2139,22 +2139,22 @@ export interface UsagePlanKey {
|
|
|
2139
2139
|
* <p>The Id of a usage plan key.</p>
|
|
2140
2140
|
* @public
|
|
2141
2141
|
*/
|
|
2142
|
-
id?: string;
|
|
2142
|
+
id?: string | undefined;
|
|
2143
2143
|
/**
|
|
2144
2144
|
* <p>The type of a usage plan key. Currently, the valid key type is <code>API_KEY</code>.</p>
|
|
2145
2145
|
* @public
|
|
2146
2146
|
*/
|
|
2147
|
-
type?: string;
|
|
2147
|
+
type?: string | undefined;
|
|
2148
2148
|
/**
|
|
2149
2149
|
* <p>The value of a usage plan key.</p>
|
|
2150
2150
|
* @public
|
|
2151
2151
|
*/
|
|
2152
|
-
value?: string;
|
|
2152
|
+
value?: string | undefined;
|
|
2153
2153
|
/**
|
|
2154
2154
|
* <p>The name of a usage plan key.</p>
|
|
2155
2155
|
* @public
|
|
2156
2156
|
*/
|
|
2157
|
-
name?: string;
|
|
2157
|
+
name?: string | undefined;
|
|
2158
2158
|
}
|
|
2159
2159
|
/**
|
|
2160
2160
|
* <p>Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.</p>
|
|
@@ -2170,7 +2170,7 @@ export interface CreateVpcLinkRequest {
|
|
|
2170
2170
|
* <p>The description of the VPC link.</p>
|
|
2171
2171
|
* @public
|
|
2172
2172
|
*/
|
|
2173
|
-
description?: string;
|
|
2173
|
+
description?: string | undefined;
|
|
2174
2174
|
/**
|
|
2175
2175
|
* <p>The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.</p>
|
|
2176
2176
|
* @public
|
|
@@ -2180,7 +2180,7 @@ export interface CreateVpcLinkRequest {
|
|
|
2180
2180
|
* <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>
|
|
2181
2181
|
* @public
|
|
2182
2182
|
*/
|
|
2183
|
-
tags?: Record<string, string
|
|
2183
|
+
tags?: Record<string, string> | undefined;
|
|
2184
2184
|
}
|
|
2185
2185
|
/**
|
|
2186
2186
|
* @public
|
|
@@ -2205,37 +2205,37 @@ export interface VpcLink {
|
|
|
2205
2205
|
* <p>The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.</p>
|
|
2206
2206
|
* @public
|
|
2207
2207
|
*/
|
|
2208
|
-
id?: string;
|
|
2208
|
+
id?: string | undefined;
|
|
2209
2209
|
/**
|
|
2210
2210
|
* <p>The name used to label and identify the VPC link.</p>
|
|
2211
2211
|
* @public
|
|
2212
2212
|
*/
|
|
2213
|
-
name?: string;
|
|
2213
|
+
name?: string | undefined;
|
|
2214
2214
|
/**
|
|
2215
2215
|
* <p>The description of the VPC link.</p>
|
|
2216
2216
|
* @public
|
|
2217
2217
|
*/
|
|
2218
|
-
description?: string;
|
|
2218
|
+
description?: string | undefined;
|
|
2219
2219
|
/**
|
|
2220
2220
|
* <p>The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.</p>
|
|
2221
2221
|
* @public
|
|
2222
2222
|
*/
|
|
2223
|
-
targetArns?: string[];
|
|
2223
|
+
targetArns?: string[] | undefined;
|
|
2224
2224
|
/**
|
|
2225
2225
|
* <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>
|
|
2226
2226
|
* @public
|
|
2227
2227
|
*/
|
|
2228
|
-
status?: VpcLinkStatus;
|
|
2228
|
+
status?: VpcLinkStatus | undefined;
|
|
2229
2229
|
/**
|
|
2230
2230
|
* <p>A description about the VPC link status.</p>
|
|
2231
2231
|
* @public
|
|
2232
2232
|
*/
|
|
2233
|
-
statusMessage?: string;
|
|
2233
|
+
statusMessage?: string | undefined;
|
|
2234
2234
|
/**
|
|
2235
2235
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
2236
2236
|
* @public
|
|
2237
2237
|
*/
|
|
2238
|
-
tags?: Record<string, string
|
|
2238
|
+
tags?: Record<string, string> | undefined;
|
|
2239
2239
|
}
|
|
2240
2240
|
/**
|
|
2241
2241
|
* <p>A request to delete the ApiKey resource.</p>
|
|
@@ -2646,32 +2646,32 @@ export interface ClientCertificate {
|
|
|
2646
2646
|
* <p>The identifier of the client certificate.</p>
|
|
2647
2647
|
* @public
|
|
2648
2648
|
*/
|
|
2649
|
-
clientCertificateId?: string;
|
|
2649
|
+
clientCertificateId?: string | undefined;
|
|
2650
2650
|
/**
|
|
2651
2651
|
* <p>The description of the client certificate.</p>
|
|
2652
2652
|
* @public
|
|
2653
2653
|
*/
|
|
2654
|
-
description?: string;
|
|
2654
|
+
description?: string | undefined;
|
|
2655
2655
|
/**
|
|
2656
2656
|
* <p>The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .</p>
|
|
2657
2657
|
* @public
|
|
2658
2658
|
*/
|
|
2659
|
-
pemEncodedCertificate?: string;
|
|
2659
|
+
pemEncodedCertificate?: string | undefined;
|
|
2660
2660
|
/**
|
|
2661
2661
|
* <p>The timestamp when the client certificate was created.</p>
|
|
2662
2662
|
* @public
|
|
2663
2663
|
*/
|
|
2664
|
-
createdDate?: Date;
|
|
2664
|
+
createdDate?: Date | undefined;
|
|
2665
2665
|
/**
|
|
2666
2666
|
* <p>The timestamp when the client certificate will expire.</p>
|
|
2667
2667
|
* @public
|
|
2668
2668
|
*/
|
|
2669
|
-
expirationDate?: Date;
|
|
2669
|
+
expirationDate?: Date | undefined;
|
|
2670
2670
|
/**
|
|
2671
2671
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
2672
2672
|
* @public
|
|
2673
2673
|
*/
|
|
2674
|
-
tags?: Record<string, string
|
|
2674
|
+
tags?: Record<string, string> | undefined;
|
|
2675
2675
|
}
|
|
2676
2676
|
/**
|
|
2677
2677
|
* <p>A request to generate a ClientCertificate resource.</p>
|
|
@@ -2682,12 +2682,12 @@ export interface GenerateClientCertificateRequest {
|
|
|
2682
2682
|
* <p>The description of the ClientCertificate.</p>
|
|
2683
2683
|
* @public
|
|
2684
2684
|
*/
|
|
2685
|
-
description?: string;
|
|
2685
|
+
description?: string | undefined;
|
|
2686
2686
|
/**
|
|
2687
2687
|
* <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>
|
|
2688
2688
|
* @public
|
|
2689
2689
|
*/
|
|
2690
|
-
tags?: Record<string, string
|
|
2690
|
+
tags?: Record<string, string> | undefined;
|
|
2691
2691
|
}
|
|
2692
2692
|
/**
|
|
2693
2693
|
* <p>Requests API Gateway to get information about the current Account resource.</p>
|
|
@@ -2709,7 +2709,7 @@ export interface GetApiKeyRequest {
|
|
|
2709
2709
|
* <p>A boolean flag to specify whether (<code>true</code>) or not (<code>false</code>) the result contains the key value.</p>
|
|
2710
2710
|
* @public
|
|
2711
2711
|
*/
|
|
2712
|
-
includeValue?: boolean;
|
|
2712
|
+
includeValue?: boolean | undefined;
|
|
2713
2713
|
}
|
|
2714
2714
|
/**
|
|
2715
2715
|
* <p>A request to get information about the current ApiKeys resource.</p>
|
|
@@ -2720,27 +2720,27 @@ export interface GetApiKeysRequest {
|
|
|
2720
2720
|
* <p>The current pagination position in the paged result set.</p>
|
|
2721
2721
|
* @public
|
|
2722
2722
|
*/
|
|
2723
|
-
position?: string;
|
|
2723
|
+
position?: string | undefined;
|
|
2724
2724
|
/**
|
|
2725
2725
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
2726
2726
|
* @public
|
|
2727
2727
|
*/
|
|
2728
|
-
limit?: number;
|
|
2728
|
+
limit?: number | undefined;
|
|
2729
2729
|
/**
|
|
2730
2730
|
* <p>The name of queried API keys.</p>
|
|
2731
2731
|
* @public
|
|
2732
2732
|
*/
|
|
2733
|
-
nameQuery?: string;
|
|
2733
|
+
nameQuery?: string | undefined;
|
|
2734
2734
|
/**
|
|
2735
2735
|
* <p>The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.</p>
|
|
2736
2736
|
* @public
|
|
2737
2737
|
*/
|
|
2738
|
-
customerId?: string;
|
|
2738
|
+
customerId?: string | undefined;
|
|
2739
2739
|
/**
|
|
2740
2740
|
* <p>A boolean flag to specify whether (<code>true</code>) or not (<code>false</code>) the result contains key values.</p>
|
|
2741
2741
|
* @public
|
|
2742
2742
|
*/
|
|
2743
|
-
includeValues?: boolean;
|
|
2743
|
+
includeValues?: boolean | undefined;
|
|
2744
2744
|
}
|
|
2745
2745
|
/**
|
|
2746
2746
|
* <p>Request to describe an existing Authorizer resource.</p>
|
|
@@ -2772,12 +2772,12 @@ export interface GetAuthorizersRequest {
|
|
|
2772
2772
|
* <p>The current pagination position in the paged result set.</p>
|
|
2773
2773
|
* @public
|
|
2774
2774
|
*/
|
|
2775
|
-
position?: string;
|
|
2775
|
+
position?: string | undefined;
|
|
2776
2776
|
/**
|
|
2777
2777
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
2778
2778
|
* @public
|
|
2779
2779
|
*/
|
|
2780
|
-
limit?: number;
|
|
2780
|
+
limit?: number | undefined;
|
|
2781
2781
|
}
|
|
2782
2782
|
/**
|
|
2783
2783
|
* <p>Request to describe a BasePathMapping resource.</p>
|
|
@@ -2804,12 +2804,12 @@ export interface BasePathMappings {
|
|
|
2804
2804
|
* <p>The current page of elements from this collection.</p>
|
|
2805
2805
|
* @public
|
|
2806
2806
|
*/
|
|
2807
|
-
items?: BasePathMapping[];
|
|
2807
|
+
items?: BasePathMapping[] | undefined;
|
|
2808
2808
|
/**
|
|
2809
2809
|
* <p>The current pagination position in the paged result set.</p>
|
|
2810
2810
|
* @public
|
|
2811
2811
|
*/
|
|
2812
|
-
position?: string;
|
|
2812
|
+
position?: string | undefined;
|
|
2813
2813
|
}
|
|
2814
2814
|
/**
|
|
2815
2815
|
* <p>A request to get information about a collection of BasePathMapping resources.</p>
|
|
@@ -2825,12 +2825,12 @@ export interface GetBasePathMappingsRequest {
|
|
|
2825
2825
|
* <p>The current pagination position in the paged result set.</p>
|
|
2826
2826
|
* @public
|
|
2827
2827
|
*/
|
|
2828
|
-
position?: string;
|
|
2828
|
+
position?: string | undefined;
|
|
2829
2829
|
/**
|
|
2830
2830
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
2831
2831
|
* @public
|
|
2832
2832
|
*/
|
|
2833
|
-
limit?: number;
|
|
2833
|
+
limit?: number | undefined;
|
|
2834
2834
|
}
|
|
2835
2835
|
/**
|
|
2836
2836
|
* <p>A request to get information about the current ClientCertificate resource.</p>
|
|
@@ -2852,12 +2852,12 @@ export interface ClientCertificates {
|
|
|
2852
2852
|
* <p>The current page of elements from this collection.</p>
|
|
2853
2853
|
* @public
|
|
2854
2854
|
*/
|
|
2855
|
-
items?: ClientCertificate[];
|
|
2855
|
+
items?: ClientCertificate[] | undefined;
|
|
2856
2856
|
/**
|
|
2857
2857
|
* <p>The current pagination position in the paged result set.</p>
|
|
2858
2858
|
* @public
|
|
2859
2859
|
*/
|
|
2860
|
-
position?: string;
|
|
2860
|
+
position?: string | undefined;
|
|
2861
2861
|
}
|
|
2862
2862
|
/**
|
|
2863
2863
|
* <p>A request to get information about a collection of ClientCertificate resources.</p>
|
|
@@ -2868,12 +2868,12 @@ export interface GetClientCertificatesRequest {
|
|
|
2868
2868
|
* <p>The current pagination position in the paged result set.</p>
|
|
2869
2869
|
* @public
|
|
2870
2870
|
*/
|
|
2871
|
-
position?: string;
|
|
2871
|
+
position?: string | undefined;
|
|
2872
2872
|
/**
|
|
2873
2873
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
2874
2874
|
* @public
|
|
2875
2875
|
*/
|
|
2876
|
-
limit?: number;
|
|
2876
|
+
limit?: number | undefined;
|
|
2877
2877
|
}
|
|
2878
2878
|
/**
|
|
2879
2879
|
* <p>Requests API Gateway to get information about a Deployment resource.</p>
|
|
@@ -2894,7 +2894,7 @@ export interface GetDeploymentRequest {
|
|
|
2894
2894
|
* <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>
|
|
2895
2895
|
* @public
|
|
2896
2896
|
*/
|
|
2897
|
-
embed?: string[];
|
|
2897
|
+
embed?: string[] | undefined;
|
|
2898
2898
|
}
|
|
2899
2899
|
/**
|
|
2900
2900
|
* <p>Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.</p>
|
|
@@ -2905,12 +2905,12 @@ export interface Deployments {
|
|
|
2905
2905
|
* <p>The current page of elements from this collection.</p>
|
|
2906
2906
|
* @public
|
|
2907
2907
|
*/
|
|
2908
|
-
items?: Deployment[];
|
|
2908
|
+
items?: Deployment[] | undefined;
|
|
2909
2909
|
/**
|
|
2910
2910
|
* <p>The current pagination position in the paged result set.</p>
|
|
2911
2911
|
* @public
|
|
2912
2912
|
*/
|
|
2913
|
-
position?: string;
|
|
2913
|
+
position?: string | undefined;
|
|
2914
2914
|
}
|
|
2915
2915
|
/**
|
|
2916
2916
|
* <p>Requests API Gateway to get information about a Deployments collection.</p>
|
|
@@ -2926,12 +2926,12 @@ export interface GetDeploymentsRequest {
|
|
|
2926
2926
|
* <p>The current pagination position in the paged result set.</p>
|
|
2927
2927
|
* @public
|
|
2928
2928
|
*/
|
|
2929
|
-
position?: string;
|
|
2929
|
+
position?: string | undefined;
|
|
2930
2930
|
/**
|
|
2931
2931
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
2932
2932
|
* @public
|
|
2933
2933
|
*/
|
|
2934
|
-
limit?: number;
|
|
2934
|
+
limit?: number | undefined;
|
|
2935
2935
|
}
|
|
2936
2936
|
/**
|
|
2937
2937
|
* <p>Gets a specified documentation part of a given API.</p>
|
|
@@ -2958,12 +2958,12 @@ export interface DocumentationParts {
|
|
|
2958
2958
|
* <p>The current page of elements from this collection.</p>
|
|
2959
2959
|
* @public
|
|
2960
2960
|
*/
|
|
2961
|
-
items?: DocumentationPart[];
|
|
2961
|
+
items?: DocumentationPart[] | undefined;
|
|
2962
2962
|
/**
|
|
2963
2963
|
* <p>The current pagination position in the paged result set.</p>
|
|
2964
2964
|
* @public
|
|
2965
2965
|
*/
|
|
2966
|
-
position?: string;
|
|
2966
|
+
position?: string | undefined;
|
|
2967
2967
|
}
|
|
2968
2968
|
/**
|
|
2969
2969
|
* @public
|
|
@@ -2991,32 +2991,32 @@ export interface GetDocumentationPartsRequest {
|
|
|
2991
2991
|
* <p>The type of API entities of the to-be-retrieved documentation parts. </p>
|
|
2992
2992
|
* @public
|
|
2993
2993
|
*/
|
|
2994
|
-
type?: DocumentationPartType;
|
|
2994
|
+
type?: DocumentationPartType | undefined;
|
|
2995
2995
|
/**
|
|
2996
2996
|
* <p>The name of API entities of the to-be-retrieved documentation parts.</p>
|
|
2997
2997
|
* @public
|
|
2998
2998
|
*/
|
|
2999
|
-
nameQuery?: string;
|
|
2999
|
+
nameQuery?: string | undefined;
|
|
3000
3000
|
/**
|
|
3001
3001
|
* <p>The path of API entities of the to-be-retrieved documentation parts.</p>
|
|
3002
3002
|
* @public
|
|
3003
3003
|
*/
|
|
3004
|
-
path?: string;
|
|
3004
|
+
path?: string | undefined;
|
|
3005
3005
|
/**
|
|
3006
3006
|
* <p>The current pagination position in the paged result set.</p>
|
|
3007
3007
|
* @public
|
|
3008
3008
|
*/
|
|
3009
|
-
position?: string;
|
|
3009
|
+
position?: string | undefined;
|
|
3010
3010
|
/**
|
|
3011
3011
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3012
3012
|
* @public
|
|
3013
3013
|
*/
|
|
3014
|
-
limit?: number;
|
|
3014
|
+
limit?: number | undefined;
|
|
3015
3015
|
/**
|
|
3016
3016
|
* <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>
|
|
3017
3017
|
* @public
|
|
3018
3018
|
*/
|
|
3019
|
-
locationStatus?: LocationStatusType;
|
|
3019
|
+
locationStatus?: LocationStatusType | undefined;
|
|
3020
3020
|
}
|
|
3021
3021
|
/**
|
|
3022
3022
|
* <p>Gets a documentation snapshot of an API.</p>
|
|
@@ -3043,12 +3043,12 @@ export interface DocumentationVersions {
|
|
|
3043
3043
|
* <p>The current page of elements from this collection.</p>
|
|
3044
3044
|
* @public
|
|
3045
3045
|
*/
|
|
3046
|
-
items?: DocumentationVersion[];
|
|
3046
|
+
items?: DocumentationVersion[] | undefined;
|
|
3047
3047
|
/**
|
|
3048
3048
|
* <p>The current pagination position in the paged result set.</p>
|
|
3049
3049
|
* @public
|
|
3050
3050
|
*/
|
|
3051
|
-
position?: string;
|
|
3051
|
+
position?: string | undefined;
|
|
3052
3052
|
}
|
|
3053
3053
|
/**
|
|
3054
3054
|
* <p>Gets the documentation versions of an API.</p>
|
|
@@ -3064,12 +3064,12 @@ export interface GetDocumentationVersionsRequest {
|
|
|
3064
3064
|
* <p>The current pagination position in the paged result set.</p>
|
|
3065
3065
|
* @public
|
|
3066
3066
|
*/
|
|
3067
|
-
position?: string;
|
|
3067
|
+
position?: string | undefined;
|
|
3068
3068
|
/**
|
|
3069
3069
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3070
3070
|
* @public
|
|
3071
3071
|
*/
|
|
3072
|
-
limit?: number;
|
|
3072
|
+
limit?: number | undefined;
|
|
3073
3073
|
}
|
|
3074
3074
|
/**
|
|
3075
3075
|
* <p>Request to get the name of a DomainName resource.</p>
|
|
@@ -3091,12 +3091,12 @@ export interface DomainNames {
|
|
|
3091
3091
|
* <p>The current page of elements from this collection.</p>
|
|
3092
3092
|
* @public
|
|
3093
3093
|
*/
|
|
3094
|
-
items?: DomainName[];
|
|
3094
|
+
items?: DomainName[] | undefined;
|
|
3095
3095
|
/**
|
|
3096
3096
|
* <p>The current pagination position in the paged result set.</p>
|
|
3097
3097
|
* @public
|
|
3098
3098
|
*/
|
|
3099
|
-
position?: string;
|
|
3099
|
+
position?: string | undefined;
|
|
3100
3100
|
}
|
|
3101
3101
|
/**
|
|
3102
3102
|
* <p>Request to describe a collection of DomainName resources.</p>
|
|
@@ -3107,12 +3107,12 @@ export interface GetDomainNamesRequest {
|
|
|
3107
3107
|
* <p>The current pagination position in the paged result set.</p>
|
|
3108
3108
|
* @public
|
|
3109
3109
|
*/
|
|
3110
|
-
position?: string;
|
|
3110
|
+
position?: string | undefined;
|
|
3111
3111
|
/**
|
|
3112
3112
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3113
3113
|
* @public
|
|
3114
3114
|
*/
|
|
3115
|
-
limit?: number;
|
|
3115
|
+
limit?: number | undefined;
|
|
3116
3116
|
}
|
|
3117
3117
|
/**
|
|
3118
3118
|
* <p>The binary blob response to GetExport, which contains the generated SDK.</p>
|
|
@@ -3123,17 +3123,17 @@ export interface ExportResponse {
|
|
|
3123
3123
|
* <p>The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.</p>
|
|
3124
3124
|
* @public
|
|
3125
3125
|
*/
|
|
3126
|
-
contentType?: string;
|
|
3126
|
+
contentType?: string | undefined;
|
|
3127
3127
|
/**
|
|
3128
3128
|
* <p>The content-disposition header value in the HTTP response.</p>
|
|
3129
3129
|
* @public
|
|
3130
3130
|
*/
|
|
3131
|
-
contentDisposition?: string;
|
|
3131
|
+
contentDisposition?: string | undefined;
|
|
3132
3132
|
/**
|
|
3133
3133
|
* <p>The binary blob response to GetExport, which contains the export.</p>
|
|
3134
3134
|
* @public
|
|
3135
3135
|
*/
|
|
3136
|
-
body?: Uint8Array;
|
|
3136
|
+
body?: Uint8Array | undefined;
|
|
3137
3137
|
}
|
|
3138
3138
|
/**
|
|
3139
3139
|
* <p>Request a new export of a RestApi for a particular Stage.</p>
|
|
@@ -3160,12 +3160,12 @@ export interface GetExportRequest {
|
|
|
3160
3160
|
* <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>
|
|
3161
3161
|
* @public
|
|
3162
3162
|
*/
|
|
3163
|
-
parameters?: Record<string, string
|
|
3163
|
+
parameters?: Record<string, string> | undefined;
|
|
3164
3164
|
/**
|
|
3165
3165
|
* <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>
|
|
3166
3166
|
* @public
|
|
3167
3167
|
*/
|
|
3168
|
-
accepts?: string;
|
|
3168
|
+
accepts?: string | undefined;
|
|
3169
3169
|
}
|
|
3170
3170
|
/**
|
|
3171
3171
|
* <p>A gateway response of a given response type and status code, with optional response parameters and mapping templates.</p>
|
|
@@ -3176,28 +3176,28 @@ export interface GatewayResponse {
|
|
|
3176
3176
|
* <p>The response type of the associated GatewayResponse.</p>
|
|
3177
3177
|
* @public
|
|
3178
3178
|
*/
|
|
3179
|
-
responseType?: GatewayResponseType;
|
|
3179
|
+
responseType?: GatewayResponseType | undefined;
|
|
3180
3180
|
/**
|
|
3181
3181
|
* <p>The HTTP status code for this GatewayResponse.</p>
|
|
3182
3182
|
* @public
|
|
3183
3183
|
*/
|
|
3184
|
-
statusCode?: string;
|
|
3184
|
+
statusCode?: string | undefined;
|
|
3185
3185
|
/**
|
|
3186
3186
|
* <p>Response parameters (paths, query strings and headers) of the GatewayResponse as a
|
|
3187
3187
|
* string-to-string map of key-value pairs.</p>
|
|
3188
3188
|
* @public
|
|
3189
3189
|
*/
|
|
3190
|
-
responseParameters?: Record<string, string
|
|
3190
|
+
responseParameters?: Record<string, string> | undefined;
|
|
3191
3191
|
/**
|
|
3192
3192
|
* <p>Response templates of the GatewayResponse as a string-to-string map of key-value pairs.</p>
|
|
3193
3193
|
* @public
|
|
3194
3194
|
*/
|
|
3195
|
-
responseTemplates?: Record<string, string
|
|
3195
|
+
responseTemplates?: Record<string, string> | undefined;
|
|
3196
3196
|
/**
|
|
3197
3197
|
* <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>
|
|
3198
3198
|
* @public
|
|
3199
3199
|
*/
|
|
3200
|
-
defaultResponse?: boolean;
|
|
3200
|
+
defaultResponse?: boolean | undefined;
|
|
3201
3201
|
}
|
|
3202
3202
|
/**
|
|
3203
3203
|
* <p>Gets a GatewayResponse of a specified response type on the given RestApi.</p>
|
|
@@ -3224,12 +3224,12 @@ export interface GatewayResponses {
|
|
|
3224
3224
|
* <p>Returns the entire collection, because of no pagination support.</p>
|
|
3225
3225
|
* @public
|
|
3226
3226
|
*/
|
|
3227
|
-
items?: GatewayResponse[];
|
|
3227
|
+
items?: GatewayResponse[] | undefined;
|
|
3228
3228
|
/**
|
|
3229
3229
|
* <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>
|
|
3230
3230
|
* @public
|
|
3231
3231
|
*/
|
|
3232
|
-
position?: string;
|
|
3232
|
+
position?: string | undefined;
|
|
3233
3233
|
}
|
|
3234
3234
|
/**
|
|
3235
3235
|
* <p>Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.</p>
|
|
@@ -3245,12 +3245,12 @@ export interface GetGatewayResponsesRequest {
|
|
|
3245
3245
|
* <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>
|
|
3246
3246
|
* @public
|
|
3247
3247
|
*/
|
|
3248
|
-
position?: string;
|
|
3248
|
+
position?: string | undefined;
|
|
3249
3249
|
/**
|
|
3250
3250
|
* <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>
|
|
3251
3251
|
* @public
|
|
3252
3252
|
*/
|
|
3253
|
-
limit?: number;
|
|
3253
|
+
limit?: number | undefined;
|
|
3254
3254
|
}
|
|
3255
3255
|
/**
|
|
3256
3256
|
* <p>Represents a request to get the integration configuration.</p>
|
|
@@ -3365,7 +3365,7 @@ export interface GetModelRequest {
|
|
|
3365
3365
|
* <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>
|
|
3366
3366
|
* @public
|
|
3367
3367
|
*/
|
|
3368
|
-
flatten?: boolean;
|
|
3368
|
+
flatten?: boolean | undefined;
|
|
3369
3369
|
}
|
|
3370
3370
|
/**
|
|
3371
3371
|
* <p>Request to list existing Models defined for a RestApi resource.</p>
|
|
@@ -3381,12 +3381,12 @@ export interface GetModelsRequest {
|
|
|
3381
3381
|
* <p>The current pagination position in the paged result set.</p>
|
|
3382
3382
|
* @public
|
|
3383
3383
|
*/
|
|
3384
|
-
position?: string;
|
|
3384
|
+
position?: string | undefined;
|
|
3385
3385
|
/**
|
|
3386
3386
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3387
3387
|
* @public
|
|
3388
3388
|
*/
|
|
3389
|
-
limit?: number;
|
|
3389
|
+
limit?: number | undefined;
|
|
3390
3390
|
}
|
|
3391
3391
|
/**
|
|
3392
3392
|
* <p>Represents a collection of Model resources.</p>
|
|
@@ -3397,12 +3397,12 @@ export interface Models {
|
|
|
3397
3397
|
* <p>The current page of elements from this collection.</p>
|
|
3398
3398
|
* @public
|
|
3399
3399
|
*/
|
|
3400
|
-
items?: Model[];
|
|
3400
|
+
items?: Model[] | undefined;
|
|
3401
3401
|
/**
|
|
3402
3402
|
* <p>The current pagination position in the paged result set.</p>
|
|
3403
3403
|
* @public
|
|
3404
3404
|
*/
|
|
3405
|
-
position?: string;
|
|
3405
|
+
position?: string | undefined;
|
|
3406
3406
|
}
|
|
3407
3407
|
/**
|
|
3408
3408
|
* <p>Request to generate a sample mapping template used to transform the payload.</p>
|
|
@@ -3429,7 +3429,7 @@ export interface Template {
|
|
|
3429
3429
|
* <p>The Apache Velocity Template Language (VTL) template content used for the template resource.</p>
|
|
3430
3430
|
* @public
|
|
3431
3431
|
*/
|
|
3432
|
-
value?: string;
|
|
3432
|
+
value?: string | undefined;
|
|
3433
3433
|
}
|
|
3434
3434
|
/**
|
|
3435
3435
|
* <p>Gets a RequestValidator of a given RestApi.</p>
|
|
@@ -3461,12 +3461,12 @@ export interface GetRequestValidatorsRequest {
|
|
|
3461
3461
|
* <p>The current pagination position in the paged result set.</p>
|
|
3462
3462
|
* @public
|
|
3463
3463
|
*/
|
|
3464
|
-
position?: string;
|
|
3464
|
+
position?: string | undefined;
|
|
3465
3465
|
/**
|
|
3466
3466
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3467
3467
|
* @public
|
|
3468
3468
|
*/
|
|
3469
|
-
limit?: number;
|
|
3469
|
+
limit?: number | undefined;
|
|
3470
3470
|
}
|
|
3471
3471
|
/**
|
|
3472
3472
|
* <p>A collection of RequestValidator resources of a given RestApi.</p>
|
|
@@ -3477,12 +3477,12 @@ export interface RequestValidators {
|
|
|
3477
3477
|
* <p>The current page of elements from this collection.</p>
|
|
3478
3478
|
* @public
|
|
3479
3479
|
*/
|
|
3480
|
-
items?: RequestValidator[];
|
|
3480
|
+
items?: RequestValidator[] | undefined;
|
|
3481
3481
|
/**
|
|
3482
3482
|
* <p>The current pagination position in the paged result set.</p>
|
|
3483
3483
|
* @public
|
|
3484
3484
|
*/
|
|
3485
|
-
position?: string;
|
|
3485
|
+
position?: string | undefined;
|
|
3486
3486
|
}
|
|
3487
3487
|
/**
|
|
3488
3488
|
* <p>Request to list information about a resource.</p>
|
|
@@ -3503,7 +3503,7 @@ export interface GetResourceRequest {
|
|
|
3503
3503
|
* <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>
|
|
3504
3504
|
* @public
|
|
3505
3505
|
*/
|
|
3506
|
-
embed?: string[];
|
|
3506
|
+
embed?: string[] | undefined;
|
|
3507
3507
|
}
|
|
3508
3508
|
/**
|
|
3509
3509
|
* <p>Request to list information about a collection of resources.</p>
|
|
@@ -3519,17 +3519,17 @@ export interface GetResourcesRequest {
|
|
|
3519
3519
|
* <p>The current pagination position in the paged result set.</p>
|
|
3520
3520
|
* @public
|
|
3521
3521
|
*/
|
|
3522
|
-
position?: string;
|
|
3522
|
+
position?: string | undefined;
|
|
3523
3523
|
/**
|
|
3524
3524
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3525
3525
|
* @public
|
|
3526
3526
|
*/
|
|
3527
|
-
limit?: number;
|
|
3527
|
+
limit?: number | undefined;
|
|
3528
3528
|
/**
|
|
3529
3529
|
* <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>
|
|
3530
3530
|
* @public
|
|
3531
3531
|
*/
|
|
3532
|
-
embed?: string[];
|
|
3532
|
+
embed?: string[] | undefined;
|
|
3533
3533
|
}
|
|
3534
3534
|
/**
|
|
3535
3535
|
* <p>Represents a collection of Resource resources.</p>
|
|
@@ -3540,12 +3540,12 @@ export interface Resources {
|
|
|
3540
3540
|
* <p>The current page of elements from this collection.</p>
|
|
3541
3541
|
* @public
|
|
3542
3542
|
*/
|
|
3543
|
-
items?: Resource[];
|
|
3543
|
+
items?: Resource[] | undefined;
|
|
3544
3544
|
/**
|
|
3545
3545
|
* <p>The current pagination position in the paged result set.</p>
|
|
3546
3546
|
* @public
|
|
3547
3547
|
*/
|
|
3548
|
-
position?: string;
|
|
3548
|
+
position?: string | undefined;
|
|
3549
3549
|
}
|
|
3550
3550
|
/**
|
|
3551
3551
|
* <p>The GET request to list an existing RestApi defined for your collection. </p>
|
|
@@ -3567,12 +3567,12 @@ export interface GetRestApisRequest {
|
|
|
3567
3567
|
* <p>The current pagination position in the paged result set.</p>
|
|
3568
3568
|
* @public
|
|
3569
3569
|
*/
|
|
3570
|
-
position?: string;
|
|
3570
|
+
position?: string | undefined;
|
|
3571
3571
|
/**
|
|
3572
3572
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3573
3573
|
* @public
|
|
3574
3574
|
*/
|
|
3575
|
-
limit?: number;
|
|
3575
|
+
limit?: number | undefined;
|
|
3576
3576
|
}
|
|
3577
3577
|
/**
|
|
3578
3578
|
* <p>Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.</p>
|
|
@@ -3583,12 +3583,12 @@ export interface RestApis {
|
|
|
3583
3583
|
* <p>The current page of elements from this collection.</p>
|
|
3584
3584
|
* @public
|
|
3585
3585
|
*/
|
|
3586
|
-
items?: RestApi[];
|
|
3586
|
+
items?: RestApi[] | undefined;
|
|
3587
3587
|
/**
|
|
3588
3588
|
* <p>The current pagination position in the paged result set.</p>
|
|
3589
3589
|
* @public
|
|
3590
3590
|
*/
|
|
3591
|
-
position?: string;
|
|
3591
|
+
position?: string | undefined;
|
|
3592
3592
|
}
|
|
3593
3593
|
/**
|
|
3594
3594
|
* <p>Request a new generated client SDK for a RestApi and Stage.</p>
|
|
@@ -3614,7 +3614,7 @@ export interface GetSdkRequest {
|
|
|
3614
3614
|
* <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>
|
|
3615
3615
|
* @public
|
|
3616
3616
|
*/
|
|
3617
|
-
parameters?: Record<string, string
|
|
3617
|
+
parameters?: Record<string, string> | undefined;
|
|
3618
3618
|
}
|
|
3619
3619
|
/**
|
|
3620
3620
|
* <p>The binary blob response to GetSdk, which contains the generated SDK.</p>
|
|
@@ -3625,17 +3625,17 @@ export interface SdkResponse {
|
|
|
3625
3625
|
* <p>The content-type header value in the HTTP response.</p>
|
|
3626
3626
|
* @public
|
|
3627
3627
|
*/
|
|
3628
|
-
contentType?: string;
|
|
3628
|
+
contentType?: string | undefined;
|
|
3629
3629
|
/**
|
|
3630
3630
|
* <p>The content-disposition header value in the HTTP response.</p>
|
|
3631
3631
|
* @public
|
|
3632
3632
|
*/
|
|
3633
|
-
contentDisposition?: string;
|
|
3633
|
+
contentDisposition?: string | undefined;
|
|
3634
3634
|
/**
|
|
3635
3635
|
* <p>The binary blob response to GetSdk, which contains the generated SDK.</p>
|
|
3636
3636
|
* @public
|
|
3637
3637
|
*/
|
|
3638
|
-
body?: Uint8Array;
|
|
3638
|
+
body?: Uint8Array | undefined;
|
|
3639
3639
|
}
|
|
3640
3640
|
/**
|
|
3641
3641
|
* <p>Get an SdkType instance.</p>
|
|
@@ -3657,27 +3657,27 @@ export interface SdkConfigurationProperty {
|
|
|
3657
3657
|
* <p>The name of a an SdkType configuration property.</p>
|
|
3658
3658
|
* @public
|
|
3659
3659
|
*/
|
|
3660
|
-
name?: string;
|
|
3660
|
+
name?: string | undefined;
|
|
3661
3661
|
/**
|
|
3662
3662
|
* <p>The user-friendly name of an SdkType configuration property.</p>
|
|
3663
3663
|
* @public
|
|
3664
3664
|
*/
|
|
3665
|
-
friendlyName?: string;
|
|
3665
|
+
friendlyName?: string | undefined;
|
|
3666
3666
|
/**
|
|
3667
3667
|
* <p>The description of an SdkType configuration property.</p>
|
|
3668
3668
|
* @public
|
|
3669
3669
|
*/
|
|
3670
|
-
description?: string;
|
|
3670
|
+
description?: string | undefined;
|
|
3671
3671
|
/**
|
|
3672
3672
|
* <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>
|
|
3673
3673
|
* @public
|
|
3674
3674
|
*/
|
|
3675
|
-
required?: boolean;
|
|
3675
|
+
required?: boolean | undefined;
|
|
3676
3676
|
/**
|
|
3677
3677
|
* <p>The default value of an SdkType configuration property.</p>
|
|
3678
3678
|
* @public
|
|
3679
3679
|
*/
|
|
3680
|
-
defaultValue?: string;
|
|
3680
|
+
defaultValue?: string | undefined;
|
|
3681
3681
|
}
|
|
3682
3682
|
/**
|
|
3683
3683
|
* <p>A type of SDK that API Gateway can generate.</p>
|
|
@@ -3688,22 +3688,22 @@ export interface SdkType {
|
|
|
3688
3688
|
* <p>The identifier of an SdkType instance.</p>
|
|
3689
3689
|
* @public
|
|
3690
3690
|
*/
|
|
3691
|
-
id?: string;
|
|
3691
|
+
id?: string | undefined;
|
|
3692
3692
|
/**
|
|
3693
3693
|
* <p>The user-friendly name of an SdkType instance.</p>
|
|
3694
3694
|
* @public
|
|
3695
3695
|
*/
|
|
3696
|
-
friendlyName?: string;
|
|
3696
|
+
friendlyName?: string | undefined;
|
|
3697
3697
|
/**
|
|
3698
3698
|
* <p>The description of an SdkType.</p>
|
|
3699
3699
|
* @public
|
|
3700
3700
|
*/
|
|
3701
|
-
description?: string;
|
|
3701
|
+
description?: string | undefined;
|
|
3702
3702
|
/**
|
|
3703
3703
|
* <p>A list of configuration properties of an SdkType.</p>
|
|
3704
3704
|
* @public
|
|
3705
3705
|
*/
|
|
3706
|
-
configurationProperties?: SdkConfigurationProperty[];
|
|
3706
|
+
configurationProperties?: SdkConfigurationProperty[] | undefined;
|
|
3707
3707
|
}
|
|
3708
3708
|
/**
|
|
3709
3709
|
* <p>Get the SdkTypes collection.</p>
|
|
@@ -3714,12 +3714,12 @@ export interface GetSdkTypesRequest {
|
|
|
3714
3714
|
* <p>The current pagination position in the paged result set.</p>
|
|
3715
3715
|
* @public
|
|
3716
3716
|
*/
|
|
3717
|
-
position?: string;
|
|
3717
|
+
position?: string | undefined;
|
|
3718
3718
|
/**
|
|
3719
3719
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3720
3720
|
* @public
|
|
3721
3721
|
*/
|
|
3722
|
-
limit?: number;
|
|
3722
|
+
limit?: number | undefined;
|
|
3723
3723
|
}
|
|
3724
3724
|
/**
|
|
3725
3725
|
* <p>The collection of SdkType instances.</p>
|
|
@@ -3730,7 +3730,7 @@ export interface SdkTypes {
|
|
|
3730
3730
|
* <p>The current page of elements from this collection.</p>
|
|
3731
3731
|
* @public
|
|
3732
3732
|
*/
|
|
3733
|
-
items?: SdkType[];
|
|
3733
|
+
items?: SdkType[] | undefined;
|
|
3734
3734
|
}
|
|
3735
3735
|
/**
|
|
3736
3736
|
* <p>Requests API Gateway to get information about a Stage resource.</p>
|
|
@@ -3762,7 +3762,7 @@ export interface GetStagesRequest {
|
|
|
3762
3762
|
* <p>The stages' deployment identifiers.</p>
|
|
3763
3763
|
* @public
|
|
3764
3764
|
*/
|
|
3765
|
-
deploymentId?: string;
|
|
3765
|
+
deploymentId?: string | undefined;
|
|
3766
3766
|
}
|
|
3767
3767
|
/**
|
|
3768
3768
|
* <p>A list of Stage resources that are associated with the ApiKey resource.</p>
|
|
@@ -3773,7 +3773,7 @@ export interface Stages {
|
|
|
3773
3773
|
* <p>The current page of elements from this collection.</p>
|
|
3774
3774
|
* @public
|
|
3775
3775
|
*/
|
|
3776
|
-
item?: Stage[];
|
|
3776
|
+
item?: Stage[] | undefined;
|
|
3777
3777
|
}
|
|
3778
3778
|
/**
|
|
3779
3779
|
* <p>Gets the Tags collection for a given resource.</p>
|
|
@@ -3789,12 +3789,12 @@ export interface GetTagsRequest {
|
|
|
3789
3789
|
* <p>(Not currently supported) The current pagination position in the paged result set.</p>
|
|
3790
3790
|
* @public
|
|
3791
3791
|
*/
|
|
3792
|
-
position?: string;
|
|
3792
|
+
position?: string | undefined;
|
|
3793
3793
|
/**
|
|
3794
3794
|
* <p>(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3795
3795
|
* @public
|
|
3796
3796
|
*/
|
|
3797
|
-
limit?: number;
|
|
3797
|
+
limit?: number | undefined;
|
|
3798
3798
|
}
|
|
3799
3799
|
/**
|
|
3800
3800
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
@@ -3805,7 +3805,7 @@ export interface Tags {
|
|
|
3805
3805
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
3806
3806
|
* @public
|
|
3807
3807
|
*/
|
|
3808
|
-
tags?: Record<string, string
|
|
3808
|
+
tags?: Record<string, string> | undefined;
|
|
3809
3809
|
}
|
|
3810
3810
|
/**
|
|
3811
3811
|
* <p>The GET request to get the usage data of a usage plan in a specified time interval.</p>
|
|
@@ -3821,7 +3821,7 @@ export interface GetUsageRequest {
|
|
|
3821
3821
|
* <p>The Id of the API key associated with the resultant usage data.</p>
|
|
3822
3822
|
* @public
|
|
3823
3823
|
*/
|
|
3824
|
-
keyId?: string;
|
|
3824
|
+
keyId?: string | undefined;
|
|
3825
3825
|
/**
|
|
3826
3826
|
* <p>The starting date (e.g., 2016-01-01) of the usage data.</p>
|
|
3827
3827
|
* @public
|
|
@@ -3836,12 +3836,12 @@ export interface GetUsageRequest {
|
|
|
3836
3836
|
* <p>The current pagination position in the paged result set.</p>
|
|
3837
3837
|
* @public
|
|
3838
3838
|
*/
|
|
3839
|
-
position?: string;
|
|
3839
|
+
position?: string | undefined;
|
|
3840
3840
|
/**
|
|
3841
3841
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3842
3842
|
* @public
|
|
3843
3843
|
*/
|
|
3844
|
-
limit?: number;
|
|
3844
|
+
limit?: number | undefined;
|
|
3845
3845
|
}
|
|
3846
3846
|
/**
|
|
3847
3847
|
* <p>Represents the usage data of a usage plan.</p>
|
|
@@ -3852,27 +3852,27 @@ export interface Usage {
|
|
|
3852
3852
|
* <p>The plan Id associated with this usage data.</p>
|
|
3853
3853
|
* @public
|
|
3854
3854
|
*/
|
|
3855
|
-
usagePlanId?: string;
|
|
3855
|
+
usagePlanId?: string | undefined;
|
|
3856
3856
|
/**
|
|
3857
3857
|
* <p>The starting date of the usage data.</p>
|
|
3858
3858
|
* @public
|
|
3859
3859
|
*/
|
|
3860
|
-
startDate?: string;
|
|
3860
|
+
startDate?: string | undefined;
|
|
3861
3861
|
/**
|
|
3862
3862
|
* <p>The ending date of the usage data.</p>
|
|
3863
3863
|
* @public
|
|
3864
3864
|
*/
|
|
3865
|
-
endDate?: string;
|
|
3865
|
+
endDate?: string | undefined;
|
|
3866
3866
|
/**
|
|
3867
3867
|
* <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>
|
|
3868
3868
|
* @public
|
|
3869
3869
|
*/
|
|
3870
|
-
items?: Record<string, number[][]
|
|
3870
|
+
items?: Record<string, number[][]> | undefined;
|
|
3871
3871
|
/**
|
|
3872
3872
|
* <p>The current pagination position in the paged result set.</p>
|
|
3873
3873
|
* @public
|
|
3874
3874
|
*/
|
|
3875
|
-
position?: string;
|
|
3875
|
+
position?: string | undefined;
|
|
3876
3876
|
}
|
|
3877
3877
|
/**
|
|
3878
3878
|
* <p>The GET request to get a usage plan of a given plan identifier.</p>
|
|
@@ -3915,17 +3915,17 @@ export interface GetUsagePlanKeysRequest {
|
|
|
3915
3915
|
* <p>The current pagination position in the paged result set.</p>
|
|
3916
3916
|
* @public
|
|
3917
3917
|
*/
|
|
3918
|
-
position?: string;
|
|
3918
|
+
position?: string | undefined;
|
|
3919
3919
|
/**
|
|
3920
3920
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3921
3921
|
* @public
|
|
3922
3922
|
*/
|
|
3923
|
-
limit?: number;
|
|
3923
|
+
limit?: number | undefined;
|
|
3924
3924
|
/**
|
|
3925
3925
|
* <p>A query parameter specifying the name of the to-be-returned usage plan keys.</p>
|
|
3926
3926
|
* @public
|
|
3927
3927
|
*/
|
|
3928
|
-
nameQuery?: string;
|
|
3928
|
+
nameQuery?: string | undefined;
|
|
3929
3929
|
}
|
|
3930
3930
|
/**
|
|
3931
3931
|
* <p>Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.</p>
|
|
@@ -3936,12 +3936,12 @@ export interface UsagePlanKeys {
|
|
|
3936
3936
|
* <p>The current page of elements from this collection.</p>
|
|
3937
3937
|
* @public
|
|
3938
3938
|
*/
|
|
3939
|
-
items?: UsagePlanKey[];
|
|
3939
|
+
items?: UsagePlanKey[] | undefined;
|
|
3940
3940
|
/**
|
|
3941
3941
|
* <p>The current pagination position in the paged result set.</p>
|
|
3942
3942
|
* @public
|
|
3943
3943
|
*/
|
|
3944
|
-
position?: string;
|
|
3944
|
+
position?: string | undefined;
|
|
3945
3945
|
}
|
|
3946
3946
|
/**
|
|
3947
3947
|
* <p>The GET request to get all the usage plans of the caller's account.</p>
|
|
@@ -3952,17 +3952,17 @@ export interface GetUsagePlansRequest {
|
|
|
3952
3952
|
* <p>The current pagination position in the paged result set.</p>
|
|
3953
3953
|
* @public
|
|
3954
3954
|
*/
|
|
3955
|
-
position?: string;
|
|
3955
|
+
position?: string | undefined;
|
|
3956
3956
|
/**
|
|
3957
3957
|
* <p>The identifier of the API key associated with the usage plans.</p>
|
|
3958
3958
|
* @public
|
|
3959
3959
|
*/
|
|
3960
|
-
keyId?: string;
|
|
3960
|
+
keyId?: string | undefined;
|
|
3961
3961
|
/**
|
|
3962
3962
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
3963
3963
|
* @public
|
|
3964
3964
|
*/
|
|
3965
|
-
limit?: number;
|
|
3965
|
+
limit?: number | undefined;
|
|
3966
3966
|
}
|
|
3967
3967
|
/**
|
|
3968
3968
|
* <p>Represents a collection of usage plans for an AWS account.</p>
|
|
@@ -3973,12 +3973,12 @@ export interface UsagePlans {
|
|
|
3973
3973
|
* <p>The current page of elements from this collection.</p>
|
|
3974
3974
|
* @public
|
|
3975
3975
|
*/
|
|
3976
|
-
items?: UsagePlan[];
|
|
3976
|
+
items?: UsagePlan[] | undefined;
|
|
3977
3977
|
/**
|
|
3978
3978
|
* <p>The current pagination position in the paged result set.</p>
|
|
3979
3979
|
* @public
|
|
3980
3980
|
*/
|
|
3981
|
-
position?: string;
|
|
3981
|
+
position?: string | undefined;
|
|
3982
3982
|
}
|
|
3983
3983
|
/**
|
|
3984
3984
|
* <p>Gets a specified VPC link under the caller's account in a region.</p>
|
|
@@ -4000,12 +4000,12 @@ export interface GetVpcLinksRequest {
|
|
|
4000
4000
|
* <p>The current pagination position in the paged result set.</p>
|
|
4001
4001
|
* @public
|
|
4002
4002
|
*/
|
|
4003
|
-
position?: string;
|
|
4003
|
+
position?: string | undefined;
|
|
4004
4004
|
/**
|
|
4005
4005
|
* <p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>
|
|
4006
4006
|
* @public
|
|
4007
4007
|
*/
|
|
4008
|
-
limit?: number;
|
|
4008
|
+
limit?: number | undefined;
|
|
4009
4009
|
}
|
|
4010
4010
|
/**
|
|
4011
4011
|
* <p>The collection of VPC links under the caller's account in a region.</p>
|
|
@@ -4016,12 +4016,12 @@ export interface VpcLinks {
|
|
|
4016
4016
|
* <p>The current page of elements from this collection.</p>
|
|
4017
4017
|
* @public
|
|
4018
4018
|
*/
|
|
4019
|
-
items?: VpcLink[];
|
|
4019
|
+
items?: VpcLink[] | undefined;
|
|
4020
4020
|
/**
|
|
4021
4021
|
* <p>The current pagination position in the paged result set.</p>
|
|
4022
4022
|
* @public
|
|
4023
4023
|
*/
|
|
4024
|
-
position?: string;
|
|
4024
|
+
position?: string | undefined;
|
|
4025
4025
|
}
|
|
4026
4026
|
/**
|
|
4027
4027
|
* <p>The POST request to import API keys from an external source, such as a CSV-formatted file.</p>
|
|
@@ -4042,7 +4042,7 @@ export interface ImportApiKeysRequest {
|
|
|
4042
4042
|
* <p>A query parameter to indicate whether to rollback ApiKey importation (<code>true</code>) or not (<code>false</code>) when error is encountered.</p>
|
|
4043
4043
|
* @public
|
|
4044
4044
|
*/
|
|
4045
|
-
failOnWarnings?: boolean;
|
|
4045
|
+
failOnWarnings?: boolean | undefined;
|
|
4046
4046
|
}
|
|
4047
4047
|
/**
|
|
4048
4048
|
* <p>A collection of the imported DocumentationPart identifiers.</p>
|
|
@@ -4053,12 +4053,12 @@ export interface DocumentationPartIds {
|
|
|
4053
4053
|
* <p>A list of the returned documentation part identifiers.</p>
|
|
4054
4054
|
* @public
|
|
4055
4055
|
*/
|
|
4056
|
-
ids?: string[];
|
|
4056
|
+
ids?: string[] | undefined;
|
|
4057
4057
|
/**
|
|
4058
4058
|
* <p>A list of warning messages reported during import of documentation parts.</p>
|
|
4059
4059
|
* @public
|
|
4060
4060
|
*/
|
|
4061
|
-
warnings?: string[];
|
|
4061
|
+
warnings?: string[] | undefined;
|
|
4062
4062
|
}
|
|
4063
4063
|
/**
|
|
4064
4064
|
* @public
|
|
@@ -4086,12 +4086,12 @@ export interface ImportDocumentationPartsRequest {
|
|
|
4086
4086
|
* <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>
|
|
4087
4087
|
* @public
|
|
4088
4088
|
*/
|
|
4089
|
-
mode?: PutMode;
|
|
4089
|
+
mode?: PutMode | undefined;
|
|
4090
4090
|
/**
|
|
4091
4091
|
* <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>
|
|
4092
4092
|
* @public
|
|
4093
4093
|
*/
|
|
4094
|
-
failOnWarnings?: boolean;
|
|
4094
|
+
failOnWarnings?: boolean | undefined;
|
|
4095
4095
|
/**
|
|
4096
4096
|
* <p>Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.</p>
|
|
4097
4097
|
* @public
|
|
@@ -4108,7 +4108,7 @@ export interface ImportRestApiRequest {
|
|
|
4108
4108
|
* when a warning is encountered. The default value is <code>false</code>.</p>
|
|
4109
4109
|
* @public
|
|
4110
4110
|
*/
|
|
4111
|
-
failOnWarnings?: boolean;
|
|
4111
|
+
failOnWarnings?: boolean | undefined;
|
|
4112
4112
|
/**
|
|
4113
4113
|
* <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>
|
|
4114
4114
|
* <p> To exclude DocumentationParts from the import, set <code>parameters</code> as <code>ignore=documentation</code>.</p>
|
|
@@ -4116,7 +4116,7 @@ export interface ImportRestApiRequest {
|
|
|
4116
4116
|
* <p> To handle imported <code>basepath</code>, set <code>parameters</code> as <code>basepath=ignore</code>, <code>basepath=prepend</code> or <code>basepath=split</code>.</p>
|
|
4117
4117
|
* @public
|
|
4118
4118
|
*/
|
|
4119
|
-
parameters?: Record<string, string
|
|
4119
|
+
parameters?: Record<string, string> | undefined;
|
|
4120
4120
|
/**
|
|
4121
4121
|
* <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>
|
|
4122
4122
|
* @public
|
|
@@ -4142,17 +4142,17 @@ export interface PutGatewayResponseRequest {
|
|
|
4142
4142
|
* <p>The HTTP status code of the GatewayResponse.</p>
|
|
4143
4143
|
* @public
|
|
4144
4144
|
*/
|
|
4145
|
-
statusCode?: string;
|
|
4145
|
+
statusCode?: string | undefined;
|
|
4146
4146
|
/**
|
|
4147
4147
|
* <p>Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.</p>
|
|
4148
4148
|
* @public
|
|
4149
4149
|
*/
|
|
4150
|
-
responseParameters?: Record<string, string
|
|
4150
|
+
responseParameters?: Record<string, string> | undefined;
|
|
4151
4151
|
/**
|
|
4152
4152
|
* <p>Response templates of the GatewayResponse as a string-to-string map of key-value pairs.</p>
|
|
4153
4153
|
* @public
|
|
4154
4154
|
*/
|
|
4155
|
-
responseTemplates?: Record<string, string
|
|
4155
|
+
responseTemplates?: Record<string, string> | undefined;
|
|
4156
4156
|
}
|
|
4157
4157
|
/**
|
|
4158
4158
|
* <p>Sets up a method's integration.</p>
|
|
@@ -4183,7 +4183,7 @@ export interface PutIntegrationRequest {
|
|
|
4183
4183
|
* <p>The HTTP method for the integration.</p>
|
|
4184
4184
|
* @public
|
|
4185
4185
|
*/
|
|
4186
|
-
integrationHttpMethod?: string;
|
|
4186
|
+
integrationHttpMethod?: string | undefined;
|
|
4187
4187
|
/**
|
|
4188
4188
|
* <p>Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or
|
|
4189
4189
|
* <code>HTTP_PROXY</code> integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the
|
|
@@ -4203,64 +4203,64 @@ export interface PutIntegrationRequest {
|
|
|
4203
4203
|
* <code>arn:aws:apigateway:us-west-2:s3:path/\{bucket\}/\{key\}</code>.</p>
|
|
4204
4204
|
* @public
|
|
4205
4205
|
*/
|
|
4206
|
-
uri?: string;
|
|
4206
|
+
uri?: string | undefined;
|
|
4207
4207
|
/**
|
|
4208
4208
|
* <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>
|
|
4209
4209
|
* @public
|
|
4210
4210
|
*/
|
|
4211
|
-
connectionType?: ConnectionType;
|
|
4211
|
+
connectionType?: ConnectionType | undefined;
|
|
4212
4212
|
/**
|
|
4213
4213
|
* <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>
|
|
4214
4214
|
* @public
|
|
4215
4215
|
*/
|
|
4216
|
-
connectionId?: string;
|
|
4216
|
+
connectionId?: string | undefined;
|
|
4217
4217
|
/**
|
|
4218
4218
|
* <p>Specifies whether credentials are required for a put integration.</p>
|
|
4219
4219
|
* @public
|
|
4220
4220
|
*/
|
|
4221
|
-
credentials?: string;
|
|
4221
|
+
credentials?: string | undefined;
|
|
4222
4222
|
/**
|
|
4223
4223
|
* <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>
|
|
4224
4224
|
* @public
|
|
4225
4225
|
*/
|
|
4226
|
-
requestParameters?: Record<string, string
|
|
4226
|
+
requestParameters?: Record<string, string> | undefined;
|
|
4227
4227
|
/**
|
|
4228
4228
|
* <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>
|
|
4229
4229
|
* @public
|
|
4230
4230
|
*/
|
|
4231
|
-
requestTemplates?: Record<string, string
|
|
4231
|
+
requestTemplates?: Record<string, string> | undefined;
|
|
4232
4232
|
/**
|
|
4233
4233
|
* <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>.
|
|
4234
4234
|
* </p>
|
|
4235
4235
|
* @public
|
|
4236
4236
|
*/
|
|
4237
|
-
passthroughBehavior?: string;
|
|
4237
|
+
passthroughBehavior?: string | undefined;
|
|
4238
4238
|
/**
|
|
4239
4239
|
* <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>
|
|
4240
4240
|
* @public
|
|
4241
4241
|
*/
|
|
4242
|
-
cacheNamespace?: string;
|
|
4242
|
+
cacheNamespace?: string | undefined;
|
|
4243
4243
|
/**
|
|
4244
4244
|
* <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>
|
|
4245
4245
|
* @public
|
|
4246
4246
|
*/
|
|
4247
|
-
cacheKeyParameters?: string[];
|
|
4247
|
+
cacheKeyParameters?: string[] | undefined;
|
|
4248
4248
|
/**
|
|
4249
4249
|
* <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>
|
|
4250
4250
|
* <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>
|
|
4251
4251
|
* @public
|
|
4252
4252
|
*/
|
|
4253
|
-
contentHandling?: ContentHandlingStrategy;
|
|
4253
|
+
contentHandling?: ContentHandlingStrategy | undefined;
|
|
4254
4254
|
/**
|
|
4255
4255
|
* <p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.</p>
|
|
4256
4256
|
* @public
|
|
4257
4257
|
*/
|
|
4258
|
-
timeoutInMillis?: number;
|
|
4258
|
+
timeoutInMillis?: number | undefined;
|
|
4259
4259
|
/**
|
|
4260
4260
|
* <p>Specifies the TLS configuration for an integration.</p>
|
|
4261
4261
|
* @public
|
|
4262
4262
|
*/
|
|
4263
|
-
tlsConfig?: TlsConfig;
|
|
4263
|
+
tlsConfig?: TlsConfig | undefined;
|
|
4264
4264
|
}
|
|
4265
4265
|
/**
|
|
4266
4266
|
* <p>Represents a put integration response request.</p>
|
|
@@ -4291,24 +4291,24 @@ export interface PutIntegrationResponseRequest {
|
|
|
4291
4291
|
* <p>Specifies the selection pattern of a put integration response.</p>
|
|
4292
4292
|
* @public
|
|
4293
4293
|
*/
|
|
4294
|
-
selectionPattern?: string;
|
|
4294
|
+
selectionPattern?: string | undefined;
|
|
4295
4295
|
/**
|
|
4296
4296
|
* <p>A key-value map specifying response parameters that are passed to the method response from the back end.
|
|
4297
4297
|
* 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>
|
|
4298
4298
|
* @public
|
|
4299
4299
|
*/
|
|
4300
|
-
responseParameters?: Record<string, string
|
|
4300
|
+
responseParameters?: Record<string, string> | undefined;
|
|
4301
4301
|
/**
|
|
4302
4302
|
* <p>Specifies a put integration response's templates.</p>
|
|
4303
4303
|
* @public
|
|
4304
4304
|
*/
|
|
4305
|
-
responseTemplates?: Record<string, string
|
|
4305
|
+
responseTemplates?: Record<string, string> | undefined;
|
|
4306
4306
|
/**
|
|
4307
4307
|
* <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>
|
|
4308
4308
|
* <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>
|
|
4309
4309
|
* @public
|
|
4310
4310
|
*/
|
|
4311
|
-
contentHandling?: ContentHandlingStrategy;
|
|
4311
|
+
contentHandling?: ContentHandlingStrategy | undefined;
|
|
4312
4312
|
}
|
|
4313
4313
|
/**
|
|
4314
4314
|
* <p>Request to add a method to an existing Resource resource.</p>
|
|
@@ -4339,37 +4339,37 @@ export interface PutMethodRequest {
|
|
|
4339
4339
|
* <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>
|
|
4340
4340
|
* @public
|
|
4341
4341
|
*/
|
|
4342
|
-
authorizerId?: string;
|
|
4342
|
+
authorizerId?: string | undefined;
|
|
4343
4343
|
/**
|
|
4344
4344
|
* <p>Specifies whether the method required a valid ApiKey.</p>
|
|
4345
4345
|
* @public
|
|
4346
4346
|
*/
|
|
4347
|
-
apiKeyRequired?: boolean;
|
|
4347
|
+
apiKeyRequired?: boolean | undefined;
|
|
4348
4348
|
/**
|
|
4349
4349
|
* <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>
|
|
4350
4350
|
* @public
|
|
4351
4351
|
*/
|
|
4352
|
-
operationName?: string;
|
|
4352
|
+
operationName?: string | undefined;
|
|
4353
4353
|
/**
|
|
4354
4354
|
* <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>
|
|
4355
4355
|
* @public
|
|
4356
4356
|
*/
|
|
4357
|
-
requestParameters?: Record<string, boolean
|
|
4357
|
+
requestParameters?: Record<string, boolean> | undefined;
|
|
4358
4358
|
/**
|
|
4359
4359
|
* <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>
|
|
4360
4360
|
* @public
|
|
4361
4361
|
*/
|
|
4362
|
-
requestModels?: Record<string, string
|
|
4362
|
+
requestModels?: Record<string, string> | undefined;
|
|
4363
4363
|
/**
|
|
4364
4364
|
* <p>The identifier of a RequestValidator for validating the method request.</p>
|
|
4365
4365
|
* @public
|
|
4366
4366
|
*/
|
|
4367
|
-
requestValidatorId?: string;
|
|
4367
|
+
requestValidatorId?: string | undefined;
|
|
4368
4368
|
/**
|
|
4369
4369
|
* <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>
|
|
4370
4370
|
* @public
|
|
4371
4371
|
*/
|
|
4372
|
-
authorizationScopes?: string[];
|
|
4372
|
+
authorizationScopes?: string[] | undefined;
|
|
4373
4373
|
}
|
|
4374
4374
|
/**
|
|
4375
4375
|
* <p>Request to add a MethodResponse to an existing Method resource.</p>
|
|
@@ -4400,12 +4400,12 @@ export interface PutMethodResponseRequest {
|
|
|
4400
4400
|
* <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>
|
|
4401
4401
|
* @public
|
|
4402
4402
|
*/
|
|
4403
|
-
responseParameters?: Record<string, boolean
|
|
4403
|
+
responseParameters?: Record<string, boolean> | undefined;
|
|
4404
4404
|
/**
|
|
4405
4405
|
* <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>
|
|
4406
4406
|
* @public
|
|
4407
4407
|
*/
|
|
4408
|
-
responseModels?: Record<string, string
|
|
4408
|
+
responseModels?: Record<string, string> | undefined;
|
|
4409
4409
|
}
|
|
4410
4410
|
/**
|
|
4411
4411
|
* <p>A PUT request to update an existing API, with external API definitions specified as the request body.</p>
|
|
@@ -4422,18 +4422,18 @@ export interface PutRestApiRequest {
|
|
|
4422
4422
|
* the update mode is "merge".</p>
|
|
4423
4423
|
* @public
|
|
4424
4424
|
*/
|
|
4425
|
-
mode?: PutMode;
|
|
4425
|
+
mode?: PutMode | undefined;
|
|
4426
4426
|
/**
|
|
4427
4427
|
* <p>A query parameter to indicate whether to rollback the API update (<code>true</code>) or not (<code>false</code>)
|
|
4428
4428
|
* when a warning is encountered. The default value is <code>false</code>.</p>
|
|
4429
4429
|
* @public
|
|
4430
4430
|
*/
|
|
4431
|
-
failOnWarnings?: boolean;
|
|
4431
|
+
failOnWarnings?: boolean | undefined;
|
|
4432
4432
|
/**
|
|
4433
4433
|
* <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>
|
|
4434
4434
|
* @public
|
|
4435
4435
|
*/
|
|
4436
|
-
parameters?: Record<string, string
|
|
4436
|
+
parameters?: Record<string, string> | undefined;
|
|
4437
4437
|
/**
|
|
4438
4438
|
* <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>
|
|
4439
4439
|
* @public
|
|
@@ -4475,32 +4475,32 @@ export interface TestInvokeAuthorizerRequest {
|
|
|
4475
4475
|
* <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>
|
|
4476
4476
|
* @public
|
|
4477
4477
|
*/
|
|
4478
|
-
headers?: Record<string, string
|
|
4478
|
+
headers?: Record<string, string> | undefined;
|
|
4479
4479
|
/**
|
|
4480
4480
|
* <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>
|
|
4481
4481
|
* @public
|
|
4482
4482
|
*/
|
|
4483
|
-
multiValueHeaders?: Record<string, string[]
|
|
4483
|
+
multiValueHeaders?: Record<string, string[]> | undefined;
|
|
4484
4484
|
/**
|
|
4485
4485
|
* <p>The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.</p>
|
|
4486
4486
|
* @public
|
|
4487
4487
|
*/
|
|
4488
|
-
pathWithQueryString?: string;
|
|
4488
|
+
pathWithQueryString?: string | undefined;
|
|
4489
4489
|
/**
|
|
4490
4490
|
* <p>The simulated request body of an incoming invocation request.</p>
|
|
4491
4491
|
* @public
|
|
4492
4492
|
*/
|
|
4493
|
-
body?: string;
|
|
4493
|
+
body?: string | undefined;
|
|
4494
4494
|
/**
|
|
4495
4495
|
* <p>A key-value map of stage variables to simulate an invocation on a deployed Stage.</p>
|
|
4496
4496
|
* @public
|
|
4497
4497
|
*/
|
|
4498
|
-
stageVariables?: Record<string, string
|
|
4498
|
+
stageVariables?: Record<string, string> | undefined;
|
|
4499
4499
|
/**
|
|
4500
4500
|
* <p>A key-value map of additional context variables.</p>
|
|
4501
4501
|
* @public
|
|
4502
4502
|
*/
|
|
4503
|
-
additionalContext?: Record<string, string
|
|
4503
|
+
additionalContext?: Record<string, string> | undefined;
|
|
4504
4504
|
}
|
|
4505
4505
|
/**
|
|
4506
4506
|
* <p>Represents the response of the test invoke request for a custom Authorizer</p>
|
|
@@ -4511,37 +4511,37 @@ export interface TestInvokeAuthorizerResponse {
|
|
|
4511
4511
|
* <p>The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.</p>
|
|
4512
4512
|
* @public
|
|
4513
4513
|
*/
|
|
4514
|
-
clientStatus?: number;
|
|
4514
|
+
clientStatus?: number | undefined;
|
|
4515
4515
|
/**
|
|
4516
4516
|
* <p>The API Gateway execution log for the test authorizer request.</p>
|
|
4517
4517
|
* @public
|
|
4518
4518
|
*/
|
|
4519
|
-
log?: string;
|
|
4519
|
+
log?: string | undefined;
|
|
4520
4520
|
/**
|
|
4521
4521
|
* <p>The execution latency, in ms, of the test authorizer request.</p>
|
|
4522
4522
|
* @public
|
|
4523
4523
|
*/
|
|
4524
|
-
latency?: number;
|
|
4524
|
+
latency?: number | undefined;
|
|
4525
4525
|
/**
|
|
4526
4526
|
* <p>The principal identity returned by the Authorizer</p>
|
|
4527
4527
|
* @public
|
|
4528
4528
|
*/
|
|
4529
|
-
principalId?: string;
|
|
4529
|
+
principalId?: string | undefined;
|
|
4530
4530
|
/**
|
|
4531
4531
|
* <p>The JSON policy document returned by the Authorizer</p>
|
|
4532
4532
|
* @public
|
|
4533
4533
|
*/
|
|
4534
|
-
policy?: string;
|
|
4534
|
+
policy?: string | undefined;
|
|
4535
4535
|
/**
|
|
4536
4536
|
* <p>The authorization response.</p>
|
|
4537
4537
|
* @public
|
|
4538
4538
|
*/
|
|
4539
|
-
authorization?: Record<string, string[]
|
|
4539
|
+
authorization?: Record<string, string[]> | undefined;
|
|
4540
4540
|
/**
|
|
4541
4541
|
* <p>The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.</p>
|
|
4542
4542
|
* @public
|
|
4543
4543
|
*/
|
|
4544
|
-
claims?: Record<string, string
|
|
4544
|
+
claims?: Record<string, string> | undefined;
|
|
4545
4545
|
}
|
|
4546
4546
|
/**
|
|
4547
4547
|
* <p>Make a request to simulate the invocation of a Method.</p>
|
|
@@ -4567,32 +4567,32 @@ export interface TestInvokeMethodRequest {
|
|
|
4567
4567
|
* <p>The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.</p>
|
|
4568
4568
|
* @public
|
|
4569
4569
|
*/
|
|
4570
|
-
pathWithQueryString?: string;
|
|
4570
|
+
pathWithQueryString?: string | undefined;
|
|
4571
4571
|
/**
|
|
4572
4572
|
* <p>The simulated request body of an incoming invocation request.</p>
|
|
4573
4573
|
* @public
|
|
4574
4574
|
*/
|
|
4575
|
-
body?: string;
|
|
4575
|
+
body?: string | undefined;
|
|
4576
4576
|
/**
|
|
4577
4577
|
* <p>A key-value map of headers to simulate an incoming invocation request.</p>
|
|
4578
4578
|
* @public
|
|
4579
4579
|
*/
|
|
4580
|
-
headers?: Record<string, string
|
|
4580
|
+
headers?: Record<string, string> | undefined;
|
|
4581
4581
|
/**
|
|
4582
4582
|
* <p>The headers as a map from string to list of values to simulate an incoming invocation request.</p>
|
|
4583
4583
|
* @public
|
|
4584
4584
|
*/
|
|
4585
|
-
multiValueHeaders?: Record<string, string[]
|
|
4585
|
+
multiValueHeaders?: Record<string, string[]> | undefined;
|
|
4586
4586
|
/**
|
|
4587
4587
|
* <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>
|
|
4588
4588
|
* @public
|
|
4589
4589
|
*/
|
|
4590
|
-
clientCertificateId?: string;
|
|
4590
|
+
clientCertificateId?: string | undefined;
|
|
4591
4591
|
/**
|
|
4592
4592
|
* <p>A key-value map of stage variables to simulate an invocation on a deployed Stage.</p>
|
|
4593
4593
|
* @public
|
|
4594
4594
|
*/
|
|
4595
|
-
stageVariables?: Record<string, string
|
|
4595
|
+
stageVariables?: Record<string, string> | undefined;
|
|
4596
4596
|
}
|
|
4597
4597
|
/**
|
|
4598
4598
|
* <p>Represents the response of the test invoke request in the HTTP method.</p>
|
|
@@ -4603,32 +4603,32 @@ export interface TestInvokeMethodResponse {
|
|
|
4603
4603
|
* <p>The HTTP status code.</p>
|
|
4604
4604
|
* @public
|
|
4605
4605
|
*/
|
|
4606
|
-
status?: number;
|
|
4606
|
+
status?: number | undefined;
|
|
4607
4607
|
/**
|
|
4608
4608
|
* <p>The body of the HTTP response.</p>
|
|
4609
4609
|
* @public
|
|
4610
4610
|
*/
|
|
4611
|
-
body?: string;
|
|
4611
|
+
body?: string | undefined;
|
|
4612
4612
|
/**
|
|
4613
4613
|
* <p>The headers of the HTTP response.</p>
|
|
4614
4614
|
* @public
|
|
4615
4615
|
*/
|
|
4616
|
-
headers?: Record<string, string
|
|
4616
|
+
headers?: Record<string, string> | undefined;
|
|
4617
4617
|
/**
|
|
4618
4618
|
* <p>The headers of the HTTP response as a map from string to list of values.</p>
|
|
4619
4619
|
* @public
|
|
4620
4620
|
*/
|
|
4621
|
-
multiValueHeaders?: Record<string, string[]
|
|
4621
|
+
multiValueHeaders?: Record<string, string[]> | undefined;
|
|
4622
4622
|
/**
|
|
4623
4623
|
* <p>The API Gateway execution log for the test invoke request.</p>
|
|
4624
4624
|
* @public
|
|
4625
4625
|
*/
|
|
4626
|
-
log?: string;
|
|
4626
|
+
log?: string | undefined;
|
|
4627
4627
|
/**
|
|
4628
4628
|
* <p>The execution latency, in ms, of the test invoke request.</p>
|
|
4629
4629
|
* @public
|
|
4630
4630
|
*/
|
|
4631
|
-
latency?: number;
|
|
4631
|
+
latency?: number | undefined;
|
|
4632
4632
|
}
|
|
4633
4633
|
/**
|
|
4634
4634
|
* <p>Removes a tag from a given resource.</p>
|
|
@@ -4674,7 +4674,7 @@ export interface PatchOperation {
|
|
|
4674
4674
|
* to apply an unsupported operation on a resource will return an error message..</p>
|
|
4675
4675
|
* @public
|
|
4676
4676
|
*/
|
|
4677
|
-
op?: Op;
|
|
4677
|
+
op?: Op | undefined;
|
|
4678
4678
|
/**
|
|
4679
4679
|
* <p>The op operation's target, as identified by a JSON Pointer value that references a
|
|
4680
4680
|
* location within the targeted resource. For example, if the target resource has an
|
|
@@ -4685,14 +4685,14 @@ export interface PatchOperation {
|
|
|
4685
4685
|
* above. Each op operation can have only one path associated with it.</p>
|
|
4686
4686
|
* @public
|
|
4687
4687
|
*/
|
|
4688
|
-
path?: string;
|
|
4688
|
+
path?: string | undefined;
|
|
4689
4689
|
/**
|
|
4690
4690
|
* <p>The new target value of the update operation. It is applicable for the add or replace
|
|
4691
4691
|
* operation. When using AWS CLI to update a property of a JSON value, enclose the JSON
|
|
4692
4692
|
* object with a pair of single quotes in a Linux shell, e.g., '\{"a": ...\}'.</p>
|
|
4693
4693
|
* @public
|
|
4694
4694
|
*/
|
|
4695
|
-
value?: string;
|
|
4695
|
+
value?: string | undefined;
|
|
4696
4696
|
/**
|
|
4697
4697
|
* <p>The copy update operation's source as identified by a JSON-Pointer value referencing
|
|
4698
4698
|
* the location within the targeted resource to copy the value from. For example, to
|
|
@@ -4701,7 +4701,7 @@ export interface PatchOperation {
|
|
|
4701
4701
|
* "from":"/canarySettings/deploymentId" and "path":"/deploymentId".</p>
|
|
4702
4702
|
* @public
|
|
4703
4703
|
*/
|
|
4704
|
-
from?: string;
|
|
4704
|
+
from?: string | undefined;
|
|
4705
4705
|
}
|
|
4706
4706
|
/**
|
|
4707
4707
|
* <p>Requests API Gateway to change information about the current Account resource.</p>
|
|
@@ -4712,7 +4712,7 @@ export interface UpdateAccountRequest {
|
|
|
4712
4712
|
* <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>
|
|
4713
4713
|
* @public
|
|
4714
4714
|
*/
|
|
4715
|
-
patchOperations?: PatchOperation[];
|
|
4715
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
4716
4716
|
}
|
|
4717
4717
|
/**
|
|
4718
4718
|
* <p>A request to change information about an ApiKey resource.</p>
|
|
@@ -4728,7 +4728,7 @@ export interface UpdateApiKeyRequest {
|
|
|
4728
4728
|
* <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>
|
|
4729
4729
|
* @public
|
|
4730
4730
|
*/
|
|
4731
|
-
patchOperations?: PatchOperation[];
|
|
4731
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
4732
4732
|
}
|
|
4733
4733
|
/**
|
|
4734
4734
|
* <p>Request to update an existing Authorizer resource.</p>
|
|
@@ -4749,7 +4749,7 @@ export interface UpdateAuthorizerRequest {
|
|
|
4749
4749
|
* <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>
|
|
4750
4750
|
* @public
|
|
4751
4751
|
*/
|
|
4752
|
-
patchOperations?: PatchOperation[];
|
|
4752
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
4753
4753
|
}
|
|
4754
4754
|
/**
|
|
4755
4755
|
* <p>A request to change information about the BasePathMapping resource.</p>
|
|
@@ -4771,7 +4771,7 @@ export interface UpdateBasePathMappingRequest {
|
|
|
4771
4771
|
* <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>
|
|
4772
4772
|
* @public
|
|
4773
4773
|
*/
|
|
4774
|
-
patchOperations?: PatchOperation[];
|
|
4774
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
4775
4775
|
}
|
|
4776
4776
|
/**
|
|
4777
4777
|
* <p>A request to change information about an ClientCertificate resource.</p>
|
|
@@ -4787,7 +4787,7 @@ export interface UpdateClientCertificateRequest {
|
|
|
4787
4787
|
* <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>
|
|
4788
4788
|
* @public
|
|
4789
4789
|
*/
|
|
4790
|
-
patchOperations?: PatchOperation[];
|
|
4790
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
4791
4791
|
}
|
|
4792
4792
|
/**
|
|
4793
4793
|
* <p>Requests API Gateway to change information about a Deployment resource.</p>
|
|
@@ -4808,7 +4808,7 @@ export interface UpdateDeploymentRequest {
|
|
|
4808
4808
|
* <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>
|
|
4809
4809
|
* @public
|
|
4810
4810
|
*/
|
|
4811
|
-
patchOperations?: PatchOperation[];
|
|
4811
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
4812
4812
|
}
|
|
4813
4813
|
/**
|
|
4814
4814
|
* <p>Updates an existing documentation part of a given API.</p>
|
|
@@ -4829,7 +4829,7 @@ export interface UpdateDocumentationPartRequest {
|
|
|
4829
4829
|
* <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>
|
|
4830
4830
|
* @public
|
|
4831
4831
|
*/
|
|
4832
|
-
patchOperations?: PatchOperation[];
|
|
4832
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
4833
4833
|
}
|
|
4834
4834
|
/**
|
|
4835
4835
|
* <p>Updates an existing documentation version of an API.</p>
|
|
@@ -4850,7 +4850,7 @@ export interface UpdateDocumentationVersionRequest {
|
|
|
4850
4850
|
* <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>
|
|
4851
4851
|
* @public
|
|
4852
4852
|
*/
|
|
4853
|
-
patchOperations?: PatchOperation[];
|
|
4853
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
4854
4854
|
}
|
|
4855
4855
|
/**
|
|
4856
4856
|
* <p>A request to change information about the DomainName resource.</p>
|
|
@@ -4866,7 +4866,7 @@ export interface UpdateDomainNameRequest {
|
|
|
4866
4866
|
* <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>
|
|
4867
4867
|
* @public
|
|
4868
4868
|
*/
|
|
4869
|
-
patchOperations?: PatchOperation[];
|
|
4869
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
4870
4870
|
}
|
|
4871
4871
|
/**
|
|
4872
4872
|
* <p>Updates a GatewayResponse of a specified response type on the given RestApi.</p>
|
|
@@ -4887,7 +4887,7 @@ export interface UpdateGatewayResponseRequest {
|
|
|
4887
4887
|
* <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>
|
|
4888
4888
|
* @public
|
|
4889
4889
|
*/
|
|
4890
|
-
patchOperations?: PatchOperation[];
|
|
4890
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
4891
4891
|
}
|
|
4892
4892
|
/**
|
|
4893
4893
|
* <p>Represents an update integration request.</p>
|
|
@@ -4913,7 +4913,7 @@ export interface UpdateIntegrationRequest {
|
|
|
4913
4913
|
* <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>
|
|
4914
4914
|
* @public
|
|
4915
4915
|
*/
|
|
4916
|
-
patchOperations?: PatchOperation[];
|
|
4916
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
4917
4917
|
}
|
|
4918
4918
|
/**
|
|
4919
4919
|
* <p>Represents an update integration response request.</p>
|
|
@@ -4944,7 +4944,7 @@ export interface UpdateIntegrationResponseRequest {
|
|
|
4944
4944
|
* <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>
|
|
4945
4945
|
* @public
|
|
4946
4946
|
*/
|
|
4947
|
-
patchOperations?: PatchOperation[];
|
|
4947
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
4948
4948
|
}
|
|
4949
4949
|
/**
|
|
4950
4950
|
* <p>Request to update an existing Method resource.</p>
|
|
@@ -4970,7 +4970,7 @@ export interface UpdateMethodRequest {
|
|
|
4970
4970
|
* <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>
|
|
4971
4971
|
* @public
|
|
4972
4972
|
*/
|
|
4973
|
-
patchOperations?: PatchOperation[];
|
|
4973
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
4974
4974
|
}
|
|
4975
4975
|
/**
|
|
4976
4976
|
* <p>A request to update an existing MethodResponse resource.</p>
|
|
@@ -5001,7 +5001,7 @@ export interface UpdateMethodResponseRequest {
|
|
|
5001
5001
|
* <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>
|
|
5002
5002
|
* @public
|
|
5003
5003
|
*/
|
|
5004
|
-
patchOperations?: PatchOperation[];
|
|
5004
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
5005
5005
|
}
|
|
5006
5006
|
/**
|
|
5007
5007
|
* <p>Request to update an existing model in an existing RestApi resource.</p>
|
|
@@ -5022,7 +5022,7 @@ export interface UpdateModelRequest {
|
|
|
5022
5022
|
* <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>
|
|
5023
5023
|
* @public
|
|
5024
5024
|
*/
|
|
5025
|
-
patchOperations?: PatchOperation[];
|
|
5025
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
5026
5026
|
}
|
|
5027
5027
|
/**
|
|
5028
5028
|
* <p>Updates a RequestValidator of a given RestApi.</p>
|
|
@@ -5043,7 +5043,7 @@ export interface UpdateRequestValidatorRequest {
|
|
|
5043
5043
|
* <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>
|
|
5044
5044
|
* @public
|
|
5045
5045
|
*/
|
|
5046
|
-
patchOperations?: PatchOperation[];
|
|
5046
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
5047
5047
|
}
|
|
5048
5048
|
/**
|
|
5049
5049
|
* <p>Request to change information about a Resource resource.</p>
|
|
@@ -5064,7 +5064,7 @@ export interface UpdateResourceRequest {
|
|
|
5064
5064
|
* <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>
|
|
5065
5065
|
* @public
|
|
5066
5066
|
*/
|
|
5067
|
-
patchOperations?: PatchOperation[];
|
|
5067
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
5068
5068
|
}
|
|
5069
5069
|
/**
|
|
5070
5070
|
* <p>Request to update an existing RestApi resource in your collection.</p>
|
|
@@ -5080,7 +5080,7 @@ export interface UpdateRestApiRequest {
|
|
|
5080
5080
|
* <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>
|
|
5081
5081
|
* @public
|
|
5082
5082
|
*/
|
|
5083
|
-
patchOperations?: PatchOperation[];
|
|
5083
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
5084
5084
|
}
|
|
5085
5085
|
/**
|
|
5086
5086
|
* <p>Requests API Gateway to change information about a Stage resource.</p>
|
|
@@ -5101,7 +5101,7 @@ export interface UpdateStageRequest {
|
|
|
5101
5101
|
* <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>
|
|
5102
5102
|
* @public
|
|
5103
5103
|
*/
|
|
5104
|
-
patchOperations?: PatchOperation[];
|
|
5104
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
5105
5105
|
}
|
|
5106
5106
|
/**
|
|
5107
5107
|
* <p>The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.</p>
|
|
@@ -5122,7 +5122,7 @@ export interface UpdateUsageRequest {
|
|
|
5122
5122
|
* <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>
|
|
5123
5123
|
* @public
|
|
5124
5124
|
*/
|
|
5125
|
-
patchOperations?: PatchOperation[];
|
|
5125
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
5126
5126
|
}
|
|
5127
5127
|
/**
|
|
5128
5128
|
* <p>The PATCH request to update a usage plan of a given plan Id.</p>
|
|
@@ -5138,7 +5138,7 @@ export interface UpdateUsagePlanRequest {
|
|
|
5138
5138
|
* <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>
|
|
5139
5139
|
* @public
|
|
5140
5140
|
*/
|
|
5141
|
-
patchOperations?: PatchOperation[];
|
|
5141
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
5142
5142
|
}
|
|
5143
5143
|
/**
|
|
5144
5144
|
* <p>Updates an existing VpcLink of a specified identifier.</p>
|
|
@@ -5154,5 +5154,5 @@ export interface UpdateVpcLinkRequest {
|
|
|
5154
5154
|
* <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>
|
|
5155
5155
|
* @public
|
|
5156
5156
|
*/
|
|
5157
|
-
patchOperations?: PatchOperation[];
|
|
5157
|
+
patchOperations?: PatchOperation[] | undefined;
|
|
5158
5158
|
}
|