@aws-sdk/client-apigatewayv2 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 +717 -717
- package/dist-types/ts3.4/models/models_0.d.ts +717 -717
- package/package.json +7 -7
|
@@ -9,32 +9,32 @@ export interface Cors {
|
|
|
9
9
|
* <p>Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.</p>
|
|
10
10
|
* @public
|
|
11
11
|
*/
|
|
12
|
-
AllowCredentials?: boolean;
|
|
12
|
+
AllowCredentials?: boolean | undefined;
|
|
13
13
|
/**
|
|
14
14
|
* <p>Represents a collection of allowed headers. Supported only for HTTP APIs.</p>
|
|
15
15
|
* @public
|
|
16
16
|
*/
|
|
17
|
-
AllowHeaders?: string[];
|
|
17
|
+
AllowHeaders?: string[] | undefined;
|
|
18
18
|
/**
|
|
19
19
|
* <p>Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.</p>
|
|
20
20
|
* @public
|
|
21
21
|
*/
|
|
22
|
-
AllowMethods?: string[];
|
|
22
|
+
AllowMethods?: string[] | undefined;
|
|
23
23
|
/**
|
|
24
24
|
* <p>Represents a collection of allowed origins. Supported only for HTTP APIs.</p>
|
|
25
25
|
* @public
|
|
26
26
|
*/
|
|
27
|
-
AllowOrigins?: string[];
|
|
27
|
+
AllowOrigins?: string[] | undefined;
|
|
28
28
|
/**
|
|
29
29
|
* <p>Represents a collection of exposed headers. Supported only for HTTP APIs.</p>
|
|
30
30
|
* @public
|
|
31
31
|
*/
|
|
32
|
-
ExposeHeaders?: string[];
|
|
32
|
+
ExposeHeaders?: string[] | undefined;
|
|
33
33
|
/**
|
|
34
34
|
* <p>The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.</p>
|
|
35
35
|
* @public
|
|
36
36
|
*/
|
|
37
|
-
MaxAge?: number;
|
|
37
|
+
MaxAge?: number | undefined;
|
|
38
38
|
}
|
|
39
39
|
/**
|
|
40
40
|
* @public
|
|
@@ -57,52 +57,52 @@ export interface Api {
|
|
|
57
57
|
* <p>The URI of the API, of the form \{api-id\}.execute-api.\{region\}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>
|
|
58
58
|
* @public
|
|
59
59
|
*/
|
|
60
|
-
ApiEndpoint?: string;
|
|
60
|
+
ApiEndpoint?: string | undefined;
|
|
61
61
|
/**
|
|
62
62
|
* <p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>
|
|
63
63
|
* @public
|
|
64
64
|
*/
|
|
65
|
-
ApiGatewayManaged?: boolean;
|
|
65
|
+
ApiGatewayManaged?: boolean | undefined;
|
|
66
66
|
/**
|
|
67
67
|
* <p>The API ID.</p>
|
|
68
68
|
* @public
|
|
69
69
|
*/
|
|
70
|
-
ApiId?: string;
|
|
70
|
+
ApiId?: string | undefined;
|
|
71
71
|
/**
|
|
72
72
|
* <p>An API key selection expression. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">API Key Selection Expressions</a>.</p>
|
|
73
73
|
* @public
|
|
74
74
|
*/
|
|
75
|
-
ApiKeySelectionExpression?: string;
|
|
75
|
+
ApiKeySelectionExpression?: string | undefined;
|
|
76
76
|
/**
|
|
77
77
|
* <p>A CORS configuration. Supported only for HTTP APIs.</p>
|
|
78
78
|
* @public
|
|
79
79
|
*/
|
|
80
|
-
CorsConfiguration?: Cors;
|
|
80
|
+
CorsConfiguration?: Cors | undefined;
|
|
81
81
|
/**
|
|
82
82
|
* <p>The timestamp when the API was created.</p>
|
|
83
83
|
* @public
|
|
84
84
|
*/
|
|
85
|
-
CreatedDate?: Date;
|
|
85
|
+
CreatedDate?: Date | undefined;
|
|
86
86
|
/**
|
|
87
87
|
* <p>The description of the API.</p>
|
|
88
88
|
* @public
|
|
89
89
|
*/
|
|
90
|
-
Description?: string;
|
|
90
|
+
Description?: string | undefined;
|
|
91
91
|
/**
|
|
92
92
|
* <p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>
|
|
93
93
|
* @public
|
|
94
94
|
*/
|
|
95
|
-
DisableSchemaValidation?: boolean;
|
|
95
|
+
DisableSchemaValidation?: boolean | undefined;
|
|
96
96
|
/**
|
|
97
97
|
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://\{api_id\}.execute-api.\{region\}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
|
|
98
98
|
* @public
|
|
99
99
|
*/
|
|
100
|
-
DisableExecuteApiEndpoint?: boolean;
|
|
100
|
+
DisableExecuteApiEndpoint?: boolean | undefined;
|
|
101
101
|
/**
|
|
102
102
|
* <p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>
|
|
103
103
|
* @public
|
|
104
104
|
*/
|
|
105
|
-
ImportInfo?: string[];
|
|
105
|
+
ImportInfo?: string[] | undefined;
|
|
106
106
|
/**
|
|
107
107
|
* <p>The name of the API.</p>
|
|
108
108
|
* @public
|
|
@@ -122,17 +122,17 @@ export interface Api {
|
|
|
122
122
|
* <p>A collection of tags associated with the API.</p>
|
|
123
123
|
* @public
|
|
124
124
|
*/
|
|
125
|
-
Tags?: Record<string, string
|
|
125
|
+
Tags?: Record<string, string> | undefined;
|
|
126
126
|
/**
|
|
127
127
|
* <p>A version identifier for the API.</p>
|
|
128
128
|
* @public
|
|
129
129
|
*/
|
|
130
|
-
Version?: string;
|
|
130
|
+
Version?: string | undefined;
|
|
131
131
|
/**
|
|
132
132
|
* <p>The warning messages reported when failonwarnings is turned on during API import.</p>
|
|
133
133
|
* @public
|
|
134
134
|
*/
|
|
135
|
-
Warnings?: string[];
|
|
135
|
+
Warnings?: string[] | undefined;
|
|
136
136
|
}
|
|
137
137
|
/**
|
|
138
138
|
* <p>Represents an API mapping.</p>
|
|
@@ -148,12 +148,12 @@ export interface ApiMapping {
|
|
|
148
148
|
* <p>The API mapping identifier.</p>
|
|
149
149
|
* @public
|
|
150
150
|
*/
|
|
151
|
-
ApiMappingId?: string;
|
|
151
|
+
ApiMappingId?: string | undefined;
|
|
152
152
|
/**
|
|
153
153
|
* <p>The API mapping key.</p>
|
|
154
154
|
* @public
|
|
155
155
|
*/
|
|
156
|
-
ApiMappingKey?: string;
|
|
156
|
+
ApiMappingKey?: string | undefined;
|
|
157
157
|
/**
|
|
158
158
|
* <p>The API stage.</p>
|
|
159
159
|
* @public
|
|
@@ -181,13 +181,13 @@ export interface JWTConfiguration {
|
|
|
181
181
|
* <p>A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See <a href="https://tools.ietf.org/html/rfc7519#section-4.1.3">RFC 7519</a>. Supported only for HTTP APIs.</p>
|
|
182
182
|
* @public
|
|
183
183
|
*/
|
|
184
|
-
Audience?: string[];
|
|
184
|
+
Audience?: string[] | undefined;
|
|
185
185
|
/**
|
|
186
186
|
* <p>The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.<replaceable>\{region\}</replaceable>.amazonaws.com/<replaceable>\{userPoolId\}</replaceable>
|
|
187
187
|
* . Required for the JWT authorizer type. Supported only for HTTP APIs.</p>
|
|
188
188
|
* @public
|
|
189
189
|
*/
|
|
190
|
-
Issuer?: string;
|
|
190
|
+
Issuer?: string | undefined;
|
|
191
191
|
}
|
|
192
192
|
/**
|
|
193
193
|
* <p>Represents an authorizer.</p>
|
|
@@ -198,53 +198,53 @@ export interface Authorizer {
|
|
|
198
198
|
* <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, don't specify this parameter. Supported only for REQUEST authorizers.</p>
|
|
199
199
|
* @public
|
|
200
200
|
*/
|
|
201
|
-
AuthorizerCredentialsArn?: string;
|
|
201
|
+
AuthorizerCredentialsArn?: string | undefined;
|
|
202
202
|
/**
|
|
203
203
|
* <p>The authorizer identifier.</p>
|
|
204
204
|
* @public
|
|
205
205
|
*/
|
|
206
|
-
AuthorizerId?: string;
|
|
206
|
+
AuthorizerId?: string | undefined;
|
|
207
207
|
/**
|
|
208
208
|
* <p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>
|
|
209
209
|
* @public
|
|
210
210
|
*/
|
|
211
|
-
AuthorizerPayloadFormatVersion?: string;
|
|
211
|
+
AuthorizerPayloadFormatVersion?: string | undefined;
|
|
212
212
|
/**
|
|
213
213
|
* <p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>
|
|
214
214
|
* @public
|
|
215
215
|
*/
|
|
216
|
-
AuthorizerResultTtlInSeconds?: number;
|
|
216
|
+
AuthorizerResultTtlInSeconds?: number | undefined;
|
|
217
217
|
/**
|
|
218
218
|
* <p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>
|
|
219
219
|
* @public
|
|
220
220
|
*/
|
|
221
|
-
AuthorizerType?: AuthorizerType;
|
|
221
|
+
AuthorizerType?: AuthorizerType | undefined;
|
|
222
222
|
/**
|
|
223
223
|
* <p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>\{account_id\}</replaceable>:function:<replaceable>\{lambda_function_name\}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>\{region\}</replaceable>:lambda:path/<replaceable>\{service_api\}</replaceable>
|
|
224
224
|
* , where <replaceable></replaceable>\{region\} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>
|
|
225
225
|
* @public
|
|
226
226
|
*/
|
|
227
|
-
AuthorizerUri?: string;
|
|
227
|
+
AuthorizerUri?: string | undefined;
|
|
228
228
|
/**
|
|
229
229
|
* <p>Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a></p>
|
|
230
230
|
* @public
|
|
231
231
|
*/
|
|
232
|
-
EnableSimpleResponses?: boolean;
|
|
232
|
+
EnableSimpleResponses?: boolean | undefined;
|
|
233
233
|
/**
|
|
234
234
|
* <p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>
|
|
235
235
|
* @public
|
|
236
236
|
*/
|
|
237
|
-
IdentitySource?: string[];
|
|
237
|
+
IdentitySource?: string[] | undefined;
|
|
238
238
|
/**
|
|
239
239
|
* <p>The validation expression does not apply to the REQUEST authorizer.</p>
|
|
240
240
|
* @public
|
|
241
241
|
*/
|
|
242
|
-
IdentityValidationExpression?: string;
|
|
242
|
+
IdentityValidationExpression?: string | undefined;
|
|
243
243
|
/**
|
|
244
244
|
* <p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>
|
|
245
245
|
* @public
|
|
246
246
|
*/
|
|
247
|
-
JwtConfiguration?: JWTConfiguration;
|
|
247
|
+
JwtConfiguration?: JWTConfiguration | undefined;
|
|
248
248
|
/**
|
|
249
249
|
* <p>The name of the authorizer.</p>
|
|
250
250
|
* @public
|
|
@@ -273,32 +273,32 @@ export interface Deployment {
|
|
|
273
273
|
* <p>Specifies whether a deployment was automatically released.</p>
|
|
274
274
|
* @public
|
|
275
275
|
*/
|
|
276
|
-
AutoDeployed?: boolean;
|
|
276
|
+
AutoDeployed?: boolean | undefined;
|
|
277
277
|
/**
|
|
278
278
|
* <p>The date and time when the Deployment resource was created.</p>
|
|
279
279
|
* @public
|
|
280
280
|
*/
|
|
281
|
-
CreatedDate?: Date;
|
|
281
|
+
CreatedDate?: Date | undefined;
|
|
282
282
|
/**
|
|
283
283
|
* <p>The identifier for the deployment.</p>
|
|
284
284
|
* @public
|
|
285
285
|
*/
|
|
286
|
-
DeploymentId?: string;
|
|
286
|
+
DeploymentId?: string | undefined;
|
|
287
287
|
/**
|
|
288
288
|
* <p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>
|
|
289
289
|
* @public
|
|
290
290
|
*/
|
|
291
|
-
DeploymentStatus?: DeploymentStatus;
|
|
291
|
+
DeploymentStatus?: DeploymentStatus | undefined;
|
|
292
292
|
/**
|
|
293
293
|
* <p>May contain additional feedback on the status of an API deployment.</p>
|
|
294
294
|
* @public
|
|
295
295
|
*/
|
|
296
|
-
DeploymentStatusMessage?: string;
|
|
296
|
+
DeploymentStatusMessage?: string | undefined;
|
|
297
297
|
/**
|
|
298
298
|
* <p>The description for the deployment.</p>
|
|
299
299
|
* @public
|
|
300
300
|
*/
|
|
301
|
-
Description?: string;
|
|
301
|
+
Description?: string | undefined;
|
|
302
302
|
}
|
|
303
303
|
/**
|
|
304
304
|
* @public
|
|
@@ -347,52 +347,52 @@ export interface DomainNameConfiguration {
|
|
|
347
347
|
* <p>A domain name for the API.</p>
|
|
348
348
|
* @public
|
|
349
349
|
*/
|
|
350
|
-
ApiGatewayDomainName?: string;
|
|
350
|
+
ApiGatewayDomainName?: string | undefined;
|
|
351
351
|
/**
|
|
352
352
|
* <p>An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.</p>
|
|
353
353
|
* @public
|
|
354
354
|
*/
|
|
355
|
-
CertificateArn?: string;
|
|
355
|
+
CertificateArn?: string | undefined;
|
|
356
356
|
/**
|
|
357
357
|
* <p>The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.</p>
|
|
358
358
|
* @public
|
|
359
359
|
*/
|
|
360
|
-
CertificateName?: string;
|
|
360
|
+
CertificateName?: string | undefined;
|
|
361
361
|
/**
|
|
362
362
|
* <p>The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.</p>
|
|
363
363
|
* @public
|
|
364
364
|
*/
|
|
365
|
-
CertificateUploadDate?: Date;
|
|
365
|
+
CertificateUploadDate?: Date | undefined;
|
|
366
366
|
/**
|
|
367
367
|
* <p>The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.</p>
|
|
368
368
|
* @public
|
|
369
369
|
*/
|
|
370
|
-
DomainNameStatus?: DomainNameStatus;
|
|
370
|
+
DomainNameStatus?: DomainNameStatus | undefined;
|
|
371
371
|
/**
|
|
372
372
|
* <p>An optional text message containing detailed information about status of the domain name migration.</p>
|
|
373
373
|
* @public
|
|
374
374
|
*/
|
|
375
|
-
DomainNameStatusMessage?: string;
|
|
375
|
+
DomainNameStatusMessage?: string | undefined;
|
|
376
376
|
/**
|
|
377
377
|
* <p>The endpoint type.</p>
|
|
378
378
|
* @public
|
|
379
379
|
*/
|
|
380
|
-
EndpointType?: EndpointType;
|
|
380
|
+
EndpointType?: EndpointType | undefined;
|
|
381
381
|
/**
|
|
382
382
|
* <p>The Amazon Route 53 Hosted Zone ID of the endpoint.</p>
|
|
383
383
|
* @public
|
|
384
384
|
*/
|
|
385
|
-
HostedZoneId?: string;
|
|
385
|
+
HostedZoneId?: string | undefined;
|
|
386
386
|
/**
|
|
387
387
|
* <p>The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.</p>
|
|
388
388
|
* @public
|
|
389
389
|
*/
|
|
390
|
-
SecurityPolicy?: SecurityPolicy;
|
|
390
|
+
SecurityPolicy?: SecurityPolicy | undefined;
|
|
391
391
|
/**
|
|
392
392
|
* <p>The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn</p>
|
|
393
393
|
* @public
|
|
394
394
|
*/
|
|
395
|
-
OwnershipVerificationCertificateArn?: string;
|
|
395
|
+
OwnershipVerificationCertificateArn?: string | undefined;
|
|
396
396
|
}
|
|
397
397
|
/**
|
|
398
398
|
* @public
|
|
@@ -402,17 +402,17 @@ export interface MutualTlsAuthentication {
|
|
|
402
402
|
* <p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>bucket-name</replaceable>/<replaceable>key-name</replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</p>
|
|
403
403
|
* @public
|
|
404
404
|
*/
|
|
405
|
-
TruststoreUri?: string;
|
|
405
|
+
TruststoreUri?: string | undefined;
|
|
406
406
|
/**
|
|
407
407
|
* <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>
|
|
408
408
|
* @public
|
|
409
409
|
*/
|
|
410
|
-
TruststoreVersion?: string;
|
|
410
|
+
TruststoreVersion?: string | undefined;
|
|
411
411
|
/**
|
|
412
412
|
* <p>A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.</p>
|
|
413
413
|
* @public
|
|
414
414
|
*/
|
|
415
|
-
TruststoreWarnings?: string[];
|
|
415
|
+
TruststoreWarnings?: string[] | undefined;
|
|
416
416
|
}
|
|
417
417
|
/**
|
|
418
418
|
* <p>Represents a domain name.</p>
|
|
@@ -423,7 +423,7 @@ export interface DomainName {
|
|
|
423
423
|
* <p>The API mapping selection expression.</p>
|
|
424
424
|
* @public
|
|
425
425
|
*/
|
|
426
|
-
ApiMappingSelectionExpression?: string;
|
|
426
|
+
ApiMappingSelectionExpression?: string | undefined;
|
|
427
427
|
/**
|
|
428
428
|
* <p>The name of the DomainName resource.</p>
|
|
429
429
|
* @public
|
|
@@ -433,17 +433,17 @@ export interface DomainName {
|
|
|
433
433
|
* <p>The domain name configurations.</p>
|
|
434
434
|
* @public
|
|
435
435
|
*/
|
|
436
|
-
DomainNameConfigurations?: DomainNameConfiguration[];
|
|
436
|
+
DomainNameConfigurations?: DomainNameConfiguration[] | undefined;
|
|
437
437
|
/**
|
|
438
438
|
* <p>The mutual TLS authentication configuration for a custom domain name.</p>
|
|
439
439
|
* @public
|
|
440
440
|
*/
|
|
441
|
-
MutualTlsAuthentication?: MutualTlsAuthentication;
|
|
441
|
+
MutualTlsAuthentication?: MutualTlsAuthentication | undefined;
|
|
442
442
|
/**
|
|
443
443
|
* <p>The collection of tags associated with a domain name.</p>
|
|
444
444
|
* @public
|
|
445
445
|
*/
|
|
446
|
-
Tags?: Record<string, string
|
|
446
|
+
Tags?: Record<string, string> | undefined;
|
|
447
447
|
}
|
|
448
448
|
/**
|
|
449
449
|
* @public
|
|
@@ -506,7 +506,7 @@ export interface TlsConfig {
|
|
|
506
506
|
* <p>If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.</p>
|
|
507
507
|
* @public
|
|
508
508
|
*/
|
|
509
|
-
ServerNameToVerify?: string;
|
|
509
|
+
ServerNameToVerify?: string | undefined;
|
|
510
510
|
}
|
|
511
511
|
/**
|
|
512
512
|
* <p>Represents an integration.</p>
|
|
@@ -517,72 +517,72 @@ export interface Integration {
|
|
|
517
517
|
* <p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>
|
|
518
518
|
* @public
|
|
519
519
|
*/
|
|
520
|
-
ApiGatewayManaged?: boolean;
|
|
520
|
+
ApiGatewayManaged?: boolean | undefined;
|
|
521
521
|
/**
|
|
522
522
|
* <p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>
|
|
523
523
|
* @public
|
|
524
524
|
*/
|
|
525
|
-
ConnectionId?: string;
|
|
525
|
+
ConnectionId?: string | undefined;
|
|
526
526
|
/**
|
|
527
527
|
* <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
|
|
528
528
|
* @public
|
|
529
529
|
*/
|
|
530
|
-
ConnectionType?: ConnectionType;
|
|
530
|
+
ConnectionType?: ConnectionType | undefined;
|
|
531
531
|
/**
|
|
532
532
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
533
533
|
* @public
|
|
534
534
|
*/
|
|
535
|
-
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
535
|
+
ContentHandlingStrategy?: ContentHandlingStrategy | undefined;
|
|
536
536
|
/**
|
|
537
537
|
* <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 arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>
|
|
538
538
|
* @public
|
|
539
539
|
*/
|
|
540
|
-
CredentialsArn?: string;
|
|
540
|
+
CredentialsArn?: string | undefined;
|
|
541
541
|
/**
|
|
542
542
|
* <p>Represents the description of an integration.</p>
|
|
543
543
|
* @public
|
|
544
544
|
*/
|
|
545
|
-
Description?: string;
|
|
545
|
+
Description?: string | undefined;
|
|
546
546
|
/**
|
|
547
547
|
* <p>Represents the identifier of an integration.</p>
|
|
548
548
|
* @public
|
|
549
549
|
*/
|
|
550
|
-
IntegrationId?: string;
|
|
550
|
+
IntegrationId?: string | undefined;
|
|
551
551
|
/**
|
|
552
552
|
* <p>Specifies the integration's HTTP method type.</p>
|
|
553
553
|
* @public
|
|
554
554
|
*/
|
|
555
|
-
IntegrationMethod?: string;
|
|
555
|
+
IntegrationMethod?: string | undefined;
|
|
556
556
|
/**
|
|
557
557
|
* <p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions">Integration Response Selection Expressions</a>.</p>
|
|
558
558
|
* @public
|
|
559
559
|
*/
|
|
560
|
-
IntegrationResponseSelectionExpression?: string;
|
|
560
|
+
IntegrationResponseSelectionExpression?: string | undefined;
|
|
561
561
|
/**
|
|
562
562
|
* <p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html">Integration subtype reference</a>.</p>
|
|
563
563
|
* @public
|
|
564
564
|
*/
|
|
565
|
-
IntegrationSubtype?: string;
|
|
565
|
+
IntegrationSubtype?: string | undefined;
|
|
566
566
|
/**
|
|
567
567
|
* <p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
|
|
568
568
|
* @public
|
|
569
569
|
*/
|
|
570
|
-
IntegrationType?: IntegrationType;
|
|
570
|
+
IntegrationType?: IntegrationType | undefined;
|
|
571
571
|
/**
|
|
572
572
|
* <p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
|
|
573
573
|
* @public
|
|
574
574
|
*/
|
|
575
|
-
IntegrationUri?: string;
|
|
575
|
+
IntegrationUri?: string | undefined;
|
|
576
576
|
/**
|
|
577
577
|
* <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 requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>
|
|
578
578
|
* @public
|
|
579
579
|
*/
|
|
580
|
-
PassthroughBehavior?: PassthroughBehavior;
|
|
580
|
+
PassthroughBehavior?: PassthroughBehavior | undefined;
|
|
581
581
|
/**
|
|
582
582
|
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
|
|
583
583
|
* @public
|
|
584
584
|
*/
|
|
585
|
-
PayloadFormatVersion?: string;
|
|
585
|
+
PayloadFormatVersion?: string | undefined;
|
|
586
586
|
/**
|
|
587
587
|
* <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>\{location\}</replaceable>.<replaceable>\{name\}</replaceable>
|
|
588
588
|
* , where
|
|
@@ -592,32 +592,32 @@ export interface Integration {
|
|
|
592
592
|
* must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
|
|
593
593
|
* @public
|
|
594
594
|
*/
|
|
595
|
-
RequestParameters?: Record<string, string
|
|
595
|
+
RequestParameters?: Record<string, string> | undefined;
|
|
596
596
|
/**
|
|
597
597
|
* <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. Supported only for WebSocket APIs.</p>
|
|
598
598
|
* @public
|
|
599
599
|
*/
|
|
600
|
-
RequestTemplates?: Record<string, string
|
|
600
|
+
RequestTemplates?: Record<string, string> | undefined;
|
|
601
601
|
/**
|
|
602
602
|
* <p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
|
|
603
603
|
* @public
|
|
604
604
|
*/
|
|
605
|
-
ResponseParameters?: Record<string, Record<string, string
|
|
605
|
+
ResponseParameters?: Record<string, Record<string, string>> | undefined;
|
|
606
606
|
/**
|
|
607
607
|
* <p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>
|
|
608
608
|
* @public
|
|
609
609
|
*/
|
|
610
|
-
TemplateSelectionExpression?: string;
|
|
610
|
+
TemplateSelectionExpression?: string | undefined;
|
|
611
611
|
/**
|
|
612
612
|
* <p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>
|
|
613
613
|
* @public
|
|
614
614
|
*/
|
|
615
|
-
TimeoutInMillis?: number;
|
|
615
|
+
TimeoutInMillis?: number | undefined;
|
|
616
616
|
/**
|
|
617
617
|
* <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
|
|
618
618
|
* @public
|
|
619
619
|
*/
|
|
620
|
-
TlsConfig?: TlsConfig;
|
|
620
|
+
TlsConfig?: TlsConfig | undefined;
|
|
621
621
|
}
|
|
622
622
|
/**
|
|
623
623
|
* <p>Represents an integration response.</p>
|
|
@@ -628,12 +628,12 @@ export interface IntegrationResponse {
|
|
|
628
628
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
629
629
|
* @public
|
|
630
630
|
*/
|
|
631
|
-
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
631
|
+
ContentHandlingStrategy?: ContentHandlingStrategy | undefined;
|
|
632
632
|
/**
|
|
633
633
|
* <p>The integration response ID.</p>
|
|
634
634
|
* @public
|
|
635
635
|
*/
|
|
636
|
-
IntegrationResponseId?: string;
|
|
636
|
+
IntegrationResponseId?: string | undefined;
|
|
637
637
|
/**
|
|
638
638
|
* <p>The integration response key.</p>
|
|
639
639
|
* @public
|
|
@@ -643,17 +643,17 @@ export interface IntegrationResponse {
|
|
|
643
643
|
* <p>A key-value map specifying response parameters that are passed to the method response from the backend. 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 method.response.header.\{name\}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.\{name\} or integration.response.body.\{JSON-expression\}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.</p>
|
|
644
644
|
* @public
|
|
645
645
|
*/
|
|
646
|
-
ResponseParameters?: Record<string, string
|
|
646
|
+
ResponseParameters?: Record<string, string> | undefined;
|
|
647
647
|
/**
|
|
648
648
|
* <p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>
|
|
649
649
|
* @public
|
|
650
650
|
*/
|
|
651
|
-
ResponseTemplates?: Record<string, string
|
|
651
|
+
ResponseTemplates?: Record<string, string> | undefined;
|
|
652
652
|
/**
|
|
653
653
|
* <p>The template selection expressions for the integration response.</p>
|
|
654
654
|
* @public
|
|
655
655
|
*/
|
|
656
|
-
TemplateSelectionExpression?: string;
|
|
656
|
+
TemplateSelectionExpression?: string | undefined;
|
|
657
657
|
}
|
|
658
658
|
/**
|
|
659
659
|
* <p>Represents a data model for an API. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html">Create Models and Mapping Templates for Request and Response Mappings</a>.</p>
|
|
@@ -664,17 +664,17 @@ export interface Model {
|
|
|
664
664
|
* <p>The content-type for the model, for example, "application/json".</p>
|
|
665
665
|
* @public
|
|
666
666
|
*/
|
|
667
|
-
ContentType?: string;
|
|
667
|
+
ContentType?: string | undefined;
|
|
668
668
|
/**
|
|
669
669
|
* <p>The description of the model.</p>
|
|
670
670
|
* @public
|
|
671
671
|
*/
|
|
672
|
-
Description?: string;
|
|
672
|
+
Description?: string | undefined;
|
|
673
673
|
/**
|
|
674
674
|
* <p>The model identifier.</p>
|
|
675
675
|
* @public
|
|
676
676
|
*/
|
|
677
|
-
ModelId?: string;
|
|
677
|
+
ModelId?: string | undefined;
|
|
678
678
|
/**
|
|
679
679
|
* <p>The name of the model. Must be alphanumeric.</p>
|
|
680
680
|
* @public
|
|
@@ -684,7 +684,7 @@ export interface Model {
|
|
|
684
684
|
* <p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>
|
|
685
685
|
* @public
|
|
686
686
|
*/
|
|
687
|
-
Schema?: string;
|
|
687
|
+
Schema?: string | undefined;
|
|
688
688
|
}
|
|
689
689
|
/**
|
|
690
690
|
* @public
|
|
@@ -709,7 +709,7 @@ export interface ParameterConstraints {
|
|
|
709
709
|
* <p>Whether or not the parameter is required.</p>
|
|
710
710
|
* @public
|
|
711
711
|
*/
|
|
712
|
-
Required?: boolean;
|
|
712
|
+
Required?: boolean | undefined;
|
|
713
713
|
}
|
|
714
714
|
/**
|
|
715
715
|
* <p>Represents a route.</p>
|
|
@@ -720,52 +720,52 @@ export interface Route {
|
|
|
720
720
|
* <p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>
|
|
721
721
|
* @public
|
|
722
722
|
*/
|
|
723
|
-
ApiGatewayManaged?: boolean;
|
|
723
|
+
ApiGatewayManaged?: boolean | undefined;
|
|
724
724
|
/**
|
|
725
725
|
* <p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>
|
|
726
726
|
* @public
|
|
727
727
|
*/
|
|
728
|
-
ApiKeyRequired?: boolean;
|
|
728
|
+
ApiKeyRequired?: boolean | undefined;
|
|
729
729
|
/**
|
|
730
730
|
* <p>A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>
|
|
731
731
|
* @public
|
|
732
732
|
*/
|
|
733
|
-
AuthorizationScopes?: string[];
|
|
733
|
+
AuthorizationScopes?: string[] | undefined;
|
|
734
734
|
/**
|
|
735
735
|
* <p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>
|
|
736
736
|
* @public
|
|
737
737
|
*/
|
|
738
|
-
AuthorizationType?: AuthorizationType;
|
|
738
|
+
AuthorizationType?: AuthorizationType | undefined;
|
|
739
739
|
/**
|
|
740
740
|
* <p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>
|
|
741
741
|
* @public
|
|
742
742
|
*/
|
|
743
|
-
AuthorizerId?: string;
|
|
743
|
+
AuthorizerId?: string | undefined;
|
|
744
744
|
/**
|
|
745
745
|
* <p>The model selection expression for the route. Supported only for WebSocket APIs.</p>
|
|
746
746
|
* @public
|
|
747
747
|
*/
|
|
748
|
-
ModelSelectionExpression?: string;
|
|
748
|
+
ModelSelectionExpression?: string | undefined;
|
|
749
749
|
/**
|
|
750
750
|
* <p>The operation name for the route.</p>
|
|
751
751
|
* @public
|
|
752
752
|
*/
|
|
753
|
-
OperationName?: string;
|
|
753
|
+
OperationName?: string | undefined;
|
|
754
754
|
/**
|
|
755
755
|
* <p>The request models for the route. Supported only for WebSocket APIs.</p>
|
|
756
756
|
* @public
|
|
757
757
|
*/
|
|
758
|
-
RequestModels?: Record<string, string
|
|
758
|
+
RequestModels?: Record<string, string> | undefined;
|
|
759
759
|
/**
|
|
760
760
|
* <p>The request parameters for the route. Supported only for WebSocket APIs.</p>
|
|
761
761
|
* @public
|
|
762
762
|
*/
|
|
763
|
-
RequestParameters?: Record<string, ParameterConstraints
|
|
763
|
+
RequestParameters?: Record<string, ParameterConstraints> | undefined;
|
|
764
764
|
/**
|
|
765
765
|
* <p>The route ID.</p>
|
|
766
766
|
* @public
|
|
767
767
|
*/
|
|
768
|
-
RouteId?: string;
|
|
768
|
+
RouteId?: string | undefined;
|
|
769
769
|
/**
|
|
770
770
|
* <p>The route key for the route.</p>
|
|
771
771
|
* @public
|
|
@@ -775,12 +775,12 @@ export interface Route {
|
|
|
775
775
|
* <p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>
|
|
776
776
|
* @public
|
|
777
777
|
*/
|
|
778
|
-
RouteResponseSelectionExpression?: string;
|
|
778
|
+
RouteResponseSelectionExpression?: string | undefined;
|
|
779
779
|
/**
|
|
780
780
|
* <p>The target for the route.</p>
|
|
781
781
|
* @public
|
|
782
782
|
*/
|
|
783
|
-
Target?: string;
|
|
783
|
+
Target?: string | undefined;
|
|
784
784
|
}
|
|
785
785
|
/**
|
|
786
786
|
* <p>Represents a route response.</p>
|
|
@@ -791,22 +791,22 @@ export interface RouteResponse {
|
|
|
791
791
|
* <p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>
|
|
792
792
|
* @public
|
|
793
793
|
*/
|
|
794
|
-
ModelSelectionExpression?: string;
|
|
794
|
+
ModelSelectionExpression?: string | undefined;
|
|
795
795
|
/**
|
|
796
796
|
* <p>Represents the response models of a route response.</p>
|
|
797
797
|
* @public
|
|
798
798
|
*/
|
|
799
|
-
ResponseModels?: Record<string, string
|
|
799
|
+
ResponseModels?: Record<string, string> | undefined;
|
|
800
800
|
/**
|
|
801
801
|
* <p>Represents the response parameters of a route response.</p>
|
|
802
802
|
* @public
|
|
803
803
|
*/
|
|
804
|
-
ResponseParameters?: Record<string, ParameterConstraints
|
|
804
|
+
ResponseParameters?: Record<string, ParameterConstraints> | undefined;
|
|
805
805
|
/**
|
|
806
806
|
* <p>Represents the identifier of a route response.</p>
|
|
807
807
|
* @public
|
|
808
808
|
*/
|
|
809
|
-
RouteResponseId?: string;
|
|
809
|
+
RouteResponseId?: string | undefined;
|
|
810
810
|
/**
|
|
811
811
|
* <p>Represents the route response key of a route response.</p>
|
|
812
812
|
* @public
|
|
@@ -822,12 +822,12 @@ export interface AccessLogSettings {
|
|
|
822
822
|
* <p>The ARN of the CloudWatch Logs log group to receive access logs.</p>
|
|
823
823
|
* @public
|
|
824
824
|
*/
|
|
825
|
-
DestinationArn?: string;
|
|
825
|
+
DestinationArn?: string | undefined;
|
|
826
826
|
/**
|
|
827
827
|
* <p>A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.</p>
|
|
828
828
|
* @public
|
|
829
829
|
*/
|
|
830
|
-
Format?: string;
|
|
830
|
+
Format?: string | undefined;
|
|
831
831
|
}
|
|
832
832
|
/**
|
|
833
833
|
* @public
|
|
@@ -851,27 +851,27 @@ export interface RouteSettings {
|
|
|
851
851
|
* <p>Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.</p>
|
|
852
852
|
* @public
|
|
853
853
|
*/
|
|
854
|
-
DataTraceEnabled?: boolean;
|
|
854
|
+
DataTraceEnabled?: boolean | undefined;
|
|
855
855
|
/**
|
|
856
856
|
* <p>Specifies whether detailed metrics are enabled.</p>
|
|
857
857
|
* @public
|
|
858
858
|
*/
|
|
859
|
-
DetailedMetricsEnabled?: boolean;
|
|
859
|
+
DetailedMetricsEnabled?: boolean | undefined;
|
|
860
860
|
/**
|
|
861
861
|
* <p>Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.</p>
|
|
862
862
|
* @public
|
|
863
863
|
*/
|
|
864
|
-
LoggingLevel?: LoggingLevel;
|
|
864
|
+
LoggingLevel?: LoggingLevel | undefined;
|
|
865
865
|
/**
|
|
866
866
|
* <p>Specifies the throttling burst limit.</p>
|
|
867
867
|
* @public
|
|
868
868
|
*/
|
|
869
|
-
ThrottlingBurstLimit?: number;
|
|
869
|
+
ThrottlingBurstLimit?: number | undefined;
|
|
870
870
|
/**
|
|
871
871
|
* <p>Specifies the throttling rate limit.</p>
|
|
872
872
|
* @public
|
|
873
873
|
*/
|
|
874
|
-
ThrottlingRateLimit?: number;
|
|
874
|
+
ThrottlingRateLimit?: number | undefined;
|
|
875
875
|
}
|
|
876
876
|
/**
|
|
877
877
|
* <p>Represents an API stage.</p>
|
|
@@ -882,57 +882,57 @@ export interface Stage {
|
|
|
882
882
|
* <p>Settings for logging access in this stage.</p>
|
|
883
883
|
* @public
|
|
884
884
|
*/
|
|
885
|
-
AccessLogSettings?: AccessLogSettings;
|
|
885
|
+
AccessLogSettings?: AccessLogSettings | undefined;
|
|
886
886
|
/**
|
|
887
887
|
* <p>Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.</p>
|
|
888
888
|
* @public
|
|
889
889
|
*/
|
|
890
|
-
ApiGatewayManaged?: boolean;
|
|
890
|
+
ApiGatewayManaged?: boolean | undefined;
|
|
891
891
|
/**
|
|
892
892
|
* <p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>
|
|
893
893
|
* @public
|
|
894
894
|
*/
|
|
895
|
-
AutoDeploy?: boolean;
|
|
895
|
+
AutoDeploy?: boolean | undefined;
|
|
896
896
|
/**
|
|
897
897
|
* <p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>
|
|
898
898
|
* @public
|
|
899
899
|
*/
|
|
900
|
-
ClientCertificateId?: string;
|
|
900
|
+
ClientCertificateId?: string | undefined;
|
|
901
901
|
/**
|
|
902
902
|
* <p>The timestamp when the stage was created.</p>
|
|
903
903
|
* @public
|
|
904
904
|
*/
|
|
905
|
-
CreatedDate?: Date;
|
|
905
|
+
CreatedDate?: Date | undefined;
|
|
906
906
|
/**
|
|
907
907
|
* <p>Default route settings for the stage.</p>
|
|
908
908
|
* @public
|
|
909
909
|
*/
|
|
910
|
-
DefaultRouteSettings?: RouteSettings;
|
|
910
|
+
DefaultRouteSettings?: RouteSettings | undefined;
|
|
911
911
|
/**
|
|
912
912
|
* <p>The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.</p>
|
|
913
913
|
* @public
|
|
914
914
|
*/
|
|
915
|
-
DeploymentId?: string;
|
|
915
|
+
DeploymentId?: string | undefined;
|
|
916
916
|
/**
|
|
917
917
|
* <p>The description of the stage.</p>
|
|
918
918
|
* @public
|
|
919
919
|
*/
|
|
920
|
-
Description?: string;
|
|
920
|
+
Description?: string | undefined;
|
|
921
921
|
/**
|
|
922
922
|
* <p>Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.</p>
|
|
923
923
|
* @public
|
|
924
924
|
*/
|
|
925
|
-
LastDeploymentStatusMessage?: string;
|
|
925
|
+
LastDeploymentStatusMessage?: string | undefined;
|
|
926
926
|
/**
|
|
927
927
|
* <p>The timestamp when the stage was last updated.</p>
|
|
928
928
|
* @public
|
|
929
929
|
*/
|
|
930
|
-
LastUpdatedDate?: Date;
|
|
930
|
+
LastUpdatedDate?: Date | undefined;
|
|
931
931
|
/**
|
|
932
932
|
* <p>Route settings for the stage, by routeKey.</p>
|
|
933
933
|
* @public
|
|
934
934
|
*/
|
|
935
|
-
RouteSettings?: Record<string, RouteSettings
|
|
935
|
+
RouteSettings?: Record<string, RouteSettings> | undefined;
|
|
936
936
|
/**
|
|
937
937
|
* <p>The name of the stage.</p>
|
|
938
938
|
* @public
|
|
@@ -942,12 +942,12 @@ export interface Stage {
|
|
|
942
942
|
* <p>A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>
|
|
943
943
|
* @public
|
|
944
944
|
*/
|
|
945
|
-
StageVariables?: Record<string, string
|
|
945
|
+
StageVariables?: Record<string, string> | undefined;
|
|
946
946
|
/**
|
|
947
947
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
948
948
|
* @public
|
|
949
949
|
*/
|
|
950
|
-
Tags?: Record<string, string
|
|
950
|
+
Tags?: Record<string, string> | undefined;
|
|
951
951
|
}
|
|
952
952
|
/**
|
|
953
953
|
* @public
|
|
@@ -984,7 +984,7 @@ export interface VpcLink {
|
|
|
984
984
|
* <p>The timestamp when the VPC link was created.</p>
|
|
985
985
|
* @public
|
|
986
986
|
*/
|
|
987
|
-
CreatedDate?: Date;
|
|
987
|
+
CreatedDate?: Date | undefined;
|
|
988
988
|
/**
|
|
989
989
|
* <p>The name of the VPC link.</p>
|
|
990
990
|
* @public
|
|
@@ -1004,7 +1004,7 @@ export interface VpcLink {
|
|
|
1004
1004
|
* <p>Tags for the VPC link.</p>
|
|
1005
1005
|
* @public
|
|
1006
1006
|
*/
|
|
1007
|
-
Tags?: Record<string, string
|
|
1007
|
+
Tags?: Record<string, string> | undefined;
|
|
1008
1008
|
/**
|
|
1009
1009
|
* <p>The ID of the VPC link.</p>
|
|
1010
1010
|
* @public
|
|
@@ -1014,17 +1014,17 @@ export interface VpcLink {
|
|
|
1014
1014
|
* <p>The status of the VPC link.</p>
|
|
1015
1015
|
* @public
|
|
1016
1016
|
*/
|
|
1017
|
-
VpcLinkStatus?: VpcLinkStatus;
|
|
1017
|
+
VpcLinkStatus?: VpcLinkStatus | undefined;
|
|
1018
1018
|
/**
|
|
1019
1019
|
* <p>A message summarizing the cause of the status of the VPC link.</p>
|
|
1020
1020
|
* @public
|
|
1021
1021
|
*/
|
|
1022
|
-
VpcLinkStatusMessage?: string;
|
|
1022
|
+
VpcLinkStatusMessage?: string | undefined;
|
|
1023
1023
|
/**
|
|
1024
1024
|
* <p>The version of the VPC link.</p>
|
|
1025
1025
|
* @public
|
|
1026
1026
|
*/
|
|
1027
|
-
VpcLinkVersion?: VpcLinkVersion;
|
|
1027
|
+
VpcLinkVersion?: VpcLinkVersion | undefined;
|
|
1028
1028
|
}
|
|
1029
1029
|
/**
|
|
1030
1030
|
* @public
|
|
@@ -1032,7 +1032,7 @@ export interface VpcLink {
|
|
|
1032
1032
|
export declare class AccessDeniedException extends __BaseException {
|
|
1033
1033
|
readonly name: "AccessDeniedException";
|
|
1034
1034
|
readonly $fault: "client";
|
|
1035
|
-
Message?: string;
|
|
1035
|
+
Message?: string | undefined;
|
|
1036
1036
|
/**
|
|
1037
1037
|
* @internal
|
|
1038
1038
|
*/
|
|
@@ -1049,7 +1049,7 @@ export declare class BadRequestException extends __BaseException {
|
|
|
1049
1049
|
* <p>Describes the error encountered.</p>
|
|
1050
1050
|
* @public
|
|
1051
1051
|
*/
|
|
1052
|
-
Message?: string;
|
|
1052
|
+
Message?: string | undefined;
|
|
1053
1053
|
/**
|
|
1054
1054
|
* @internal
|
|
1055
1055
|
*/
|
|
@@ -1066,7 +1066,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
1066
1066
|
* <p>Describes the error encountered.</p>
|
|
1067
1067
|
* @public
|
|
1068
1068
|
*/
|
|
1069
|
-
Message?: string;
|
|
1069
|
+
Message?: string | undefined;
|
|
1070
1070
|
/**
|
|
1071
1071
|
* @internal
|
|
1072
1072
|
*/
|
|
@@ -1081,32 +1081,32 @@ export interface CreateApiRequest {
|
|
|
1081
1081
|
* <p>An API key selection expression. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">API Key Selection Expressions</a>.</p>
|
|
1082
1082
|
* @public
|
|
1083
1083
|
*/
|
|
1084
|
-
ApiKeySelectionExpression?: string;
|
|
1084
|
+
ApiKeySelectionExpression?: string | undefined;
|
|
1085
1085
|
/**
|
|
1086
1086
|
* <p>A CORS configuration. Supported only for HTTP APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html">Configuring CORS</a> for more information.</p>
|
|
1087
1087
|
* @public
|
|
1088
1088
|
*/
|
|
1089
|
-
CorsConfiguration?: Cors;
|
|
1089
|
+
CorsConfiguration?: Cors | undefined;
|
|
1090
1090
|
/**
|
|
1091
1091
|
* <p>This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, 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 arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.</p>
|
|
1092
1092
|
* @public
|
|
1093
1093
|
*/
|
|
1094
|
-
CredentialsArn?: string;
|
|
1094
|
+
CredentialsArn?: string | undefined;
|
|
1095
1095
|
/**
|
|
1096
1096
|
* <p>The description of the API.</p>
|
|
1097
1097
|
* @public
|
|
1098
1098
|
*/
|
|
1099
|
-
Description?: string;
|
|
1099
|
+
Description?: string | undefined;
|
|
1100
1100
|
/**
|
|
1101
1101
|
* <p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>
|
|
1102
1102
|
* @public
|
|
1103
1103
|
*/
|
|
1104
|
-
DisableSchemaValidation?: boolean;
|
|
1104
|
+
DisableSchemaValidation?: boolean | undefined;
|
|
1105
1105
|
/**
|
|
1106
1106
|
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://\{api_id\}.execute-api.\{region\}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
|
|
1107
1107
|
* @public
|
|
1108
1108
|
*/
|
|
1109
|
-
DisableExecuteApiEndpoint?: boolean;
|
|
1109
|
+
DisableExecuteApiEndpoint?: boolean | undefined;
|
|
1110
1110
|
/**
|
|
1111
1111
|
* <p>The name of the API.</p>
|
|
1112
1112
|
* @public
|
|
@@ -1121,27 +1121,27 @@ export interface CreateApiRequest {
|
|
|
1121
1121
|
* <p>This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.</p>
|
|
1122
1122
|
* @public
|
|
1123
1123
|
*/
|
|
1124
|
-
RouteKey?: string;
|
|
1124
|
+
RouteKey?: string | undefined;
|
|
1125
1125
|
/**
|
|
1126
1126
|
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
1127
1127
|
* @public
|
|
1128
1128
|
*/
|
|
1129
|
-
RouteSelectionExpression?: string;
|
|
1129
|
+
RouteSelectionExpression?: string | undefined;
|
|
1130
1130
|
/**
|
|
1131
1131
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
1132
1132
|
* @public
|
|
1133
1133
|
*/
|
|
1134
|
-
Tags?: Record<string, string
|
|
1134
|
+
Tags?: Record<string, string> | undefined;
|
|
1135
1135
|
/**
|
|
1136
1136
|
* <p>This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.</p>
|
|
1137
1137
|
* @public
|
|
1138
1138
|
*/
|
|
1139
|
-
Target?: string;
|
|
1139
|
+
Target?: string | undefined;
|
|
1140
1140
|
/**
|
|
1141
1141
|
* <p>A version identifier for the API.</p>
|
|
1142
1142
|
* @public
|
|
1143
1143
|
*/
|
|
1144
|
-
Version?: string;
|
|
1144
|
+
Version?: string | undefined;
|
|
1145
1145
|
}
|
|
1146
1146
|
/**
|
|
1147
1147
|
* @public
|
|
@@ -1151,82 +1151,82 @@ export interface CreateApiResponse {
|
|
|
1151
1151
|
* <p>The URI of the API, of the form \{api-id\}.execute-api.\{region\}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>
|
|
1152
1152
|
* @public
|
|
1153
1153
|
*/
|
|
1154
|
-
ApiEndpoint?: string;
|
|
1154
|
+
ApiEndpoint?: string | undefined;
|
|
1155
1155
|
/**
|
|
1156
1156
|
* <p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>
|
|
1157
1157
|
* @public
|
|
1158
1158
|
*/
|
|
1159
|
-
ApiGatewayManaged?: boolean;
|
|
1159
|
+
ApiGatewayManaged?: boolean | undefined;
|
|
1160
1160
|
/**
|
|
1161
1161
|
* <p>The API ID.</p>
|
|
1162
1162
|
* @public
|
|
1163
1163
|
*/
|
|
1164
|
-
ApiId?: string;
|
|
1164
|
+
ApiId?: string | undefined;
|
|
1165
1165
|
/**
|
|
1166
1166
|
* <p>An API key selection expression. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">API Key Selection Expressions</a>.</p>
|
|
1167
1167
|
* @public
|
|
1168
1168
|
*/
|
|
1169
|
-
ApiKeySelectionExpression?: string;
|
|
1169
|
+
ApiKeySelectionExpression?: string | undefined;
|
|
1170
1170
|
/**
|
|
1171
1171
|
* <p>A CORS configuration. Supported only for HTTP APIs.</p>
|
|
1172
1172
|
* @public
|
|
1173
1173
|
*/
|
|
1174
|
-
CorsConfiguration?: Cors;
|
|
1174
|
+
CorsConfiguration?: Cors | undefined;
|
|
1175
1175
|
/**
|
|
1176
1176
|
* <p>The timestamp when the API was created.</p>
|
|
1177
1177
|
* @public
|
|
1178
1178
|
*/
|
|
1179
|
-
CreatedDate?: Date;
|
|
1179
|
+
CreatedDate?: Date | undefined;
|
|
1180
1180
|
/**
|
|
1181
1181
|
* <p>The description of the API.</p>
|
|
1182
1182
|
* @public
|
|
1183
1183
|
*/
|
|
1184
|
-
Description?: string;
|
|
1184
|
+
Description?: string | undefined;
|
|
1185
1185
|
/**
|
|
1186
1186
|
* <p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>
|
|
1187
1187
|
* @public
|
|
1188
1188
|
*/
|
|
1189
|
-
DisableSchemaValidation?: boolean;
|
|
1189
|
+
DisableSchemaValidation?: boolean | undefined;
|
|
1190
1190
|
/**
|
|
1191
1191
|
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://\{api_id\}.execute-api.\{region\}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
|
|
1192
1192
|
* @public
|
|
1193
1193
|
*/
|
|
1194
|
-
DisableExecuteApiEndpoint?: boolean;
|
|
1194
|
+
DisableExecuteApiEndpoint?: boolean | undefined;
|
|
1195
1195
|
/**
|
|
1196
1196
|
* <p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>
|
|
1197
1197
|
* @public
|
|
1198
1198
|
*/
|
|
1199
|
-
ImportInfo?: string[];
|
|
1199
|
+
ImportInfo?: string[] | undefined;
|
|
1200
1200
|
/**
|
|
1201
1201
|
* <p>The name of the API.</p>
|
|
1202
1202
|
* @public
|
|
1203
1203
|
*/
|
|
1204
|
-
Name?: string;
|
|
1204
|
+
Name?: string | undefined;
|
|
1205
1205
|
/**
|
|
1206
1206
|
* <p>The API protocol.</p>
|
|
1207
1207
|
* @public
|
|
1208
1208
|
*/
|
|
1209
|
-
ProtocolType?: ProtocolType;
|
|
1209
|
+
ProtocolType?: ProtocolType | undefined;
|
|
1210
1210
|
/**
|
|
1211
1211
|
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
1212
1212
|
* @public
|
|
1213
1213
|
*/
|
|
1214
|
-
RouteSelectionExpression?: string;
|
|
1214
|
+
RouteSelectionExpression?: string | undefined;
|
|
1215
1215
|
/**
|
|
1216
1216
|
* <p>A collection of tags associated with the API.</p>
|
|
1217
1217
|
* @public
|
|
1218
1218
|
*/
|
|
1219
|
-
Tags?: Record<string, string
|
|
1219
|
+
Tags?: Record<string, string> | undefined;
|
|
1220
1220
|
/**
|
|
1221
1221
|
* <p>A version identifier for the API.</p>
|
|
1222
1222
|
* @public
|
|
1223
1223
|
*/
|
|
1224
|
-
Version?: string;
|
|
1224
|
+
Version?: string | undefined;
|
|
1225
1225
|
/**
|
|
1226
1226
|
* <p>The warning messages reported when failonwarnings is turned on during API import.</p>
|
|
1227
1227
|
* @public
|
|
1228
1228
|
*/
|
|
1229
|
-
Warnings?: string[];
|
|
1229
|
+
Warnings?: string[] | undefined;
|
|
1230
1230
|
}
|
|
1231
1231
|
/**
|
|
1232
1232
|
* <p>The resource specified in the request was not found. See the message field for more information.</p>
|
|
@@ -1239,12 +1239,12 @@ export declare class NotFoundException extends __BaseException {
|
|
|
1239
1239
|
* <p>Describes the error encountered.</p>
|
|
1240
1240
|
* @public
|
|
1241
1241
|
*/
|
|
1242
|
-
Message?: string;
|
|
1242
|
+
Message?: string | undefined;
|
|
1243
1243
|
/**
|
|
1244
1244
|
* <p>The resource type.</p>
|
|
1245
1245
|
* @public
|
|
1246
1246
|
*/
|
|
1247
|
-
ResourceType?: string;
|
|
1247
|
+
ResourceType?: string | undefined;
|
|
1248
1248
|
/**
|
|
1249
1249
|
* @internal
|
|
1250
1250
|
*/
|
|
@@ -1261,12 +1261,12 @@ export declare class TooManyRequestsException extends __BaseException {
|
|
|
1261
1261
|
* <p>The limit type.</p>
|
|
1262
1262
|
* @public
|
|
1263
1263
|
*/
|
|
1264
|
-
LimitType?: string;
|
|
1264
|
+
LimitType?: string | undefined;
|
|
1265
1265
|
/**
|
|
1266
1266
|
* <p>Describes the error encountered.</p>
|
|
1267
1267
|
* @public
|
|
1268
1268
|
*/
|
|
1269
|
-
Message?: string;
|
|
1269
|
+
Message?: string | undefined;
|
|
1270
1270
|
/**
|
|
1271
1271
|
* @internal
|
|
1272
1272
|
*/
|
|
@@ -1286,7 +1286,7 @@ export interface CreateApiMappingRequest {
|
|
|
1286
1286
|
* The API mapping key.
|
|
1287
1287
|
* @public
|
|
1288
1288
|
*/
|
|
1289
|
-
ApiMappingKey?: string;
|
|
1289
|
+
ApiMappingKey?: string | undefined;
|
|
1290
1290
|
/**
|
|
1291
1291
|
* <p>The domain name.</p>
|
|
1292
1292
|
* @public
|
|
@@ -1306,22 +1306,22 @@ export interface CreateApiMappingResponse {
|
|
|
1306
1306
|
* <p>The API identifier.</p>
|
|
1307
1307
|
* @public
|
|
1308
1308
|
*/
|
|
1309
|
-
ApiId?: string;
|
|
1309
|
+
ApiId?: string | undefined;
|
|
1310
1310
|
/**
|
|
1311
1311
|
* <p>The API mapping identifier.</p>
|
|
1312
1312
|
* @public
|
|
1313
1313
|
*/
|
|
1314
|
-
ApiMappingId?: string;
|
|
1314
|
+
ApiMappingId?: string | undefined;
|
|
1315
1315
|
/**
|
|
1316
1316
|
* <p>The API mapping key.</p>
|
|
1317
1317
|
* @public
|
|
1318
1318
|
*/
|
|
1319
|
-
ApiMappingKey?: string;
|
|
1319
|
+
ApiMappingKey?: string | undefined;
|
|
1320
1320
|
/**
|
|
1321
1321
|
* <p>The API stage.</p>
|
|
1322
1322
|
* @public
|
|
1323
1323
|
*/
|
|
1324
|
-
Stage?: string;
|
|
1324
|
+
Stage?: string | undefined;
|
|
1325
1325
|
}
|
|
1326
1326
|
/**
|
|
1327
1327
|
* <p>Creates a new Authorizer resource to represent an authorizer.</p>
|
|
@@ -1337,17 +1337,17 @@ export interface CreateAuthorizerRequest {
|
|
|
1337
1337
|
* <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, don't specify this parameter. Supported only for REQUEST authorizers.</p>
|
|
1338
1338
|
* @public
|
|
1339
1339
|
*/
|
|
1340
|
-
AuthorizerCredentialsArn?: string;
|
|
1340
|
+
AuthorizerCredentialsArn?: string | undefined;
|
|
1341
1341
|
/**
|
|
1342
1342
|
* <p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>
|
|
1343
1343
|
* @public
|
|
1344
1344
|
*/
|
|
1345
|
-
AuthorizerPayloadFormatVersion?: string;
|
|
1345
|
+
AuthorizerPayloadFormatVersion?: string | undefined;
|
|
1346
1346
|
/**
|
|
1347
1347
|
* <p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>
|
|
1348
1348
|
* @public
|
|
1349
1349
|
*/
|
|
1350
|
-
AuthorizerResultTtlInSeconds?: number;
|
|
1350
|
+
AuthorizerResultTtlInSeconds?: number | undefined;
|
|
1351
1351
|
/**
|
|
1352
1352
|
* <p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>
|
|
1353
1353
|
* @public
|
|
@@ -1358,12 +1358,12 @@ export interface CreateAuthorizerRequest {
|
|
|
1358
1358
|
* , where <replaceable></replaceable>\{region\} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>
|
|
1359
1359
|
* @public
|
|
1360
1360
|
*/
|
|
1361
|
-
AuthorizerUri?: string;
|
|
1361
|
+
AuthorizerUri?: string | undefined;
|
|
1362
1362
|
/**
|
|
1363
1363
|
* <p>Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a></p>
|
|
1364
1364
|
* @public
|
|
1365
1365
|
*/
|
|
1366
|
-
EnableSimpleResponses?: boolean;
|
|
1366
|
+
EnableSimpleResponses?: boolean | undefined;
|
|
1367
1367
|
/**
|
|
1368
1368
|
* <p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>
|
|
1369
1369
|
* @public
|
|
@@ -1373,12 +1373,12 @@ export interface CreateAuthorizerRequest {
|
|
|
1373
1373
|
* <p>This parameter is not used.</p>
|
|
1374
1374
|
* @public
|
|
1375
1375
|
*/
|
|
1376
|
-
IdentityValidationExpression?: string;
|
|
1376
|
+
IdentityValidationExpression?: string | undefined;
|
|
1377
1377
|
/**
|
|
1378
1378
|
* <p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>
|
|
1379
1379
|
* @public
|
|
1380
1380
|
*/
|
|
1381
|
-
JwtConfiguration?: JWTConfiguration;
|
|
1381
|
+
JwtConfiguration?: JWTConfiguration | undefined;
|
|
1382
1382
|
/**
|
|
1383
1383
|
* <p>The name of the authorizer.</p>
|
|
1384
1384
|
* @public
|
|
@@ -1393,58 +1393,58 @@ export interface CreateAuthorizerResponse {
|
|
|
1393
1393
|
* <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, don't specify this parameter. Supported only for REQUEST authorizers.</p>
|
|
1394
1394
|
* @public
|
|
1395
1395
|
*/
|
|
1396
|
-
AuthorizerCredentialsArn?: string;
|
|
1396
|
+
AuthorizerCredentialsArn?: string | undefined;
|
|
1397
1397
|
/**
|
|
1398
1398
|
* <p>The authorizer identifier.</p>
|
|
1399
1399
|
* @public
|
|
1400
1400
|
*/
|
|
1401
|
-
AuthorizerId?: string;
|
|
1401
|
+
AuthorizerId?: string | undefined;
|
|
1402
1402
|
/**
|
|
1403
1403
|
* <p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>
|
|
1404
1404
|
* @public
|
|
1405
1405
|
*/
|
|
1406
|
-
AuthorizerPayloadFormatVersion?: string;
|
|
1406
|
+
AuthorizerPayloadFormatVersion?: string | undefined;
|
|
1407
1407
|
/**
|
|
1408
1408
|
* <p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>
|
|
1409
1409
|
* @public
|
|
1410
1410
|
*/
|
|
1411
|
-
AuthorizerResultTtlInSeconds?: number;
|
|
1411
|
+
AuthorizerResultTtlInSeconds?: number | undefined;
|
|
1412
1412
|
/**
|
|
1413
1413
|
* <p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>
|
|
1414
1414
|
* @public
|
|
1415
1415
|
*/
|
|
1416
|
-
AuthorizerType?: AuthorizerType;
|
|
1416
|
+
AuthorizerType?: AuthorizerType | undefined;
|
|
1417
1417
|
/**
|
|
1418
1418
|
* <p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>\{account_id\}</replaceable>:function:<replaceable>\{lambda_function_name\}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>\{region\}</replaceable>:lambda:path/<replaceable>\{service_api\}</replaceable>
|
|
1419
1419
|
* , where <replaceable></replaceable>\{region\} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>
|
|
1420
1420
|
* @public
|
|
1421
1421
|
*/
|
|
1422
|
-
AuthorizerUri?: string;
|
|
1422
|
+
AuthorizerUri?: string | undefined;
|
|
1423
1423
|
/**
|
|
1424
1424
|
* <p>Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a></p>
|
|
1425
1425
|
* @public
|
|
1426
1426
|
*/
|
|
1427
|
-
EnableSimpleResponses?: boolean;
|
|
1427
|
+
EnableSimpleResponses?: boolean | undefined;
|
|
1428
1428
|
/**
|
|
1429
1429
|
* <p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>
|
|
1430
1430
|
* @public
|
|
1431
1431
|
*/
|
|
1432
|
-
IdentitySource?: string[];
|
|
1432
|
+
IdentitySource?: string[] | undefined;
|
|
1433
1433
|
/**
|
|
1434
1434
|
* <p>The validation expression does not apply to the REQUEST authorizer.</p>
|
|
1435
1435
|
* @public
|
|
1436
1436
|
*/
|
|
1437
|
-
IdentityValidationExpression?: string;
|
|
1437
|
+
IdentityValidationExpression?: string | undefined;
|
|
1438
1438
|
/**
|
|
1439
1439
|
* <p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>
|
|
1440
1440
|
* @public
|
|
1441
1441
|
*/
|
|
1442
|
-
JwtConfiguration?: JWTConfiguration;
|
|
1442
|
+
JwtConfiguration?: JWTConfiguration | undefined;
|
|
1443
1443
|
/**
|
|
1444
1444
|
* <p>The name of the authorizer.</p>
|
|
1445
1445
|
* @public
|
|
1446
1446
|
*/
|
|
1447
|
-
Name?: string;
|
|
1447
|
+
Name?: string | undefined;
|
|
1448
1448
|
}
|
|
1449
1449
|
/**
|
|
1450
1450
|
* <p>Creates a new Deployment resource to represent a deployment.</p>
|
|
@@ -1460,12 +1460,12 @@ export interface CreateDeploymentRequest {
|
|
|
1460
1460
|
* <p>The description for the deployment resource.</p>
|
|
1461
1461
|
* @public
|
|
1462
1462
|
*/
|
|
1463
|
-
Description?: string;
|
|
1463
|
+
Description?: string | undefined;
|
|
1464
1464
|
/**
|
|
1465
1465
|
* <p>The name of the Stage resource for the Deployment resource to create.</p>
|
|
1466
1466
|
* @public
|
|
1467
1467
|
*/
|
|
1468
|
-
StageName?: string;
|
|
1468
|
+
StageName?: string | undefined;
|
|
1469
1469
|
}
|
|
1470
1470
|
/**
|
|
1471
1471
|
* @public
|
|
@@ -1475,32 +1475,32 @@ export interface CreateDeploymentResponse {
|
|
|
1475
1475
|
* <p>Specifies whether a deployment was automatically released.</p>
|
|
1476
1476
|
* @public
|
|
1477
1477
|
*/
|
|
1478
|
-
AutoDeployed?: boolean;
|
|
1478
|
+
AutoDeployed?: boolean | undefined;
|
|
1479
1479
|
/**
|
|
1480
1480
|
* <p>The date and time when the Deployment resource was created.</p>
|
|
1481
1481
|
* @public
|
|
1482
1482
|
*/
|
|
1483
|
-
CreatedDate?: Date;
|
|
1483
|
+
CreatedDate?: Date | undefined;
|
|
1484
1484
|
/**
|
|
1485
1485
|
* <p>The identifier for the deployment.</p>
|
|
1486
1486
|
* @public
|
|
1487
1487
|
*/
|
|
1488
|
-
DeploymentId?: string;
|
|
1488
|
+
DeploymentId?: string | undefined;
|
|
1489
1489
|
/**
|
|
1490
1490
|
* <p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>
|
|
1491
1491
|
* @public
|
|
1492
1492
|
*/
|
|
1493
|
-
DeploymentStatus?: DeploymentStatus;
|
|
1493
|
+
DeploymentStatus?: DeploymentStatus | undefined;
|
|
1494
1494
|
/**
|
|
1495
1495
|
* <p>May contain additional feedback on the status of an API deployment.</p>
|
|
1496
1496
|
* @public
|
|
1497
1497
|
*/
|
|
1498
|
-
DeploymentStatusMessage?: string;
|
|
1498
|
+
DeploymentStatusMessage?: string | undefined;
|
|
1499
1499
|
/**
|
|
1500
1500
|
* <p>The description for the deployment.</p>
|
|
1501
1501
|
* @public
|
|
1502
1502
|
*/
|
|
1503
|
-
Description?: string;
|
|
1503
|
+
Description?: string | undefined;
|
|
1504
1504
|
}
|
|
1505
1505
|
/**
|
|
1506
1506
|
* @public
|
|
@@ -1510,12 +1510,12 @@ export interface MutualTlsAuthenticationInput {
|
|
|
1510
1510
|
* <p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>bucket-name</replaceable>/<replaceable>key-name</replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</p>
|
|
1511
1511
|
* @public
|
|
1512
1512
|
*/
|
|
1513
|
-
TruststoreUri?: string;
|
|
1513
|
+
TruststoreUri?: string | undefined;
|
|
1514
1514
|
/**
|
|
1515
1515
|
* <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>
|
|
1516
1516
|
* @public
|
|
1517
1517
|
*/
|
|
1518
|
-
TruststoreVersion?: string;
|
|
1518
|
+
TruststoreVersion?: string | undefined;
|
|
1519
1519
|
}
|
|
1520
1520
|
/**
|
|
1521
1521
|
* <p>Creates a new DomainName resource to represent a domain name.</p>
|
|
@@ -1531,17 +1531,17 @@ export interface CreateDomainNameRequest {
|
|
|
1531
1531
|
* <p>The domain name configurations.</p>
|
|
1532
1532
|
* @public
|
|
1533
1533
|
*/
|
|
1534
|
-
DomainNameConfigurations?: DomainNameConfiguration[];
|
|
1534
|
+
DomainNameConfigurations?: DomainNameConfiguration[] | undefined;
|
|
1535
1535
|
/**
|
|
1536
1536
|
* <p>The mutual TLS authentication configuration for a custom domain name.</p>
|
|
1537
1537
|
* @public
|
|
1538
1538
|
*/
|
|
1539
|
-
MutualTlsAuthentication?: MutualTlsAuthenticationInput;
|
|
1539
|
+
MutualTlsAuthentication?: MutualTlsAuthenticationInput | undefined;
|
|
1540
1540
|
/**
|
|
1541
1541
|
* <p>The collection of tags associated with a domain name.</p>
|
|
1542
1542
|
* @public
|
|
1543
1543
|
*/
|
|
1544
|
-
Tags?: Record<string, string
|
|
1544
|
+
Tags?: Record<string, string> | undefined;
|
|
1545
1545
|
}
|
|
1546
1546
|
/**
|
|
1547
1547
|
* @public
|
|
@@ -1551,27 +1551,27 @@ export interface CreateDomainNameResponse {
|
|
|
1551
1551
|
* <p>The API mapping selection expression.</p>
|
|
1552
1552
|
* @public
|
|
1553
1553
|
*/
|
|
1554
|
-
ApiMappingSelectionExpression?: string;
|
|
1554
|
+
ApiMappingSelectionExpression?: string | undefined;
|
|
1555
1555
|
/**
|
|
1556
1556
|
* <p>The name of the DomainName resource.</p>
|
|
1557
1557
|
* @public
|
|
1558
1558
|
*/
|
|
1559
|
-
DomainName?: string;
|
|
1559
|
+
DomainName?: string | undefined;
|
|
1560
1560
|
/**
|
|
1561
1561
|
* <p>The domain name configurations.</p>
|
|
1562
1562
|
* @public
|
|
1563
1563
|
*/
|
|
1564
|
-
DomainNameConfigurations?: DomainNameConfiguration[];
|
|
1564
|
+
DomainNameConfigurations?: DomainNameConfiguration[] | undefined;
|
|
1565
1565
|
/**
|
|
1566
1566
|
* <p>The mutual TLS authentication configuration for a custom domain name.</p>
|
|
1567
1567
|
* @public
|
|
1568
1568
|
*/
|
|
1569
|
-
MutualTlsAuthentication?: MutualTlsAuthentication;
|
|
1569
|
+
MutualTlsAuthentication?: MutualTlsAuthentication | undefined;
|
|
1570
1570
|
/**
|
|
1571
1571
|
* <p>The collection of tags associated with a domain name.</p>
|
|
1572
1572
|
* @public
|
|
1573
1573
|
*/
|
|
1574
|
-
Tags?: Record<string, string
|
|
1574
|
+
Tags?: Record<string, string> | undefined;
|
|
1575
1575
|
}
|
|
1576
1576
|
/**
|
|
1577
1577
|
* <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
|
|
@@ -1582,7 +1582,7 @@ export interface TlsConfigInput {
|
|
|
1582
1582
|
* <p>If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.</p>
|
|
1583
1583
|
* @public
|
|
1584
1584
|
*/
|
|
1585
|
-
ServerNameToVerify?: string;
|
|
1585
|
+
ServerNameToVerify?: string | undefined;
|
|
1586
1586
|
}
|
|
1587
1587
|
/**
|
|
1588
1588
|
* <p>Creates a new Integration resource to represent an integration.</p>
|
|
@@ -1598,37 +1598,37 @@ export interface CreateIntegrationRequest {
|
|
|
1598
1598
|
* <p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>
|
|
1599
1599
|
* @public
|
|
1600
1600
|
*/
|
|
1601
|
-
ConnectionId?: string;
|
|
1601
|
+
ConnectionId?: string | undefined;
|
|
1602
1602
|
/**
|
|
1603
1603
|
* <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
|
|
1604
1604
|
* @public
|
|
1605
1605
|
*/
|
|
1606
|
-
ConnectionType?: ConnectionType;
|
|
1606
|
+
ConnectionType?: ConnectionType | undefined;
|
|
1607
1607
|
/**
|
|
1608
1608
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
1609
1609
|
* @public
|
|
1610
1610
|
*/
|
|
1611
|
-
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
1611
|
+
ContentHandlingStrategy?: ContentHandlingStrategy | undefined;
|
|
1612
1612
|
/**
|
|
1613
1613
|
* <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 arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>
|
|
1614
1614
|
* @public
|
|
1615
1615
|
*/
|
|
1616
|
-
CredentialsArn?: string;
|
|
1616
|
+
CredentialsArn?: string | undefined;
|
|
1617
1617
|
/**
|
|
1618
1618
|
* <p>The description of the integration.</p>
|
|
1619
1619
|
* @public
|
|
1620
1620
|
*/
|
|
1621
|
-
Description?: string;
|
|
1621
|
+
Description?: string | undefined;
|
|
1622
1622
|
/**
|
|
1623
1623
|
* <p>Specifies the integration's HTTP method type.</p>
|
|
1624
1624
|
* @public
|
|
1625
1625
|
*/
|
|
1626
|
-
IntegrationMethod?: string;
|
|
1626
|
+
IntegrationMethod?: string | undefined;
|
|
1627
1627
|
/**
|
|
1628
1628
|
* <p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html">Integration subtype reference</a>.</p>
|
|
1629
1629
|
* @public
|
|
1630
1630
|
*/
|
|
1631
|
-
IntegrationSubtype?: string;
|
|
1631
|
+
IntegrationSubtype?: string | undefined;
|
|
1632
1632
|
/**
|
|
1633
1633
|
* <p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
|
|
1634
1634
|
* @public
|
|
@@ -1638,17 +1638,17 @@ export interface CreateIntegrationRequest {
|
|
|
1638
1638
|
* <p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
|
|
1639
1639
|
* @public
|
|
1640
1640
|
*/
|
|
1641
|
-
IntegrationUri?: string;
|
|
1641
|
+
IntegrationUri?: string | undefined;
|
|
1642
1642
|
/**
|
|
1643
1643
|
* <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 requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>
|
|
1644
1644
|
* @public
|
|
1645
1645
|
*/
|
|
1646
|
-
PassthroughBehavior?: PassthroughBehavior;
|
|
1646
|
+
PassthroughBehavior?: PassthroughBehavior | undefined;
|
|
1647
1647
|
/**
|
|
1648
1648
|
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
|
|
1649
1649
|
* @public
|
|
1650
1650
|
*/
|
|
1651
|
-
PayloadFormatVersion?: string;
|
|
1651
|
+
PayloadFormatVersion?: string | undefined;
|
|
1652
1652
|
/**
|
|
1653
1653
|
* <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>\{location\}</replaceable>.<replaceable>\{name\}</replaceable>
|
|
1654
1654
|
* , where
|
|
@@ -1658,32 +1658,32 @@ export interface CreateIntegrationRequest {
|
|
|
1658
1658
|
* must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
|
|
1659
1659
|
* @public
|
|
1660
1660
|
*/
|
|
1661
|
-
RequestParameters?: Record<string, string
|
|
1661
|
+
RequestParameters?: Record<string, string> | undefined;
|
|
1662
1662
|
/**
|
|
1663
1663
|
* <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. Supported only for WebSocket APIs.</p>
|
|
1664
1664
|
* @public
|
|
1665
1665
|
*/
|
|
1666
|
-
RequestTemplates?: Record<string, string
|
|
1666
|
+
RequestTemplates?: Record<string, string> | undefined;
|
|
1667
1667
|
/**
|
|
1668
1668
|
* <p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
|
|
1669
1669
|
* @public
|
|
1670
1670
|
*/
|
|
1671
|
-
ResponseParameters?: Record<string, Record<string, string
|
|
1671
|
+
ResponseParameters?: Record<string, Record<string, string>> | undefined;
|
|
1672
1672
|
/**
|
|
1673
1673
|
* <p>The template selection expression for the integration.</p>
|
|
1674
1674
|
* @public
|
|
1675
1675
|
*/
|
|
1676
|
-
TemplateSelectionExpression?: string;
|
|
1676
|
+
TemplateSelectionExpression?: string | undefined;
|
|
1677
1677
|
/**
|
|
1678
1678
|
* <p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>
|
|
1679
1679
|
* @public
|
|
1680
1680
|
*/
|
|
1681
|
-
TimeoutInMillis?: number;
|
|
1681
|
+
TimeoutInMillis?: number | undefined;
|
|
1682
1682
|
/**
|
|
1683
1683
|
* <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
|
|
1684
1684
|
* @public
|
|
1685
1685
|
*/
|
|
1686
|
-
TlsConfig?: TlsConfigInput;
|
|
1686
|
+
TlsConfig?: TlsConfigInput | undefined;
|
|
1687
1687
|
}
|
|
1688
1688
|
/**
|
|
1689
1689
|
* @public
|
|
@@ -1693,72 +1693,72 @@ export interface CreateIntegrationResult {
|
|
|
1693
1693
|
* <p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>
|
|
1694
1694
|
* @public
|
|
1695
1695
|
*/
|
|
1696
|
-
ApiGatewayManaged?: boolean;
|
|
1696
|
+
ApiGatewayManaged?: boolean | undefined;
|
|
1697
1697
|
/**
|
|
1698
1698
|
* <p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>
|
|
1699
1699
|
* @public
|
|
1700
1700
|
*/
|
|
1701
|
-
ConnectionId?: string;
|
|
1701
|
+
ConnectionId?: string | undefined;
|
|
1702
1702
|
/**
|
|
1703
1703
|
* <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
|
|
1704
1704
|
* @public
|
|
1705
1705
|
*/
|
|
1706
|
-
ConnectionType?: ConnectionType;
|
|
1706
|
+
ConnectionType?: ConnectionType | undefined;
|
|
1707
1707
|
/**
|
|
1708
1708
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
1709
1709
|
* @public
|
|
1710
1710
|
*/
|
|
1711
|
-
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
1711
|
+
ContentHandlingStrategy?: ContentHandlingStrategy | undefined;
|
|
1712
1712
|
/**
|
|
1713
1713
|
* <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 arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>
|
|
1714
1714
|
* @public
|
|
1715
1715
|
*/
|
|
1716
|
-
CredentialsArn?: string;
|
|
1716
|
+
CredentialsArn?: string | undefined;
|
|
1717
1717
|
/**
|
|
1718
1718
|
* <p>Represents the description of an integration.</p>
|
|
1719
1719
|
* @public
|
|
1720
1720
|
*/
|
|
1721
|
-
Description?: string;
|
|
1721
|
+
Description?: string | undefined;
|
|
1722
1722
|
/**
|
|
1723
1723
|
* <p>Represents the identifier of an integration.</p>
|
|
1724
1724
|
* @public
|
|
1725
1725
|
*/
|
|
1726
|
-
IntegrationId?: string;
|
|
1726
|
+
IntegrationId?: string | undefined;
|
|
1727
1727
|
/**
|
|
1728
1728
|
* <p>Specifies the integration's HTTP method type.</p>
|
|
1729
1729
|
* @public
|
|
1730
1730
|
*/
|
|
1731
|
-
IntegrationMethod?: string;
|
|
1731
|
+
IntegrationMethod?: string | undefined;
|
|
1732
1732
|
/**
|
|
1733
1733
|
* <p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions">Integration Response Selection Expressions</a>.</p>
|
|
1734
1734
|
* @public
|
|
1735
1735
|
*/
|
|
1736
|
-
IntegrationResponseSelectionExpression?: string;
|
|
1736
|
+
IntegrationResponseSelectionExpression?: string | undefined;
|
|
1737
1737
|
/**
|
|
1738
1738
|
* <p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html">Integration subtype reference</a>.</p>
|
|
1739
1739
|
* @public
|
|
1740
1740
|
*/
|
|
1741
|
-
IntegrationSubtype?: string;
|
|
1741
|
+
IntegrationSubtype?: string | undefined;
|
|
1742
1742
|
/**
|
|
1743
1743
|
* <p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
|
|
1744
1744
|
* @public
|
|
1745
1745
|
*/
|
|
1746
|
-
IntegrationType?: IntegrationType;
|
|
1746
|
+
IntegrationType?: IntegrationType | undefined;
|
|
1747
1747
|
/**
|
|
1748
1748
|
* <p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
|
|
1749
1749
|
* @public
|
|
1750
1750
|
*/
|
|
1751
|
-
IntegrationUri?: string;
|
|
1751
|
+
IntegrationUri?: string | undefined;
|
|
1752
1752
|
/**
|
|
1753
1753
|
* <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 requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>
|
|
1754
1754
|
* @public
|
|
1755
1755
|
*/
|
|
1756
|
-
PassthroughBehavior?: PassthroughBehavior;
|
|
1756
|
+
PassthroughBehavior?: PassthroughBehavior | undefined;
|
|
1757
1757
|
/**
|
|
1758
1758
|
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
|
|
1759
1759
|
* @public
|
|
1760
1760
|
*/
|
|
1761
|
-
PayloadFormatVersion?: string;
|
|
1761
|
+
PayloadFormatVersion?: string | undefined;
|
|
1762
1762
|
/**
|
|
1763
1763
|
* <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>\{location\}</replaceable>.<replaceable>\{name\}</replaceable>
|
|
1764
1764
|
* , where
|
|
@@ -1768,32 +1768,32 @@ export interface CreateIntegrationResult {
|
|
|
1768
1768
|
* must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
|
|
1769
1769
|
* @public
|
|
1770
1770
|
*/
|
|
1771
|
-
RequestParameters?: Record<string, string
|
|
1771
|
+
RequestParameters?: Record<string, string> | undefined;
|
|
1772
1772
|
/**
|
|
1773
1773
|
* <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. Supported only for WebSocket APIs.</p>
|
|
1774
1774
|
* @public
|
|
1775
1775
|
*/
|
|
1776
|
-
RequestTemplates?: Record<string, string
|
|
1776
|
+
RequestTemplates?: Record<string, string> | undefined;
|
|
1777
1777
|
/**
|
|
1778
1778
|
* <p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
|
|
1779
1779
|
* @public
|
|
1780
1780
|
*/
|
|
1781
|
-
ResponseParameters?: Record<string, Record<string, string
|
|
1781
|
+
ResponseParameters?: Record<string, Record<string, string>> | undefined;
|
|
1782
1782
|
/**
|
|
1783
1783
|
* <p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>
|
|
1784
1784
|
* @public
|
|
1785
1785
|
*/
|
|
1786
|
-
TemplateSelectionExpression?: string;
|
|
1786
|
+
TemplateSelectionExpression?: string | undefined;
|
|
1787
1787
|
/**
|
|
1788
1788
|
* <p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>
|
|
1789
1789
|
* @public
|
|
1790
1790
|
*/
|
|
1791
|
-
TimeoutInMillis?: number;
|
|
1791
|
+
TimeoutInMillis?: number | undefined;
|
|
1792
1792
|
/**
|
|
1793
1793
|
* <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
|
|
1794
1794
|
* @public
|
|
1795
1795
|
*/
|
|
1796
|
-
TlsConfig?: TlsConfig;
|
|
1796
|
+
TlsConfig?: TlsConfig | undefined;
|
|
1797
1797
|
}
|
|
1798
1798
|
/**
|
|
1799
1799
|
* <p>Creates a new IntegrationResponse resource to represent an integration response.</p>
|
|
@@ -1809,7 +1809,7 @@ export interface CreateIntegrationResponseRequest {
|
|
|
1809
1809
|
* <p>Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
1810
1810
|
* @public
|
|
1811
1811
|
*/
|
|
1812
|
-
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
1812
|
+
ContentHandlingStrategy?: ContentHandlingStrategy | undefined;
|
|
1813
1813
|
/**
|
|
1814
1814
|
* <p>The integration ID.</p>
|
|
1815
1815
|
* @public
|
|
@@ -1824,17 +1824,17 @@ export interface CreateIntegrationResponseRequest {
|
|
|
1824
1824
|
* <p>A key-value map specifying response parameters that are passed to the method response from the backend. 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 method.response.header.\{name\}, where \{name\} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.\{name\} or integration.response.body.\{JSON-expression\}, where \{name\} is a valid and unique response header name and \{JSON-expression\} is a valid JSON expression without the $ prefix.</p>
|
|
1825
1825
|
* @public
|
|
1826
1826
|
*/
|
|
1827
|
-
ResponseParameters?: Record<string, string
|
|
1827
|
+
ResponseParameters?: Record<string, string> | undefined;
|
|
1828
1828
|
/**
|
|
1829
1829
|
* <p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>
|
|
1830
1830
|
* @public
|
|
1831
1831
|
*/
|
|
1832
|
-
ResponseTemplates?: Record<string, string
|
|
1832
|
+
ResponseTemplates?: Record<string, string> | undefined;
|
|
1833
1833
|
/**
|
|
1834
1834
|
* <p>The template selection expression for the integration response. Supported only for WebSocket APIs.</p>
|
|
1835
1835
|
* @public
|
|
1836
1836
|
*/
|
|
1837
|
-
TemplateSelectionExpression?: string;
|
|
1837
|
+
TemplateSelectionExpression?: string | undefined;
|
|
1838
1838
|
}
|
|
1839
1839
|
/**
|
|
1840
1840
|
* @public
|
|
@@ -1844,32 +1844,32 @@ export interface CreateIntegrationResponseResponse {
|
|
|
1844
1844
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
1845
1845
|
* @public
|
|
1846
1846
|
*/
|
|
1847
|
-
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
1847
|
+
ContentHandlingStrategy?: ContentHandlingStrategy | undefined;
|
|
1848
1848
|
/**
|
|
1849
1849
|
* <p>The integration response ID.</p>
|
|
1850
1850
|
* @public
|
|
1851
1851
|
*/
|
|
1852
|
-
IntegrationResponseId?: string;
|
|
1852
|
+
IntegrationResponseId?: string | undefined;
|
|
1853
1853
|
/**
|
|
1854
1854
|
* <p>The integration response key.</p>
|
|
1855
1855
|
* @public
|
|
1856
1856
|
*/
|
|
1857
|
-
IntegrationResponseKey?: string;
|
|
1857
|
+
IntegrationResponseKey?: string | undefined;
|
|
1858
1858
|
/**
|
|
1859
1859
|
* <p>A key-value map specifying response parameters that are passed to the method response from the backend. 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 method.response.header.\{name\}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.\{name\} or integration.response.body.\{JSON-expression\}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.</p>
|
|
1860
1860
|
* @public
|
|
1861
1861
|
*/
|
|
1862
|
-
ResponseParameters?: Record<string, string
|
|
1862
|
+
ResponseParameters?: Record<string, string> | undefined;
|
|
1863
1863
|
/**
|
|
1864
1864
|
* <p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>
|
|
1865
1865
|
* @public
|
|
1866
1866
|
*/
|
|
1867
|
-
ResponseTemplates?: Record<string, string
|
|
1867
|
+
ResponseTemplates?: Record<string, string> | undefined;
|
|
1868
1868
|
/**
|
|
1869
1869
|
* <p>The template selection expressions for the integration response.</p>
|
|
1870
1870
|
* @public
|
|
1871
1871
|
*/
|
|
1872
|
-
TemplateSelectionExpression?: string;
|
|
1872
|
+
TemplateSelectionExpression?: string | undefined;
|
|
1873
1873
|
}
|
|
1874
1874
|
/**
|
|
1875
1875
|
* <p>Creates a new Model.</p>
|
|
@@ -1885,12 +1885,12 @@ export interface CreateModelRequest {
|
|
|
1885
1885
|
* <p>The content-type for the model, for example, "application/json".</p>
|
|
1886
1886
|
* @public
|
|
1887
1887
|
*/
|
|
1888
|
-
ContentType?: string;
|
|
1888
|
+
ContentType?: string | undefined;
|
|
1889
1889
|
/**
|
|
1890
1890
|
* <p>The description of the model.</p>
|
|
1891
1891
|
* @public
|
|
1892
1892
|
*/
|
|
1893
|
-
Description?: string;
|
|
1893
|
+
Description?: string | undefined;
|
|
1894
1894
|
/**
|
|
1895
1895
|
* <p>The name of the model. Must be alphanumeric.</p>
|
|
1896
1896
|
* @public
|
|
@@ -1910,27 +1910,27 @@ export interface CreateModelResponse {
|
|
|
1910
1910
|
* <p>The content-type for the model, for example, "application/json".</p>
|
|
1911
1911
|
* @public
|
|
1912
1912
|
*/
|
|
1913
|
-
ContentType?: string;
|
|
1913
|
+
ContentType?: string | undefined;
|
|
1914
1914
|
/**
|
|
1915
1915
|
* <p>The description of the model.</p>
|
|
1916
1916
|
* @public
|
|
1917
1917
|
*/
|
|
1918
|
-
Description?: string;
|
|
1918
|
+
Description?: string | undefined;
|
|
1919
1919
|
/**
|
|
1920
1920
|
* <p>The model identifier.</p>
|
|
1921
1921
|
* @public
|
|
1922
1922
|
*/
|
|
1923
|
-
ModelId?: string;
|
|
1923
|
+
ModelId?: string | undefined;
|
|
1924
1924
|
/**
|
|
1925
1925
|
* <p>The name of the model. Must be alphanumeric.</p>
|
|
1926
1926
|
* @public
|
|
1927
1927
|
*/
|
|
1928
|
-
Name?: string;
|
|
1928
|
+
Name?: string | undefined;
|
|
1929
1929
|
/**
|
|
1930
1930
|
* <p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>
|
|
1931
1931
|
* @public
|
|
1932
1932
|
*/
|
|
1933
|
-
Schema?: string;
|
|
1933
|
+
Schema?: string | undefined;
|
|
1934
1934
|
}
|
|
1935
1935
|
/**
|
|
1936
1936
|
* <p>Creates a new Route resource to represent a route.</p>
|
|
@@ -1946,42 +1946,42 @@ export interface CreateRouteRequest {
|
|
|
1946
1946
|
* <p>Specifies whether an API key is required for the route. Supported only for WebSocket APIs.</p>
|
|
1947
1947
|
* @public
|
|
1948
1948
|
*/
|
|
1949
|
-
ApiKeyRequired?: boolean;
|
|
1949
|
+
ApiKeyRequired?: boolean | undefined;
|
|
1950
1950
|
/**
|
|
1951
1951
|
* <p>The authorization scopes supported by this route.</p>
|
|
1952
1952
|
* @public
|
|
1953
1953
|
*/
|
|
1954
|
-
AuthorizationScopes?: string[];
|
|
1954
|
+
AuthorizationScopes?: string[] | undefined;
|
|
1955
1955
|
/**
|
|
1956
1956
|
* <p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>
|
|
1957
1957
|
* @public
|
|
1958
1958
|
*/
|
|
1959
|
-
AuthorizationType?: AuthorizationType;
|
|
1959
|
+
AuthorizationType?: AuthorizationType | undefined;
|
|
1960
1960
|
/**
|
|
1961
1961
|
* <p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>
|
|
1962
1962
|
* @public
|
|
1963
1963
|
*/
|
|
1964
|
-
AuthorizerId?: string;
|
|
1964
|
+
AuthorizerId?: string | undefined;
|
|
1965
1965
|
/**
|
|
1966
1966
|
* <p>The model selection expression for the route. Supported only for WebSocket APIs.</p>
|
|
1967
1967
|
* @public
|
|
1968
1968
|
*/
|
|
1969
|
-
ModelSelectionExpression?: string;
|
|
1969
|
+
ModelSelectionExpression?: string | undefined;
|
|
1970
1970
|
/**
|
|
1971
1971
|
* <p>The operation name for the route.</p>
|
|
1972
1972
|
* @public
|
|
1973
1973
|
*/
|
|
1974
|
-
OperationName?: string;
|
|
1974
|
+
OperationName?: string | undefined;
|
|
1975
1975
|
/**
|
|
1976
1976
|
* <p>The request models for the route. Supported only for WebSocket APIs.</p>
|
|
1977
1977
|
* @public
|
|
1978
1978
|
*/
|
|
1979
|
-
RequestModels?: Record<string, string
|
|
1979
|
+
RequestModels?: Record<string, string> | undefined;
|
|
1980
1980
|
/**
|
|
1981
1981
|
* <p>The request parameters for the route. Supported only for WebSocket APIs.</p>
|
|
1982
1982
|
* @public
|
|
1983
1983
|
*/
|
|
1984
|
-
RequestParameters?: Record<string, ParameterConstraints
|
|
1984
|
+
RequestParameters?: Record<string, ParameterConstraints> | undefined;
|
|
1985
1985
|
/**
|
|
1986
1986
|
* <p>The route key for the route.</p>
|
|
1987
1987
|
* @public
|
|
@@ -1991,12 +1991,12 @@ export interface CreateRouteRequest {
|
|
|
1991
1991
|
* <p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>
|
|
1992
1992
|
* @public
|
|
1993
1993
|
*/
|
|
1994
|
-
RouteResponseSelectionExpression?: string;
|
|
1994
|
+
RouteResponseSelectionExpression?: string | undefined;
|
|
1995
1995
|
/**
|
|
1996
1996
|
* <p>The target for the route.</p>
|
|
1997
1997
|
* @public
|
|
1998
1998
|
*/
|
|
1999
|
-
Target?: string;
|
|
1999
|
+
Target?: string | undefined;
|
|
2000
2000
|
}
|
|
2001
2001
|
/**
|
|
2002
2002
|
* @public
|
|
@@ -2006,67 +2006,67 @@ export interface CreateRouteResult {
|
|
|
2006
2006
|
* <p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>
|
|
2007
2007
|
* @public
|
|
2008
2008
|
*/
|
|
2009
|
-
ApiGatewayManaged?: boolean;
|
|
2009
|
+
ApiGatewayManaged?: boolean | undefined;
|
|
2010
2010
|
/**
|
|
2011
2011
|
* <p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>
|
|
2012
2012
|
* @public
|
|
2013
2013
|
*/
|
|
2014
|
-
ApiKeyRequired?: boolean;
|
|
2014
|
+
ApiKeyRequired?: boolean | undefined;
|
|
2015
2015
|
/**
|
|
2016
2016
|
* <p>A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>
|
|
2017
2017
|
* @public
|
|
2018
2018
|
*/
|
|
2019
|
-
AuthorizationScopes?: string[];
|
|
2019
|
+
AuthorizationScopes?: string[] | undefined;
|
|
2020
2020
|
/**
|
|
2021
2021
|
* <p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>
|
|
2022
2022
|
* @public
|
|
2023
2023
|
*/
|
|
2024
|
-
AuthorizationType?: AuthorizationType;
|
|
2024
|
+
AuthorizationType?: AuthorizationType | undefined;
|
|
2025
2025
|
/**
|
|
2026
2026
|
* <p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>
|
|
2027
2027
|
* @public
|
|
2028
2028
|
*/
|
|
2029
|
-
AuthorizerId?: string;
|
|
2029
|
+
AuthorizerId?: string | undefined;
|
|
2030
2030
|
/**
|
|
2031
2031
|
* <p>The model selection expression for the route. Supported only for WebSocket APIs.</p>
|
|
2032
2032
|
* @public
|
|
2033
2033
|
*/
|
|
2034
|
-
ModelSelectionExpression?: string;
|
|
2034
|
+
ModelSelectionExpression?: string | undefined;
|
|
2035
2035
|
/**
|
|
2036
2036
|
* <p>The operation name for the route.</p>
|
|
2037
2037
|
* @public
|
|
2038
2038
|
*/
|
|
2039
|
-
OperationName?: string;
|
|
2039
|
+
OperationName?: string | undefined;
|
|
2040
2040
|
/**
|
|
2041
2041
|
* <p>The request models for the route. Supported only for WebSocket APIs.</p>
|
|
2042
2042
|
* @public
|
|
2043
2043
|
*/
|
|
2044
|
-
RequestModels?: Record<string, string
|
|
2044
|
+
RequestModels?: Record<string, string> | undefined;
|
|
2045
2045
|
/**
|
|
2046
2046
|
* <p>The request parameters for the route. Supported only for WebSocket APIs.</p>
|
|
2047
2047
|
* @public
|
|
2048
2048
|
*/
|
|
2049
|
-
RequestParameters?: Record<string, ParameterConstraints
|
|
2049
|
+
RequestParameters?: Record<string, ParameterConstraints> | undefined;
|
|
2050
2050
|
/**
|
|
2051
2051
|
* <p>The route ID.</p>
|
|
2052
2052
|
* @public
|
|
2053
2053
|
*/
|
|
2054
|
-
RouteId?: string;
|
|
2054
|
+
RouteId?: string | undefined;
|
|
2055
2055
|
/**
|
|
2056
2056
|
* <p>The route key for the route.</p>
|
|
2057
2057
|
* @public
|
|
2058
2058
|
*/
|
|
2059
|
-
RouteKey?: string;
|
|
2059
|
+
RouteKey?: string | undefined;
|
|
2060
2060
|
/**
|
|
2061
2061
|
* <p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>
|
|
2062
2062
|
* @public
|
|
2063
2063
|
*/
|
|
2064
|
-
RouteResponseSelectionExpression?: string;
|
|
2064
|
+
RouteResponseSelectionExpression?: string | undefined;
|
|
2065
2065
|
/**
|
|
2066
2066
|
* <p>The target for the route.</p>
|
|
2067
2067
|
* @public
|
|
2068
2068
|
*/
|
|
2069
|
-
Target?: string;
|
|
2069
|
+
Target?: string | undefined;
|
|
2070
2070
|
}
|
|
2071
2071
|
/**
|
|
2072
2072
|
* <p>Creates a new RouteResponse resource to represent a route response.</p>
|
|
@@ -2082,17 +2082,17 @@ export interface CreateRouteResponseRequest {
|
|
|
2082
2082
|
* <p>The model selection expression for the route response. Supported only for WebSocket APIs.</p>
|
|
2083
2083
|
* @public
|
|
2084
2084
|
*/
|
|
2085
|
-
ModelSelectionExpression?: string;
|
|
2085
|
+
ModelSelectionExpression?: string | undefined;
|
|
2086
2086
|
/**
|
|
2087
2087
|
* <p>The response models for the route response.</p>
|
|
2088
2088
|
* @public
|
|
2089
2089
|
*/
|
|
2090
|
-
ResponseModels?: Record<string, string
|
|
2090
|
+
ResponseModels?: Record<string, string> | undefined;
|
|
2091
2091
|
/**
|
|
2092
2092
|
* <p>The route response parameters.</p>
|
|
2093
2093
|
* @public
|
|
2094
2094
|
*/
|
|
2095
|
-
ResponseParameters?: Record<string, ParameterConstraints
|
|
2095
|
+
ResponseParameters?: Record<string, ParameterConstraints> | undefined;
|
|
2096
2096
|
/**
|
|
2097
2097
|
* <p>The route ID.</p>
|
|
2098
2098
|
* @public
|
|
@@ -2112,27 +2112,27 @@ export interface CreateRouteResponseResponse {
|
|
|
2112
2112
|
* <p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>
|
|
2113
2113
|
* @public
|
|
2114
2114
|
*/
|
|
2115
|
-
ModelSelectionExpression?: string;
|
|
2115
|
+
ModelSelectionExpression?: string | undefined;
|
|
2116
2116
|
/**
|
|
2117
2117
|
* <p>Represents the response models of a route response.</p>
|
|
2118
2118
|
* @public
|
|
2119
2119
|
*/
|
|
2120
|
-
ResponseModels?: Record<string, string
|
|
2120
|
+
ResponseModels?: Record<string, string> | undefined;
|
|
2121
2121
|
/**
|
|
2122
2122
|
* <p>Represents the response parameters of a route response.</p>
|
|
2123
2123
|
* @public
|
|
2124
2124
|
*/
|
|
2125
|
-
ResponseParameters?: Record<string, ParameterConstraints
|
|
2125
|
+
ResponseParameters?: Record<string, ParameterConstraints> | undefined;
|
|
2126
2126
|
/**
|
|
2127
2127
|
* <p>Represents the identifier of a route response.</p>
|
|
2128
2128
|
* @public
|
|
2129
2129
|
*/
|
|
2130
|
-
RouteResponseId?: string;
|
|
2130
|
+
RouteResponseId?: string | undefined;
|
|
2131
2131
|
/**
|
|
2132
2132
|
* <p>Represents the route response key of a route response.</p>
|
|
2133
2133
|
* @public
|
|
2134
2134
|
*/
|
|
2135
|
-
RouteResponseKey?: string;
|
|
2135
|
+
RouteResponseKey?: string | undefined;
|
|
2136
2136
|
}
|
|
2137
2137
|
/**
|
|
2138
2138
|
* <p>Creates a new Stage resource to represent a stage.</p>
|
|
@@ -2143,7 +2143,7 @@ export interface CreateStageRequest {
|
|
|
2143
2143
|
* <p>Settings for logging access in this stage.</p>
|
|
2144
2144
|
* @public
|
|
2145
2145
|
*/
|
|
2146
|
-
AccessLogSettings?: AccessLogSettings;
|
|
2146
|
+
AccessLogSettings?: AccessLogSettings | undefined;
|
|
2147
2147
|
/**
|
|
2148
2148
|
* <p>The API identifier.</p>
|
|
2149
2149
|
* @public
|
|
@@ -2153,32 +2153,32 @@ export interface CreateStageRequest {
|
|
|
2153
2153
|
* <p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>
|
|
2154
2154
|
* @public
|
|
2155
2155
|
*/
|
|
2156
|
-
AutoDeploy?: boolean;
|
|
2156
|
+
AutoDeploy?: boolean | undefined;
|
|
2157
2157
|
/**
|
|
2158
2158
|
* <p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>
|
|
2159
2159
|
* @public
|
|
2160
2160
|
*/
|
|
2161
|
-
ClientCertificateId?: string;
|
|
2161
|
+
ClientCertificateId?: string | undefined;
|
|
2162
2162
|
/**
|
|
2163
2163
|
* <p>The default route settings for the stage.</p>
|
|
2164
2164
|
* @public
|
|
2165
2165
|
*/
|
|
2166
|
-
DefaultRouteSettings?: RouteSettings;
|
|
2166
|
+
DefaultRouteSettings?: RouteSettings | undefined;
|
|
2167
2167
|
/**
|
|
2168
2168
|
* <p>The deployment identifier of the API stage.</p>
|
|
2169
2169
|
* @public
|
|
2170
2170
|
*/
|
|
2171
|
-
DeploymentId?: string;
|
|
2171
|
+
DeploymentId?: string | undefined;
|
|
2172
2172
|
/**
|
|
2173
2173
|
* <p>The description for the API stage.</p>
|
|
2174
2174
|
* @public
|
|
2175
2175
|
*/
|
|
2176
|
-
Description?: string;
|
|
2176
|
+
Description?: string | undefined;
|
|
2177
2177
|
/**
|
|
2178
2178
|
* <p>Route settings for the stage, by routeKey.</p>
|
|
2179
2179
|
* @public
|
|
2180
2180
|
*/
|
|
2181
|
-
RouteSettings?: Record<string, RouteSettings
|
|
2181
|
+
RouteSettings?: Record<string, RouteSettings> | undefined;
|
|
2182
2182
|
/**
|
|
2183
2183
|
* <p>The name of the stage.</p>
|
|
2184
2184
|
* @public
|
|
@@ -2188,12 +2188,12 @@ export interface CreateStageRequest {
|
|
|
2188
2188
|
* <p>A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>
|
|
2189
2189
|
* @public
|
|
2190
2190
|
*/
|
|
2191
|
-
StageVariables?: Record<string, string
|
|
2191
|
+
StageVariables?: Record<string, string> | undefined;
|
|
2192
2192
|
/**
|
|
2193
2193
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
2194
2194
|
* @public
|
|
2195
2195
|
*/
|
|
2196
|
-
Tags?: Record<string, string
|
|
2196
|
+
Tags?: Record<string, string> | undefined;
|
|
2197
2197
|
}
|
|
2198
2198
|
/**
|
|
2199
2199
|
* @public
|
|
@@ -2203,72 +2203,72 @@ export interface CreateStageResponse {
|
|
|
2203
2203
|
* <p>Settings for logging access in this stage.</p>
|
|
2204
2204
|
* @public
|
|
2205
2205
|
*/
|
|
2206
|
-
AccessLogSettings?: AccessLogSettings;
|
|
2206
|
+
AccessLogSettings?: AccessLogSettings | undefined;
|
|
2207
2207
|
/**
|
|
2208
2208
|
* <p>Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.</p>
|
|
2209
2209
|
* @public
|
|
2210
2210
|
*/
|
|
2211
|
-
ApiGatewayManaged?: boolean;
|
|
2211
|
+
ApiGatewayManaged?: boolean | undefined;
|
|
2212
2212
|
/**
|
|
2213
2213
|
* <p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>
|
|
2214
2214
|
* @public
|
|
2215
2215
|
*/
|
|
2216
|
-
AutoDeploy?: boolean;
|
|
2216
|
+
AutoDeploy?: boolean | undefined;
|
|
2217
2217
|
/**
|
|
2218
2218
|
* <p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>
|
|
2219
2219
|
* @public
|
|
2220
2220
|
*/
|
|
2221
|
-
ClientCertificateId?: string;
|
|
2221
|
+
ClientCertificateId?: string | undefined;
|
|
2222
2222
|
/**
|
|
2223
2223
|
* <p>The timestamp when the stage was created.</p>
|
|
2224
2224
|
* @public
|
|
2225
2225
|
*/
|
|
2226
|
-
CreatedDate?: Date;
|
|
2226
|
+
CreatedDate?: Date | undefined;
|
|
2227
2227
|
/**
|
|
2228
2228
|
* <p>Default route settings for the stage.</p>
|
|
2229
2229
|
* @public
|
|
2230
2230
|
*/
|
|
2231
|
-
DefaultRouteSettings?: RouteSettings;
|
|
2231
|
+
DefaultRouteSettings?: RouteSettings | undefined;
|
|
2232
2232
|
/**
|
|
2233
2233
|
* <p>The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.</p>
|
|
2234
2234
|
* @public
|
|
2235
2235
|
*/
|
|
2236
|
-
DeploymentId?: string;
|
|
2236
|
+
DeploymentId?: string | undefined;
|
|
2237
2237
|
/**
|
|
2238
2238
|
* <p>The description of the stage.</p>
|
|
2239
2239
|
* @public
|
|
2240
2240
|
*/
|
|
2241
|
-
Description?: string;
|
|
2241
|
+
Description?: string | undefined;
|
|
2242
2242
|
/**
|
|
2243
2243
|
* <p>Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.</p>
|
|
2244
2244
|
* @public
|
|
2245
2245
|
*/
|
|
2246
|
-
LastDeploymentStatusMessage?: string;
|
|
2246
|
+
LastDeploymentStatusMessage?: string | undefined;
|
|
2247
2247
|
/**
|
|
2248
2248
|
* <p>The timestamp when the stage was last updated.</p>
|
|
2249
2249
|
* @public
|
|
2250
2250
|
*/
|
|
2251
|
-
LastUpdatedDate?: Date;
|
|
2251
|
+
LastUpdatedDate?: Date | undefined;
|
|
2252
2252
|
/**
|
|
2253
2253
|
* <p>Route settings for the stage, by routeKey.</p>
|
|
2254
2254
|
* @public
|
|
2255
2255
|
*/
|
|
2256
|
-
RouteSettings?: Record<string, RouteSettings
|
|
2256
|
+
RouteSettings?: Record<string, RouteSettings> | undefined;
|
|
2257
2257
|
/**
|
|
2258
2258
|
* <p>The name of the stage.</p>
|
|
2259
2259
|
* @public
|
|
2260
2260
|
*/
|
|
2261
|
-
StageName?: string;
|
|
2261
|
+
StageName?: string | undefined;
|
|
2262
2262
|
/**
|
|
2263
2263
|
* <p>A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>
|
|
2264
2264
|
* @public
|
|
2265
2265
|
*/
|
|
2266
|
-
StageVariables?: Record<string, string
|
|
2266
|
+
StageVariables?: Record<string, string> | undefined;
|
|
2267
2267
|
/**
|
|
2268
2268
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
2269
2269
|
* @public
|
|
2270
2270
|
*/
|
|
2271
|
-
Tags?: Record<string, string
|
|
2271
|
+
Tags?: Record<string, string> | undefined;
|
|
2272
2272
|
}
|
|
2273
2273
|
/**
|
|
2274
2274
|
* <p>Creates a VPC link</p>
|
|
@@ -2284,7 +2284,7 @@ export interface CreateVpcLinkRequest {
|
|
|
2284
2284
|
* <p>A list of security group IDs for the VPC link.</p>
|
|
2285
2285
|
* @public
|
|
2286
2286
|
*/
|
|
2287
|
-
SecurityGroupIds?: string[];
|
|
2287
|
+
SecurityGroupIds?: string[] | undefined;
|
|
2288
2288
|
/**
|
|
2289
2289
|
* <p>A list of subnet IDs to include in the VPC link.</p>
|
|
2290
2290
|
* @public
|
|
@@ -2294,7 +2294,7 @@ export interface CreateVpcLinkRequest {
|
|
|
2294
2294
|
* <p>A list of tags.</p>
|
|
2295
2295
|
* @public
|
|
2296
2296
|
*/
|
|
2297
|
-
Tags?: Record<string, string
|
|
2297
|
+
Tags?: Record<string, string> | undefined;
|
|
2298
2298
|
}
|
|
2299
2299
|
/**
|
|
2300
2300
|
* @public
|
|
@@ -2304,47 +2304,47 @@ export interface CreateVpcLinkResponse {
|
|
|
2304
2304
|
* <p>The timestamp when the VPC link was created.</p>
|
|
2305
2305
|
* @public
|
|
2306
2306
|
*/
|
|
2307
|
-
CreatedDate?: Date;
|
|
2307
|
+
CreatedDate?: Date | undefined;
|
|
2308
2308
|
/**
|
|
2309
2309
|
* <p>The name of the VPC link.</p>
|
|
2310
2310
|
* @public
|
|
2311
2311
|
*/
|
|
2312
|
-
Name?: string;
|
|
2312
|
+
Name?: string | undefined;
|
|
2313
2313
|
/**
|
|
2314
2314
|
* <p>A list of security group IDs for the VPC link.</p>
|
|
2315
2315
|
* @public
|
|
2316
2316
|
*/
|
|
2317
|
-
SecurityGroupIds?: string[];
|
|
2317
|
+
SecurityGroupIds?: string[] | undefined;
|
|
2318
2318
|
/**
|
|
2319
2319
|
* <p>A list of subnet IDs to include in the VPC link.</p>
|
|
2320
2320
|
* @public
|
|
2321
2321
|
*/
|
|
2322
|
-
SubnetIds?: string[];
|
|
2322
|
+
SubnetIds?: string[] | undefined;
|
|
2323
2323
|
/**
|
|
2324
2324
|
* <p>Tags for the VPC link.</p>
|
|
2325
2325
|
* @public
|
|
2326
2326
|
*/
|
|
2327
|
-
Tags?: Record<string, string
|
|
2327
|
+
Tags?: Record<string, string> | undefined;
|
|
2328
2328
|
/**
|
|
2329
2329
|
* <p>The ID of the VPC link.</p>
|
|
2330
2330
|
* @public
|
|
2331
2331
|
*/
|
|
2332
|
-
VpcLinkId?: string;
|
|
2332
|
+
VpcLinkId?: string | undefined;
|
|
2333
2333
|
/**
|
|
2334
2334
|
* <p>The status of the VPC link.</p>
|
|
2335
2335
|
* @public
|
|
2336
2336
|
*/
|
|
2337
|
-
VpcLinkStatus?: VpcLinkStatus;
|
|
2337
|
+
VpcLinkStatus?: VpcLinkStatus | undefined;
|
|
2338
2338
|
/**
|
|
2339
2339
|
* <p>A message summarizing the cause of the status of the VPC link.</p>
|
|
2340
2340
|
* @public
|
|
2341
2341
|
*/
|
|
2342
|
-
VpcLinkStatusMessage?: string;
|
|
2342
|
+
VpcLinkStatusMessage?: string | undefined;
|
|
2343
2343
|
/**
|
|
2344
2344
|
* <p>The version of the VPC link.</p>
|
|
2345
2345
|
* @public
|
|
2346
2346
|
*/
|
|
2347
|
-
VpcLinkVersion?: VpcLinkVersion;
|
|
2347
|
+
VpcLinkVersion?: VpcLinkVersion | undefined;
|
|
2348
2348
|
}
|
|
2349
2349
|
/**
|
|
2350
2350
|
* @public
|
|
@@ -2604,12 +2604,12 @@ export interface ExportApiRequest {
|
|
|
2604
2604
|
* <p>The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.</p>
|
|
2605
2605
|
* @public
|
|
2606
2606
|
*/
|
|
2607
|
-
ExportVersion?: string;
|
|
2607
|
+
ExportVersion?: string | undefined;
|
|
2608
2608
|
/**
|
|
2609
2609
|
* <p>Specifies whether to include <a href="https://docs.aws.amazon.com//apigateway/latest/developerguide/api-gateway-swagger-extensions.html">API Gateway extensions</a> in the exported API definition. API Gateway extensions are included by default.</p>
|
|
2610
2610
|
* @public
|
|
2611
2611
|
*/
|
|
2612
|
-
IncludeExtensions?: boolean;
|
|
2612
|
+
IncludeExtensions?: boolean | undefined;
|
|
2613
2613
|
/**
|
|
2614
2614
|
* <p>The output type of the exported definition file. Valid values are JSON and YAML.</p>
|
|
2615
2615
|
* @public
|
|
@@ -2624,7 +2624,7 @@ export interface ExportApiRequest {
|
|
|
2624
2624
|
* <p>The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.</p>
|
|
2625
2625
|
* @public
|
|
2626
2626
|
*/
|
|
2627
|
-
StageName?: string;
|
|
2627
|
+
StageName?: string | undefined;
|
|
2628
2628
|
}
|
|
2629
2629
|
/**
|
|
2630
2630
|
* @public
|
|
@@ -2634,7 +2634,7 @@ export interface ExportApiResponse {
|
|
|
2634
2634
|
* <p>Represents an exported definition of an API in a particular output format, for example, YAML. The API is serialized to the requested specification, for example, OpenAPI 3.0.</p>
|
|
2635
2635
|
* @public
|
|
2636
2636
|
*/
|
|
2637
|
-
body?: Uint8Array;
|
|
2637
|
+
body?: Uint8Array | undefined;
|
|
2638
2638
|
}
|
|
2639
2639
|
/**
|
|
2640
2640
|
* @public
|
|
@@ -2654,82 +2654,82 @@ export interface GetApiResponse {
|
|
|
2654
2654
|
* <p>The URI of the API, of the form \{api-id\}.execute-api.\{region\}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>
|
|
2655
2655
|
* @public
|
|
2656
2656
|
*/
|
|
2657
|
-
ApiEndpoint?: string;
|
|
2657
|
+
ApiEndpoint?: string | undefined;
|
|
2658
2658
|
/**
|
|
2659
2659
|
* <p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>
|
|
2660
2660
|
* @public
|
|
2661
2661
|
*/
|
|
2662
|
-
ApiGatewayManaged?: boolean;
|
|
2662
|
+
ApiGatewayManaged?: boolean | undefined;
|
|
2663
2663
|
/**
|
|
2664
2664
|
* <p>The API ID.</p>
|
|
2665
2665
|
* @public
|
|
2666
2666
|
*/
|
|
2667
|
-
ApiId?: string;
|
|
2667
|
+
ApiId?: string | undefined;
|
|
2668
2668
|
/**
|
|
2669
2669
|
* <p>An API key selection expression. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">API Key Selection Expressions</a>.</p>
|
|
2670
2670
|
* @public
|
|
2671
2671
|
*/
|
|
2672
|
-
ApiKeySelectionExpression?: string;
|
|
2672
|
+
ApiKeySelectionExpression?: string | undefined;
|
|
2673
2673
|
/**
|
|
2674
2674
|
* <p>A CORS configuration. Supported only for HTTP APIs.</p>
|
|
2675
2675
|
* @public
|
|
2676
2676
|
*/
|
|
2677
|
-
CorsConfiguration?: Cors;
|
|
2677
|
+
CorsConfiguration?: Cors | undefined;
|
|
2678
2678
|
/**
|
|
2679
2679
|
* <p>The timestamp when the API was created.</p>
|
|
2680
2680
|
* @public
|
|
2681
2681
|
*/
|
|
2682
|
-
CreatedDate?: Date;
|
|
2682
|
+
CreatedDate?: Date | undefined;
|
|
2683
2683
|
/**
|
|
2684
2684
|
* <p>The description of the API.</p>
|
|
2685
2685
|
* @public
|
|
2686
2686
|
*/
|
|
2687
|
-
Description?: string;
|
|
2687
|
+
Description?: string | undefined;
|
|
2688
2688
|
/**
|
|
2689
2689
|
* <p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>
|
|
2690
2690
|
* @public
|
|
2691
2691
|
*/
|
|
2692
|
-
DisableSchemaValidation?: boolean;
|
|
2692
|
+
DisableSchemaValidation?: boolean | undefined;
|
|
2693
2693
|
/**
|
|
2694
2694
|
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://\{api_id\}.execute-api.\{region\}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
|
|
2695
2695
|
* @public
|
|
2696
2696
|
*/
|
|
2697
|
-
DisableExecuteApiEndpoint?: boolean;
|
|
2697
|
+
DisableExecuteApiEndpoint?: boolean | undefined;
|
|
2698
2698
|
/**
|
|
2699
2699
|
* <p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>
|
|
2700
2700
|
* @public
|
|
2701
2701
|
*/
|
|
2702
|
-
ImportInfo?: string[];
|
|
2702
|
+
ImportInfo?: string[] | undefined;
|
|
2703
2703
|
/**
|
|
2704
2704
|
* <p>The name of the API.</p>
|
|
2705
2705
|
* @public
|
|
2706
2706
|
*/
|
|
2707
|
-
Name?: string;
|
|
2707
|
+
Name?: string | undefined;
|
|
2708
2708
|
/**
|
|
2709
2709
|
* <p>The API protocol.</p>
|
|
2710
2710
|
* @public
|
|
2711
2711
|
*/
|
|
2712
|
-
ProtocolType?: ProtocolType;
|
|
2712
|
+
ProtocolType?: ProtocolType | undefined;
|
|
2713
2713
|
/**
|
|
2714
2714
|
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
2715
2715
|
* @public
|
|
2716
2716
|
*/
|
|
2717
|
-
RouteSelectionExpression?: string;
|
|
2717
|
+
RouteSelectionExpression?: string | undefined;
|
|
2718
2718
|
/**
|
|
2719
2719
|
* <p>A collection of tags associated with the API.</p>
|
|
2720
2720
|
* @public
|
|
2721
2721
|
*/
|
|
2722
|
-
Tags?: Record<string, string
|
|
2722
|
+
Tags?: Record<string, string> | undefined;
|
|
2723
2723
|
/**
|
|
2724
2724
|
* <p>A version identifier for the API.</p>
|
|
2725
2725
|
* @public
|
|
2726
2726
|
*/
|
|
2727
|
-
Version?: string;
|
|
2727
|
+
Version?: string | undefined;
|
|
2728
2728
|
/**
|
|
2729
2729
|
* <p>The warning messages reported when failonwarnings is turned on during API import.</p>
|
|
2730
2730
|
* @public
|
|
2731
2731
|
*/
|
|
2732
|
-
Warnings?: string[];
|
|
2732
|
+
Warnings?: string[] | undefined;
|
|
2733
2733
|
}
|
|
2734
2734
|
/**
|
|
2735
2735
|
* @public
|
|
@@ -2754,22 +2754,22 @@ export interface GetApiMappingResponse {
|
|
|
2754
2754
|
* <p>The API identifier.</p>
|
|
2755
2755
|
* @public
|
|
2756
2756
|
*/
|
|
2757
|
-
ApiId?: string;
|
|
2757
|
+
ApiId?: string | undefined;
|
|
2758
2758
|
/**
|
|
2759
2759
|
* <p>The API mapping identifier.</p>
|
|
2760
2760
|
* @public
|
|
2761
2761
|
*/
|
|
2762
|
-
ApiMappingId?: string;
|
|
2762
|
+
ApiMappingId?: string | undefined;
|
|
2763
2763
|
/**
|
|
2764
2764
|
* <p>The API mapping key.</p>
|
|
2765
2765
|
* @public
|
|
2766
2766
|
*/
|
|
2767
|
-
ApiMappingKey?: string;
|
|
2767
|
+
ApiMappingKey?: string | undefined;
|
|
2768
2768
|
/**
|
|
2769
2769
|
* <p>The API stage.</p>
|
|
2770
2770
|
* @public
|
|
2771
2771
|
*/
|
|
2772
|
-
Stage?: string;
|
|
2772
|
+
Stage?: string | undefined;
|
|
2773
2773
|
}
|
|
2774
2774
|
/**
|
|
2775
2775
|
* @public
|
|
@@ -2784,12 +2784,12 @@ export interface GetApiMappingsRequest {
|
|
|
2784
2784
|
* <p>The maximum number of elements to be returned for this resource.</p>
|
|
2785
2785
|
* @public
|
|
2786
2786
|
*/
|
|
2787
|
-
MaxResults?: string;
|
|
2787
|
+
MaxResults?: string | undefined;
|
|
2788
2788
|
/**
|
|
2789
2789
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
2790
2790
|
* @public
|
|
2791
2791
|
*/
|
|
2792
|
-
NextToken?: string;
|
|
2792
|
+
NextToken?: string | undefined;
|
|
2793
2793
|
}
|
|
2794
2794
|
/**
|
|
2795
2795
|
* @public
|
|
@@ -2799,12 +2799,12 @@ export interface GetApiMappingsResponse {
|
|
|
2799
2799
|
* <p>The elements from this collection.</p>
|
|
2800
2800
|
* @public
|
|
2801
2801
|
*/
|
|
2802
|
-
Items?: ApiMapping[];
|
|
2802
|
+
Items?: ApiMapping[] | undefined;
|
|
2803
2803
|
/**
|
|
2804
2804
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
2805
2805
|
* @public
|
|
2806
2806
|
*/
|
|
2807
|
-
NextToken?: string;
|
|
2807
|
+
NextToken?: string | undefined;
|
|
2808
2808
|
}
|
|
2809
2809
|
/**
|
|
2810
2810
|
* @public
|
|
@@ -2814,12 +2814,12 @@ export interface GetApisRequest {
|
|
|
2814
2814
|
* <p>The maximum number of elements to be returned for this resource.</p>
|
|
2815
2815
|
* @public
|
|
2816
2816
|
*/
|
|
2817
|
-
MaxResults?: string;
|
|
2817
|
+
MaxResults?: string | undefined;
|
|
2818
2818
|
/**
|
|
2819
2819
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
2820
2820
|
* @public
|
|
2821
2821
|
*/
|
|
2822
|
-
NextToken?: string;
|
|
2822
|
+
NextToken?: string | undefined;
|
|
2823
2823
|
}
|
|
2824
2824
|
/**
|
|
2825
2825
|
* @public
|
|
@@ -2829,12 +2829,12 @@ export interface GetApisResponse {
|
|
|
2829
2829
|
* <p>The elements from this collection.</p>
|
|
2830
2830
|
* @public
|
|
2831
2831
|
*/
|
|
2832
|
-
Items?: Api[];
|
|
2832
|
+
Items?: Api[] | undefined;
|
|
2833
2833
|
/**
|
|
2834
2834
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
2835
2835
|
* @public
|
|
2836
2836
|
*/
|
|
2837
|
-
NextToken?: string;
|
|
2837
|
+
NextToken?: string | undefined;
|
|
2838
2838
|
}
|
|
2839
2839
|
/**
|
|
2840
2840
|
* @public
|
|
@@ -2859,58 +2859,58 @@ export interface GetAuthorizerResponse {
|
|
|
2859
2859
|
* <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, don't specify this parameter. Supported only for REQUEST authorizers.</p>
|
|
2860
2860
|
* @public
|
|
2861
2861
|
*/
|
|
2862
|
-
AuthorizerCredentialsArn?: string;
|
|
2862
|
+
AuthorizerCredentialsArn?: string | undefined;
|
|
2863
2863
|
/**
|
|
2864
2864
|
* <p>The authorizer identifier.</p>
|
|
2865
2865
|
* @public
|
|
2866
2866
|
*/
|
|
2867
|
-
AuthorizerId?: string;
|
|
2867
|
+
AuthorizerId?: string | undefined;
|
|
2868
2868
|
/**
|
|
2869
2869
|
* <p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>
|
|
2870
2870
|
* @public
|
|
2871
2871
|
*/
|
|
2872
|
-
AuthorizerPayloadFormatVersion?: string;
|
|
2872
|
+
AuthorizerPayloadFormatVersion?: string | undefined;
|
|
2873
2873
|
/**
|
|
2874
2874
|
* <p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>
|
|
2875
2875
|
* @public
|
|
2876
2876
|
*/
|
|
2877
|
-
AuthorizerResultTtlInSeconds?: number;
|
|
2877
|
+
AuthorizerResultTtlInSeconds?: number | undefined;
|
|
2878
2878
|
/**
|
|
2879
2879
|
* <p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>
|
|
2880
2880
|
* @public
|
|
2881
2881
|
*/
|
|
2882
|
-
AuthorizerType?: AuthorizerType;
|
|
2882
|
+
AuthorizerType?: AuthorizerType | undefined;
|
|
2883
2883
|
/**
|
|
2884
2884
|
* <p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>\{account_id\}</replaceable>:function:<replaceable>\{lambda_function_name\}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>\{region\}</replaceable>:lambda:path/<replaceable>\{service_api\}</replaceable>
|
|
2885
2885
|
* , where <replaceable></replaceable>\{region\} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>
|
|
2886
2886
|
* @public
|
|
2887
2887
|
*/
|
|
2888
|
-
AuthorizerUri?: string;
|
|
2888
|
+
AuthorizerUri?: string | undefined;
|
|
2889
2889
|
/**
|
|
2890
2890
|
* <p>Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a></p>
|
|
2891
2891
|
* @public
|
|
2892
2892
|
*/
|
|
2893
|
-
EnableSimpleResponses?: boolean;
|
|
2893
|
+
EnableSimpleResponses?: boolean | undefined;
|
|
2894
2894
|
/**
|
|
2895
2895
|
* <p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>
|
|
2896
2896
|
* @public
|
|
2897
2897
|
*/
|
|
2898
|
-
IdentitySource?: string[];
|
|
2898
|
+
IdentitySource?: string[] | undefined;
|
|
2899
2899
|
/**
|
|
2900
2900
|
* <p>The validation expression does not apply to the REQUEST authorizer.</p>
|
|
2901
2901
|
* @public
|
|
2902
2902
|
*/
|
|
2903
|
-
IdentityValidationExpression?: string;
|
|
2903
|
+
IdentityValidationExpression?: string | undefined;
|
|
2904
2904
|
/**
|
|
2905
2905
|
* <p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>
|
|
2906
2906
|
* @public
|
|
2907
2907
|
*/
|
|
2908
|
-
JwtConfiguration?: JWTConfiguration;
|
|
2908
|
+
JwtConfiguration?: JWTConfiguration | undefined;
|
|
2909
2909
|
/**
|
|
2910
2910
|
* <p>The name of the authorizer.</p>
|
|
2911
2911
|
* @public
|
|
2912
2912
|
*/
|
|
2913
|
-
Name?: string;
|
|
2913
|
+
Name?: string | undefined;
|
|
2914
2914
|
}
|
|
2915
2915
|
/**
|
|
2916
2916
|
* @public
|
|
@@ -2925,12 +2925,12 @@ export interface GetAuthorizersRequest {
|
|
|
2925
2925
|
* <p>The maximum number of elements to be returned for this resource.</p>
|
|
2926
2926
|
* @public
|
|
2927
2927
|
*/
|
|
2928
|
-
MaxResults?: string;
|
|
2928
|
+
MaxResults?: string | undefined;
|
|
2929
2929
|
/**
|
|
2930
2930
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
2931
2931
|
* @public
|
|
2932
2932
|
*/
|
|
2933
|
-
NextToken?: string;
|
|
2933
|
+
NextToken?: string | undefined;
|
|
2934
2934
|
}
|
|
2935
2935
|
/**
|
|
2936
2936
|
* @public
|
|
@@ -2940,12 +2940,12 @@ export interface GetAuthorizersResponse {
|
|
|
2940
2940
|
* <p>The elements from this collection.</p>
|
|
2941
2941
|
* @public
|
|
2942
2942
|
*/
|
|
2943
|
-
Items?: Authorizer[];
|
|
2943
|
+
Items?: Authorizer[] | undefined;
|
|
2944
2944
|
/**
|
|
2945
2945
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
2946
2946
|
* @public
|
|
2947
2947
|
*/
|
|
2948
|
-
NextToken?: string;
|
|
2948
|
+
NextToken?: string | undefined;
|
|
2949
2949
|
}
|
|
2950
2950
|
/**
|
|
2951
2951
|
* @public
|
|
@@ -2970,32 +2970,32 @@ export interface GetDeploymentResponse {
|
|
|
2970
2970
|
* <p>Specifies whether a deployment was automatically released.</p>
|
|
2971
2971
|
* @public
|
|
2972
2972
|
*/
|
|
2973
|
-
AutoDeployed?: boolean;
|
|
2973
|
+
AutoDeployed?: boolean | undefined;
|
|
2974
2974
|
/**
|
|
2975
2975
|
* <p>The date and time when the Deployment resource was created.</p>
|
|
2976
2976
|
* @public
|
|
2977
2977
|
*/
|
|
2978
|
-
CreatedDate?: Date;
|
|
2978
|
+
CreatedDate?: Date | undefined;
|
|
2979
2979
|
/**
|
|
2980
2980
|
* <p>The identifier for the deployment.</p>
|
|
2981
2981
|
* @public
|
|
2982
2982
|
*/
|
|
2983
|
-
DeploymentId?: string;
|
|
2983
|
+
DeploymentId?: string | undefined;
|
|
2984
2984
|
/**
|
|
2985
2985
|
* <p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>
|
|
2986
2986
|
* @public
|
|
2987
2987
|
*/
|
|
2988
|
-
DeploymentStatus?: DeploymentStatus;
|
|
2988
|
+
DeploymentStatus?: DeploymentStatus | undefined;
|
|
2989
2989
|
/**
|
|
2990
2990
|
* <p>May contain additional feedback on the status of an API deployment.</p>
|
|
2991
2991
|
* @public
|
|
2992
2992
|
*/
|
|
2993
|
-
DeploymentStatusMessage?: string;
|
|
2993
|
+
DeploymentStatusMessage?: string | undefined;
|
|
2994
2994
|
/**
|
|
2995
2995
|
* <p>The description for the deployment.</p>
|
|
2996
2996
|
* @public
|
|
2997
2997
|
*/
|
|
2998
|
-
Description?: string;
|
|
2998
|
+
Description?: string | undefined;
|
|
2999
2999
|
}
|
|
3000
3000
|
/**
|
|
3001
3001
|
* @public
|
|
@@ -3010,12 +3010,12 @@ export interface GetDeploymentsRequest {
|
|
|
3010
3010
|
* <p>The maximum number of elements to be returned for this resource.</p>
|
|
3011
3011
|
* @public
|
|
3012
3012
|
*/
|
|
3013
|
-
MaxResults?: string;
|
|
3013
|
+
MaxResults?: string | undefined;
|
|
3014
3014
|
/**
|
|
3015
3015
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
3016
3016
|
* @public
|
|
3017
3017
|
*/
|
|
3018
|
-
NextToken?: string;
|
|
3018
|
+
NextToken?: string | undefined;
|
|
3019
3019
|
}
|
|
3020
3020
|
/**
|
|
3021
3021
|
* @public
|
|
@@ -3025,12 +3025,12 @@ export interface GetDeploymentsResponse {
|
|
|
3025
3025
|
* <p>The elements from this collection.</p>
|
|
3026
3026
|
* @public
|
|
3027
3027
|
*/
|
|
3028
|
-
Items?: Deployment[];
|
|
3028
|
+
Items?: Deployment[] | undefined;
|
|
3029
3029
|
/**
|
|
3030
3030
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
3031
3031
|
* @public
|
|
3032
3032
|
*/
|
|
3033
|
-
NextToken?: string;
|
|
3033
|
+
NextToken?: string | undefined;
|
|
3034
3034
|
}
|
|
3035
3035
|
/**
|
|
3036
3036
|
* @public
|
|
@@ -3050,27 +3050,27 @@ export interface GetDomainNameResponse {
|
|
|
3050
3050
|
* <p>The API mapping selection expression.</p>
|
|
3051
3051
|
* @public
|
|
3052
3052
|
*/
|
|
3053
|
-
ApiMappingSelectionExpression?: string;
|
|
3053
|
+
ApiMappingSelectionExpression?: string | undefined;
|
|
3054
3054
|
/**
|
|
3055
3055
|
* <p>The name of the DomainName resource.</p>
|
|
3056
3056
|
* @public
|
|
3057
3057
|
*/
|
|
3058
|
-
DomainName?: string;
|
|
3058
|
+
DomainName?: string | undefined;
|
|
3059
3059
|
/**
|
|
3060
3060
|
* <p>The domain name configurations.</p>
|
|
3061
3061
|
* @public
|
|
3062
3062
|
*/
|
|
3063
|
-
DomainNameConfigurations?: DomainNameConfiguration[];
|
|
3063
|
+
DomainNameConfigurations?: DomainNameConfiguration[] | undefined;
|
|
3064
3064
|
/**
|
|
3065
3065
|
* <p>The mutual TLS authentication configuration for a custom domain name.</p>
|
|
3066
3066
|
* @public
|
|
3067
3067
|
*/
|
|
3068
|
-
MutualTlsAuthentication?: MutualTlsAuthentication;
|
|
3068
|
+
MutualTlsAuthentication?: MutualTlsAuthentication | undefined;
|
|
3069
3069
|
/**
|
|
3070
3070
|
* <p>The collection of tags associated with a domain name.</p>
|
|
3071
3071
|
* @public
|
|
3072
3072
|
*/
|
|
3073
|
-
Tags?: Record<string, string
|
|
3073
|
+
Tags?: Record<string, string> | undefined;
|
|
3074
3074
|
}
|
|
3075
3075
|
/**
|
|
3076
3076
|
* @public
|
|
@@ -3080,12 +3080,12 @@ export interface GetDomainNamesRequest {
|
|
|
3080
3080
|
* <p>The maximum number of elements to be returned for this resource.</p>
|
|
3081
3081
|
* @public
|
|
3082
3082
|
*/
|
|
3083
|
-
MaxResults?: string;
|
|
3083
|
+
MaxResults?: string | undefined;
|
|
3084
3084
|
/**
|
|
3085
3085
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
3086
3086
|
* @public
|
|
3087
3087
|
*/
|
|
3088
|
-
NextToken?: string;
|
|
3088
|
+
NextToken?: string | undefined;
|
|
3089
3089
|
}
|
|
3090
3090
|
/**
|
|
3091
3091
|
* @public
|
|
@@ -3095,12 +3095,12 @@ export interface GetDomainNamesResponse {
|
|
|
3095
3095
|
* <p>The elements from this collection.</p>
|
|
3096
3096
|
* @public
|
|
3097
3097
|
*/
|
|
3098
|
-
Items?: DomainName[];
|
|
3098
|
+
Items?: DomainName[] | undefined;
|
|
3099
3099
|
/**
|
|
3100
3100
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
3101
3101
|
* @public
|
|
3102
3102
|
*/
|
|
3103
|
-
NextToken?: string;
|
|
3103
|
+
NextToken?: string | undefined;
|
|
3104
3104
|
}
|
|
3105
3105
|
/**
|
|
3106
3106
|
* @public
|
|
@@ -3125,72 +3125,72 @@ export interface GetIntegrationResult {
|
|
|
3125
3125
|
* <p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>
|
|
3126
3126
|
* @public
|
|
3127
3127
|
*/
|
|
3128
|
-
ApiGatewayManaged?: boolean;
|
|
3128
|
+
ApiGatewayManaged?: boolean | undefined;
|
|
3129
3129
|
/**
|
|
3130
3130
|
* <p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>
|
|
3131
3131
|
* @public
|
|
3132
3132
|
*/
|
|
3133
|
-
ConnectionId?: string;
|
|
3133
|
+
ConnectionId?: string | undefined;
|
|
3134
3134
|
/**
|
|
3135
3135
|
* <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
|
|
3136
3136
|
* @public
|
|
3137
3137
|
*/
|
|
3138
|
-
ConnectionType?: ConnectionType;
|
|
3138
|
+
ConnectionType?: ConnectionType | undefined;
|
|
3139
3139
|
/**
|
|
3140
3140
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
3141
3141
|
* @public
|
|
3142
3142
|
*/
|
|
3143
|
-
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
3143
|
+
ContentHandlingStrategy?: ContentHandlingStrategy | undefined;
|
|
3144
3144
|
/**
|
|
3145
3145
|
* <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 arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>
|
|
3146
3146
|
* @public
|
|
3147
3147
|
*/
|
|
3148
|
-
CredentialsArn?: string;
|
|
3148
|
+
CredentialsArn?: string | undefined;
|
|
3149
3149
|
/**
|
|
3150
3150
|
* <p>Represents the description of an integration.</p>
|
|
3151
3151
|
* @public
|
|
3152
3152
|
*/
|
|
3153
|
-
Description?: string;
|
|
3153
|
+
Description?: string | undefined;
|
|
3154
3154
|
/**
|
|
3155
3155
|
* <p>Represents the identifier of an integration.</p>
|
|
3156
3156
|
* @public
|
|
3157
3157
|
*/
|
|
3158
|
-
IntegrationId?: string;
|
|
3158
|
+
IntegrationId?: string | undefined;
|
|
3159
3159
|
/**
|
|
3160
3160
|
* <p>Specifies the integration's HTTP method type.</p>
|
|
3161
3161
|
* @public
|
|
3162
3162
|
*/
|
|
3163
|
-
IntegrationMethod?: string;
|
|
3163
|
+
IntegrationMethod?: string | undefined;
|
|
3164
3164
|
/**
|
|
3165
3165
|
* <p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions">Integration Response Selection Expressions</a>.</p>
|
|
3166
3166
|
* @public
|
|
3167
3167
|
*/
|
|
3168
|
-
IntegrationResponseSelectionExpression?: string;
|
|
3168
|
+
IntegrationResponseSelectionExpression?: string | undefined;
|
|
3169
3169
|
/**
|
|
3170
3170
|
* <p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html">Integration subtype reference</a>.</p>
|
|
3171
3171
|
* @public
|
|
3172
3172
|
*/
|
|
3173
|
-
IntegrationSubtype?: string;
|
|
3173
|
+
IntegrationSubtype?: string | undefined;
|
|
3174
3174
|
/**
|
|
3175
3175
|
* <p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
|
|
3176
3176
|
* @public
|
|
3177
3177
|
*/
|
|
3178
|
-
IntegrationType?: IntegrationType;
|
|
3178
|
+
IntegrationType?: IntegrationType | undefined;
|
|
3179
3179
|
/**
|
|
3180
3180
|
* <p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
|
|
3181
3181
|
* @public
|
|
3182
3182
|
*/
|
|
3183
|
-
IntegrationUri?: string;
|
|
3183
|
+
IntegrationUri?: string | undefined;
|
|
3184
3184
|
/**
|
|
3185
3185
|
* <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 requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>
|
|
3186
3186
|
* @public
|
|
3187
3187
|
*/
|
|
3188
|
-
PassthroughBehavior?: PassthroughBehavior;
|
|
3188
|
+
PassthroughBehavior?: PassthroughBehavior | undefined;
|
|
3189
3189
|
/**
|
|
3190
3190
|
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
|
|
3191
3191
|
* @public
|
|
3192
3192
|
*/
|
|
3193
|
-
PayloadFormatVersion?: string;
|
|
3193
|
+
PayloadFormatVersion?: string | undefined;
|
|
3194
3194
|
/**
|
|
3195
3195
|
* <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>\{location\}</replaceable>.<replaceable>\{name\}</replaceable>
|
|
3196
3196
|
* , where
|
|
@@ -3200,32 +3200,32 @@ export interface GetIntegrationResult {
|
|
|
3200
3200
|
* must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
|
|
3201
3201
|
* @public
|
|
3202
3202
|
*/
|
|
3203
|
-
RequestParameters?: Record<string, string
|
|
3203
|
+
RequestParameters?: Record<string, string> | undefined;
|
|
3204
3204
|
/**
|
|
3205
3205
|
* <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. Supported only for WebSocket APIs.</p>
|
|
3206
3206
|
* @public
|
|
3207
3207
|
*/
|
|
3208
|
-
RequestTemplates?: Record<string, string
|
|
3208
|
+
RequestTemplates?: Record<string, string> | undefined;
|
|
3209
3209
|
/**
|
|
3210
3210
|
* <p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
|
|
3211
3211
|
* @public
|
|
3212
3212
|
*/
|
|
3213
|
-
ResponseParameters?: Record<string, Record<string, string
|
|
3213
|
+
ResponseParameters?: Record<string, Record<string, string>> | undefined;
|
|
3214
3214
|
/**
|
|
3215
3215
|
* <p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>
|
|
3216
3216
|
* @public
|
|
3217
3217
|
*/
|
|
3218
|
-
TemplateSelectionExpression?: string;
|
|
3218
|
+
TemplateSelectionExpression?: string | undefined;
|
|
3219
3219
|
/**
|
|
3220
3220
|
* <p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>
|
|
3221
3221
|
* @public
|
|
3222
3222
|
*/
|
|
3223
|
-
TimeoutInMillis?: number;
|
|
3223
|
+
TimeoutInMillis?: number | undefined;
|
|
3224
3224
|
/**
|
|
3225
3225
|
* <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
|
|
3226
3226
|
* @public
|
|
3227
3227
|
*/
|
|
3228
|
-
TlsConfig?: TlsConfig;
|
|
3228
|
+
TlsConfig?: TlsConfig | undefined;
|
|
3229
3229
|
}
|
|
3230
3230
|
/**
|
|
3231
3231
|
* @public
|
|
@@ -3255,32 +3255,32 @@ export interface GetIntegrationResponseResponse {
|
|
|
3255
3255
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
3256
3256
|
* @public
|
|
3257
3257
|
*/
|
|
3258
|
-
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
3258
|
+
ContentHandlingStrategy?: ContentHandlingStrategy | undefined;
|
|
3259
3259
|
/**
|
|
3260
3260
|
* <p>The integration response ID.</p>
|
|
3261
3261
|
* @public
|
|
3262
3262
|
*/
|
|
3263
|
-
IntegrationResponseId?: string;
|
|
3263
|
+
IntegrationResponseId?: string | undefined;
|
|
3264
3264
|
/**
|
|
3265
3265
|
* <p>The integration response key.</p>
|
|
3266
3266
|
* @public
|
|
3267
3267
|
*/
|
|
3268
|
-
IntegrationResponseKey?: string;
|
|
3268
|
+
IntegrationResponseKey?: string | undefined;
|
|
3269
3269
|
/**
|
|
3270
3270
|
* <p>A key-value map specifying response parameters that are passed to the method response from the backend. 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 method.response.header.\{name\}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.\{name\} or integration.response.body.\{JSON-expression\}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.</p>
|
|
3271
3271
|
* @public
|
|
3272
3272
|
*/
|
|
3273
|
-
ResponseParameters?: Record<string, string
|
|
3273
|
+
ResponseParameters?: Record<string, string> | undefined;
|
|
3274
3274
|
/**
|
|
3275
3275
|
* <p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>
|
|
3276
3276
|
* @public
|
|
3277
3277
|
*/
|
|
3278
|
-
ResponseTemplates?: Record<string, string
|
|
3278
|
+
ResponseTemplates?: Record<string, string> | undefined;
|
|
3279
3279
|
/**
|
|
3280
3280
|
* <p>The template selection expressions for the integration response.</p>
|
|
3281
3281
|
* @public
|
|
3282
3282
|
*/
|
|
3283
|
-
TemplateSelectionExpression?: string;
|
|
3283
|
+
TemplateSelectionExpression?: string | undefined;
|
|
3284
3284
|
}
|
|
3285
3285
|
/**
|
|
3286
3286
|
* @public
|
|
@@ -3300,12 +3300,12 @@ export interface GetIntegrationResponsesRequest {
|
|
|
3300
3300
|
* <p>The maximum number of elements to be returned for this resource.</p>
|
|
3301
3301
|
* @public
|
|
3302
3302
|
*/
|
|
3303
|
-
MaxResults?: string;
|
|
3303
|
+
MaxResults?: string | undefined;
|
|
3304
3304
|
/**
|
|
3305
3305
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
3306
3306
|
* @public
|
|
3307
3307
|
*/
|
|
3308
|
-
NextToken?: string;
|
|
3308
|
+
NextToken?: string | undefined;
|
|
3309
3309
|
}
|
|
3310
3310
|
/**
|
|
3311
3311
|
* @public
|
|
@@ -3315,12 +3315,12 @@ export interface GetIntegrationResponsesResponse {
|
|
|
3315
3315
|
* <p>The elements from this collection.</p>
|
|
3316
3316
|
* @public
|
|
3317
3317
|
*/
|
|
3318
|
-
Items?: IntegrationResponse[];
|
|
3318
|
+
Items?: IntegrationResponse[] | undefined;
|
|
3319
3319
|
/**
|
|
3320
3320
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
3321
3321
|
* @public
|
|
3322
3322
|
*/
|
|
3323
|
-
NextToken?: string;
|
|
3323
|
+
NextToken?: string | undefined;
|
|
3324
3324
|
}
|
|
3325
3325
|
/**
|
|
3326
3326
|
* @public
|
|
@@ -3335,12 +3335,12 @@ export interface GetIntegrationsRequest {
|
|
|
3335
3335
|
* <p>The maximum number of elements to be returned for this resource.</p>
|
|
3336
3336
|
* @public
|
|
3337
3337
|
*/
|
|
3338
|
-
MaxResults?: string;
|
|
3338
|
+
MaxResults?: string | undefined;
|
|
3339
3339
|
/**
|
|
3340
3340
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
3341
3341
|
* @public
|
|
3342
3342
|
*/
|
|
3343
|
-
NextToken?: string;
|
|
3343
|
+
NextToken?: string | undefined;
|
|
3344
3344
|
}
|
|
3345
3345
|
/**
|
|
3346
3346
|
* @public
|
|
@@ -3350,12 +3350,12 @@ export interface GetIntegrationsResponse {
|
|
|
3350
3350
|
* <p>The elements from this collection.</p>
|
|
3351
3351
|
* @public
|
|
3352
3352
|
*/
|
|
3353
|
-
Items?: Integration[];
|
|
3353
|
+
Items?: Integration[] | undefined;
|
|
3354
3354
|
/**
|
|
3355
3355
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
3356
3356
|
* @public
|
|
3357
3357
|
*/
|
|
3358
|
-
NextToken?: string;
|
|
3358
|
+
NextToken?: string | undefined;
|
|
3359
3359
|
}
|
|
3360
3360
|
/**
|
|
3361
3361
|
* @public
|
|
@@ -3380,27 +3380,27 @@ export interface GetModelResponse {
|
|
|
3380
3380
|
* <p>The content-type for the model, for example, "application/json".</p>
|
|
3381
3381
|
* @public
|
|
3382
3382
|
*/
|
|
3383
|
-
ContentType?: string;
|
|
3383
|
+
ContentType?: string | undefined;
|
|
3384
3384
|
/**
|
|
3385
3385
|
* <p>The description of the model.</p>
|
|
3386
3386
|
* @public
|
|
3387
3387
|
*/
|
|
3388
|
-
Description?: string;
|
|
3388
|
+
Description?: string | undefined;
|
|
3389
3389
|
/**
|
|
3390
3390
|
* <p>The model identifier.</p>
|
|
3391
3391
|
* @public
|
|
3392
3392
|
*/
|
|
3393
|
-
ModelId?: string;
|
|
3393
|
+
ModelId?: string | undefined;
|
|
3394
3394
|
/**
|
|
3395
3395
|
* <p>The name of the model. Must be alphanumeric.</p>
|
|
3396
3396
|
* @public
|
|
3397
3397
|
*/
|
|
3398
|
-
Name?: string;
|
|
3398
|
+
Name?: string | undefined;
|
|
3399
3399
|
/**
|
|
3400
3400
|
* <p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>
|
|
3401
3401
|
* @public
|
|
3402
3402
|
*/
|
|
3403
|
-
Schema?: string;
|
|
3403
|
+
Schema?: string | undefined;
|
|
3404
3404
|
}
|
|
3405
3405
|
/**
|
|
3406
3406
|
* @public
|
|
@@ -3415,12 +3415,12 @@ export interface GetModelsRequest {
|
|
|
3415
3415
|
* <p>The maximum number of elements to be returned for this resource.</p>
|
|
3416
3416
|
* @public
|
|
3417
3417
|
*/
|
|
3418
|
-
MaxResults?: string;
|
|
3418
|
+
MaxResults?: string | undefined;
|
|
3419
3419
|
/**
|
|
3420
3420
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
3421
3421
|
* @public
|
|
3422
3422
|
*/
|
|
3423
|
-
NextToken?: string;
|
|
3423
|
+
NextToken?: string | undefined;
|
|
3424
3424
|
}
|
|
3425
3425
|
/**
|
|
3426
3426
|
* @public
|
|
@@ -3430,12 +3430,12 @@ export interface GetModelsResponse {
|
|
|
3430
3430
|
* <p>The elements from this collection.</p>
|
|
3431
3431
|
* @public
|
|
3432
3432
|
*/
|
|
3433
|
-
Items?: Model[];
|
|
3433
|
+
Items?: Model[] | undefined;
|
|
3434
3434
|
/**
|
|
3435
3435
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
3436
3436
|
* @public
|
|
3437
3437
|
*/
|
|
3438
|
-
NextToken?: string;
|
|
3438
|
+
NextToken?: string | undefined;
|
|
3439
3439
|
}
|
|
3440
3440
|
/**
|
|
3441
3441
|
* @public
|
|
@@ -3460,7 +3460,7 @@ export interface GetModelTemplateResponse {
|
|
|
3460
3460
|
* <p>The template value.</p>
|
|
3461
3461
|
* @public
|
|
3462
3462
|
*/
|
|
3463
|
-
Value?: string;
|
|
3463
|
+
Value?: string | undefined;
|
|
3464
3464
|
}
|
|
3465
3465
|
/**
|
|
3466
3466
|
* @public
|
|
@@ -3485,67 +3485,67 @@ export interface GetRouteResult {
|
|
|
3485
3485
|
* <p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>
|
|
3486
3486
|
* @public
|
|
3487
3487
|
*/
|
|
3488
|
-
ApiGatewayManaged?: boolean;
|
|
3488
|
+
ApiGatewayManaged?: boolean | undefined;
|
|
3489
3489
|
/**
|
|
3490
3490
|
* <p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>
|
|
3491
3491
|
* @public
|
|
3492
3492
|
*/
|
|
3493
|
-
ApiKeyRequired?: boolean;
|
|
3493
|
+
ApiKeyRequired?: boolean | undefined;
|
|
3494
3494
|
/**
|
|
3495
3495
|
* <p>A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>
|
|
3496
3496
|
* @public
|
|
3497
3497
|
*/
|
|
3498
|
-
AuthorizationScopes?: string[];
|
|
3498
|
+
AuthorizationScopes?: string[] | undefined;
|
|
3499
3499
|
/**
|
|
3500
3500
|
* <p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>
|
|
3501
3501
|
* @public
|
|
3502
3502
|
*/
|
|
3503
|
-
AuthorizationType?: AuthorizationType;
|
|
3503
|
+
AuthorizationType?: AuthorizationType | undefined;
|
|
3504
3504
|
/**
|
|
3505
3505
|
* <p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>
|
|
3506
3506
|
* @public
|
|
3507
3507
|
*/
|
|
3508
|
-
AuthorizerId?: string;
|
|
3508
|
+
AuthorizerId?: string | undefined;
|
|
3509
3509
|
/**
|
|
3510
3510
|
* <p>The model selection expression for the route. Supported only for WebSocket APIs.</p>
|
|
3511
3511
|
* @public
|
|
3512
3512
|
*/
|
|
3513
|
-
ModelSelectionExpression?: string;
|
|
3513
|
+
ModelSelectionExpression?: string | undefined;
|
|
3514
3514
|
/**
|
|
3515
3515
|
* <p>The operation name for the route.</p>
|
|
3516
3516
|
* @public
|
|
3517
3517
|
*/
|
|
3518
|
-
OperationName?: string;
|
|
3518
|
+
OperationName?: string | undefined;
|
|
3519
3519
|
/**
|
|
3520
3520
|
* <p>The request models for the route. Supported only for WebSocket APIs.</p>
|
|
3521
3521
|
* @public
|
|
3522
3522
|
*/
|
|
3523
|
-
RequestModels?: Record<string, string
|
|
3523
|
+
RequestModels?: Record<string, string> | undefined;
|
|
3524
3524
|
/**
|
|
3525
3525
|
* <p>The request parameters for the route. Supported only for WebSocket APIs.</p>
|
|
3526
3526
|
* @public
|
|
3527
3527
|
*/
|
|
3528
|
-
RequestParameters?: Record<string, ParameterConstraints
|
|
3528
|
+
RequestParameters?: Record<string, ParameterConstraints> | undefined;
|
|
3529
3529
|
/**
|
|
3530
3530
|
* <p>The route ID.</p>
|
|
3531
3531
|
* @public
|
|
3532
3532
|
*/
|
|
3533
|
-
RouteId?: string;
|
|
3533
|
+
RouteId?: string | undefined;
|
|
3534
3534
|
/**
|
|
3535
3535
|
* <p>The route key for the route.</p>
|
|
3536
3536
|
* @public
|
|
3537
3537
|
*/
|
|
3538
|
-
RouteKey?: string;
|
|
3538
|
+
RouteKey?: string | undefined;
|
|
3539
3539
|
/**
|
|
3540
3540
|
* <p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>
|
|
3541
3541
|
* @public
|
|
3542
3542
|
*/
|
|
3543
|
-
RouteResponseSelectionExpression?: string;
|
|
3543
|
+
RouteResponseSelectionExpression?: string | undefined;
|
|
3544
3544
|
/**
|
|
3545
3545
|
* <p>The target for the route.</p>
|
|
3546
3546
|
* @public
|
|
3547
3547
|
*/
|
|
3548
|
-
Target?: string;
|
|
3548
|
+
Target?: string | undefined;
|
|
3549
3549
|
}
|
|
3550
3550
|
/**
|
|
3551
3551
|
* @public
|
|
@@ -3575,27 +3575,27 @@ export interface GetRouteResponseResponse {
|
|
|
3575
3575
|
* <p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>
|
|
3576
3576
|
* @public
|
|
3577
3577
|
*/
|
|
3578
|
-
ModelSelectionExpression?: string;
|
|
3578
|
+
ModelSelectionExpression?: string | undefined;
|
|
3579
3579
|
/**
|
|
3580
3580
|
* <p>Represents the response models of a route response.</p>
|
|
3581
3581
|
* @public
|
|
3582
3582
|
*/
|
|
3583
|
-
ResponseModels?: Record<string, string
|
|
3583
|
+
ResponseModels?: Record<string, string> | undefined;
|
|
3584
3584
|
/**
|
|
3585
3585
|
* <p>Represents the response parameters of a route response.</p>
|
|
3586
3586
|
* @public
|
|
3587
3587
|
*/
|
|
3588
|
-
ResponseParameters?: Record<string, ParameterConstraints
|
|
3588
|
+
ResponseParameters?: Record<string, ParameterConstraints> | undefined;
|
|
3589
3589
|
/**
|
|
3590
3590
|
* <p>Represents the identifier of a route response.</p>
|
|
3591
3591
|
* @public
|
|
3592
3592
|
*/
|
|
3593
|
-
RouteResponseId?: string;
|
|
3593
|
+
RouteResponseId?: string | undefined;
|
|
3594
3594
|
/**
|
|
3595
3595
|
* <p>Represents the route response key of a route response.</p>
|
|
3596
3596
|
* @public
|
|
3597
3597
|
*/
|
|
3598
|
-
RouteResponseKey?: string;
|
|
3598
|
+
RouteResponseKey?: string | undefined;
|
|
3599
3599
|
}
|
|
3600
3600
|
/**
|
|
3601
3601
|
* @public
|
|
@@ -3610,12 +3610,12 @@ export interface GetRouteResponsesRequest {
|
|
|
3610
3610
|
* <p>The maximum number of elements to be returned for this resource.</p>
|
|
3611
3611
|
* @public
|
|
3612
3612
|
*/
|
|
3613
|
-
MaxResults?: string;
|
|
3613
|
+
MaxResults?: string | undefined;
|
|
3614
3614
|
/**
|
|
3615
3615
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
3616
3616
|
* @public
|
|
3617
3617
|
*/
|
|
3618
|
-
NextToken?: string;
|
|
3618
|
+
NextToken?: string | undefined;
|
|
3619
3619
|
/**
|
|
3620
3620
|
* <p>The route ID.</p>
|
|
3621
3621
|
* @public
|
|
@@ -3630,12 +3630,12 @@ export interface GetRouteResponsesResponse {
|
|
|
3630
3630
|
* <p>The elements from this collection.</p>
|
|
3631
3631
|
* @public
|
|
3632
3632
|
*/
|
|
3633
|
-
Items?: RouteResponse[];
|
|
3633
|
+
Items?: RouteResponse[] | undefined;
|
|
3634
3634
|
/**
|
|
3635
3635
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
3636
3636
|
* @public
|
|
3637
3637
|
*/
|
|
3638
|
-
NextToken?: string;
|
|
3638
|
+
NextToken?: string | undefined;
|
|
3639
3639
|
}
|
|
3640
3640
|
/**
|
|
3641
3641
|
* @public
|
|
@@ -3650,12 +3650,12 @@ export interface GetRoutesRequest {
|
|
|
3650
3650
|
* <p>The maximum number of elements to be returned for this resource.</p>
|
|
3651
3651
|
* @public
|
|
3652
3652
|
*/
|
|
3653
|
-
MaxResults?: string;
|
|
3653
|
+
MaxResults?: string | undefined;
|
|
3654
3654
|
/**
|
|
3655
3655
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
3656
3656
|
* @public
|
|
3657
3657
|
*/
|
|
3658
|
-
NextToken?: string;
|
|
3658
|
+
NextToken?: string | undefined;
|
|
3659
3659
|
}
|
|
3660
3660
|
/**
|
|
3661
3661
|
* @public
|
|
@@ -3665,12 +3665,12 @@ export interface GetRoutesResponse {
|
|
|
3665
3665
|
* <p>The elements from this collection.</p>
|
|
3666
3666
|
* @public
|
|
3667
3667
|
*/
|
|
3668
|
-
Items?: Route[];
|
|
3668
|
+
Items?: Route[] | undefined;
|
|
3669
3669
|
/**
|
|
3670
3670
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
3671
3671
|
* @public
|
|
3672
3672
|
*/
|
|
3673
|
-
NextToken?: string;
|
|
3673
|
+
NextToken?: string | undefined;
|
|
3674
3674
|
}
|
|
3675
3675
|
/**
|
|
3676
3676
|
* @public
|
|
@@ -3695,72 +3695,72 @@ export interface GetStageResponse {
|
|
|
3695
3695
|
* <p>Settings for logging access in this stage.</p>
|
|
3696
3696
|
* @public
|
|
3697
3697
|
*/
|
|
3698
|
-
AccessLogSettings?: AccessLogSettings;
|
|
3698
|
+
AccessLogSettings?: AccessLogSettings | undefined;
|
|
3699
3699
|
/**
|
|
3700
3700
|
* <p>Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.</p>
|
|
3701
3701
|
* @public
|
|
3702
3702
|
*/
|
|
3703
|
-
ApiGatewayManaged?: boolean;
|
|
3703
|
+
ApiGatewayManaged?: boolean | undefined;
|
|
3704
3704
|
/**
|
|
3705
3705
|
* <p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>
|
|
3706
3706
|
* @public
|
|
3707
3707
|
*/
|
|
3708
|
-
AutoDeploy?: boolean;
|
|
3708
|
+
AutoDeploy?: boolean | undefined;
|
|
3709
3709
|
/**
|
|
3710
3710
|
* <p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>
|
|
3711
3711
|
* @public
|
|
3712
3712
|
*/
|
|
3713
|
-
ClientCertificateId?: string;
|
|
3713
|
+
ClientCertificateId?: string | undefined;
|
|
3714
3714
|
/**
|
|
3715
3715
|
* <p>The timestamp when the stage was created.</p>
|
|
3716
3716
|
* @public
|
|
3717
3717
|
*/
|
|
3718
|
-
CreatedDate?: Date;
|
|
3718
|
+
CreatedDate?: Date | undefined;
|
|
3719
3719
|
/**
|
|
3720
3720
|
* <p>Default route settings for the stage.</p>
|
|
3721
3721
|
* @public
|
|
3722
3722
|
*/
|
|
3723
|
-
DefaultRouteSettings?: RouteSettings;
|
|
3723
|
+
DefaultRouteSettings?: RouteSettings | undefined;
|
|
3724
3724
|
/**
|
|
3725
3725
|
* <p>The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.</p>
|
|
3726
3726
|
* @public
|
|
3727
3727
|
*/
|
|
3728
|
-
DeploymentId?: string;
|
|
3728
|
+
DeploymentId?: string | undefined;
|
|
3729
3729
|
/**
|
|
3730
3730
|
* <p>The description of the stage.</p>
|
|
3731
3731
|
* @public
|
|
3732
3732
|
*/
|
|
3733
|
-
Description?: string;
|
|
3733
|
+
Description?: string | undefined;
|
|
3734
3734
|
/**
|
|
3735
3735
|
* <p>Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.</p>
|
|
3736
3736
|
* @public
|
|
3737
3737
|
*/
|
|
3738
|
-
LastDeploymentStatusMessage?: string;
|
|
3738
|
+
LastDeploymentStatusMessage?: string | undefined;
|
|
3739
3739
|
/**
|
|
3740
3740
|
* <p>The timestamp when the stage was last updated.</p>
|
|
3741
3741
|
* @public
|
|
3742
3742
|
*/
|
|
3743
|
-
LastUpdatedDate?: Date;
|
|
3743
|
+
LastUpdatedDate?: Date | undefined;
|
|
3744
3744
|
/**
|
|
3745
3745
|
* <p>Route settings for the stage, by routeKey.</p>
|
|
3746
3746
|
* @public
|
|
3747
3747
|
*/
|
|
3748
|
-
RouteSettings?: Record<string, RouteSettings
|
|
3748
|
+
RouteSettings?: Record<string, RouteSettings> | undefined;
|
|
3749
3749
|
/**
|
|
3750
3750
|
* <p>The name of the stage.</p>
|
|
3751
3751
|
* @public
|
|
3752
3752
|
*/
|
|
3753
|
-
StageName?: string;
|
|
3753
|
+
StageName?: string | undefined;
|
|
3754
3754
|
/**
|
|
3755
3755
|
* <p>A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>
|
|
3756
3756
|
* @public
|
|
3757
3757
|
*/
|
|
3758
|
-
StageVariables?: Record<string, string
|
|
3758
|
+
StageVariables?: Record<string, string> | undefined;
|
|
3759
3759
|
/**
|
|
3760
3760
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
3761
3761
|
* @public
|
|
3762
3762
|
*/
|
|
3763
|
-
Tags?: Record<string, string
|
|
3763
|
+
Tags?: Record<string, string> | undefined;
|
|
3764
3764
|
}
|
|
3765
3765
|
/**
|
|
3766
3766
|
* @public
|
|
@@ -3775,12 +3775,12 @@ export interface GetStagesRequest {
|
|
|
3775
3775
|
* <p>The maximum number of elements to be returned for this resource.</p>
|
|
3776
3776
|
* @public
|
|
3777
3777
|
*/
|
|
3778
|
-
MaxResults?: string;
|
|
3778
|
+
MaxResults?: string | undefined;
|
|
3779
3779
|
/**
|
|
3780
3780
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
3781
3781
|
* @public
|
|
3782
3782
|
*/
|
|
3783
|
-
NextToken?: string;
|
|
3783
|
+
NextToken?: string | undefined;
|
|
3784
3784
|
}
|
|
3785
3785
|
/**
|
|
3786
3786
|
* @public
|
|
@@ -3790,12 +3790,12 @@ export interface GetStagesResponse {
|
|
|
3790
3790
|
* <p>The elements from this collection.</p>
|
|
3791
3791
|
* @public
|
|
3792
3792
|
*/
|
|
3793
|
-
Items?: Stage[];
|
|
3793
|
+
Items?: Stage[] | undefined;
|
|
3794
3794
|
/**
|
|
3795
3795
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
3796
3796
|
* @public
|
|
3797
3797
|
*/
|
|
3798
|
-
NextToken?: string;
|
|
3798
|
+
NextToken?: string | undefined;
|
|
3799
3799
|
}
|
|
3800
3800
|
/**
|
|
3801
3801
|
* @public
|
|
@@ -3815,7 +3815,7 @@ export interface GetTagsResponse {
|
|
|
3815
3815
|
* <p>Represents a collection of tags associated with the resource.</p>
|
|
3816
3816
|
* @public
|
|
3817
3817
|
*/
|
|
3818
|
-
Tags?: Record<string, string
|
|
3818
|
+
Tags?: Record<string, string> | undefined;
|
|
3819
3819
|
}
|
|
3820
3820
|
/**
|
|
3821
3821
|
* @public
|
|
@@ -3835,47 +3835,47 @@ export interface GetVpcLinkResponse {
|
|
|
3835
3835
|
* <p>The timestamp when the VPC link was created.</p>
|
|
3836
3836
|
* @public
|
|
3837
3837
|
*/
|
|
3838
|
-
CreatedDate?: Date;
|
|
3838
|
+
CreatedDate?: Date | undefined;
|
|
3839
3839
|
/**
|
|
3840
3840
|
* <p>The name of the VPC link.</p>
|
|
3841
3841
|
* @public
|
|
3842
3842
|
*/
|
|
3843
|
-
Name?: string;
|
|
3843
|
+
Name?: string | undefined;
|
|
3844
3844
|
/**
|
|
3845
3845
|
* <p>A list of security group IDs for the VPC link.</p>
|
|
3846
3846
|
* @public
|
|
3847
3847
|
*/
|
|
3848
|
-
SecurityGroupIds?: string[];
|
|
3848
|
+
SecurityGroupIds?: string[] | undefined;
|
|
3849
3849
|
/**
|
|
3850
3850
|
* <p>A list of subnet IDs to include in the VPC link.</p>
|
|
3851
3851
|
* @public
|
|
3852
3852
|
*/
|
|
3853
|
-
SubnetIds?: string[];
|
|
3853
|
+
SubnetIds?: string[] | undefined;
|
|
3854
3854
|
/**
|
|
3855
3855
|
* <p>Tags for the VPC link.</p>
|
|
3856
3856
|
* @public
|
|
3857
3857
|
*/
|
|
3858
|
-
Tags?: Record<string, string
|
|
3858
|
+
Tags?: Record<string, string> | undefined;
|
|
3859
3859
|
/**
|
|
3860
3860
|
* <p>The ID of the VPC link.</p>
|
|
3861
3861
|
* @public
|
|
3862
3862
|
*/
|
|
3863
|
-
VpcLinkId?: string;
|
|
3863
|
+
VpcLinkId?: string | undefined;
|
|
3864
3864
|
/**
|
|
3865
3865
|
* <p>The status of the VPC link.</p>
|
|
3866
3866
|
* @public
|
|
3867
3867
|
*/
|
|
3868
|
-
VpcLinkStatus?: VpcLinkStatus;
|
|
3868
|
+
VpcLinkStatus?: VpcLinkStatus | undefined;
|
|
3869
3869
|
/**
|
|
3870
3870
|
* <p>A message summarizing the cause of the status of the VPC link.</p>
|
|
3871
3871
|
* @public
|
|
3872
3872
|
*/
|
|
3873
|
-
VpcLinkStatusMessage?: string;
|
|
3873
|
+
VpcLinkStatusMessage?: string | undefined;
|
|
3874
3874
|
/**
|
|
3875
3875
|
* <p>The version of the VPC link.</p>
|
|
3876
3876
|
* @public
|
|
3877
3877
|
*/
|
|
3878
|
-
VpcLinkVersion?: VpcLinkVersion;
|
|
3878
|
+
VpcLinkVersion?: VpcLinkVersion | undefined;
|
|
3879
3879
|
}
|
|
3880
3880
|
/**
|
|
3881
3881
|
* @public
|
|
@@ -3885,12 +3885,12 @@ export interface GetVpcLinksRequest {
|
|
|
3885
3885
|
* <p>The maximum number of elements to be returned for this resource.</p>
|
|
3886
3886
|
* @public
|
|
3887
3887
|
*/
|
|
3888
|
-
MaxResults?: string;
|
|
3888
|
+
MaxResults?: string | undefined;
|
|
3889
3889
|
/**
|
|
3890
3890
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
3891
3891
|
* @public
|
|
3892
3892
|
*/
|
|
3893
|
-
NextToken?: string;
|
|
3893
|
+
NextToken?: string | undefined;
|
|
3894
3894
|
}
|
|
3895
3895
|
/**
|
|
3896
3896
|
* @public
|
|
@@ -3900,12 +3900,12 @@ export interface GetVpcLinksResponse {
|
|
|
3900
3900
|
* <p>A collection of VPC links.</p>
|
|
3901
3901
|
* @public
|
|
3902
3902
|
*/
|
|
3903
|
-
Items?: VpcLink[];
|
|
3903
|
+
Items?: VpcLink[] | undefined;
|
|
3904
3904
|
/**
|
|
3905
3905
|
* <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
|
|
3906
3906
|
* @public
|
|
3907
3907
|
*/
|
|
3908
|
-
NextToken?: string;
|
|
3908
|
+
NextToken?: string | undefined;
|
|
3909
3909
|
}
|
|
3910
3910
|
/**
|
|
3911
3911
|
* <p></p>
|
|
@@ -3916,7 +3916,7 @@ export interface ImportApiRequest {
|
|
|
3916
3916
|
* <p>Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.</p>
|
|
3917
3917
|
* @public
|
|
3918
3918
|
*/
|
|
3919
|
-
Basepath?: string;
|
|
3919
|
+
Basepath?: string | undefined;
|
|
3920
3920
|
/**
|
|
3921
3921
|
* <p>The OpenAPI definition. Supported only for HTTP APIs.</p>
|
|
3922
3922
|
* @public
|
|
@@ -3926,7 +3926,7 @@ export interface ImportApiRequest {
|
|
|
3926
3926
|
* <p>Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.</p>
|
|
3927
3927
|
* @public
|
|
3928
3928
|
*/
|
|
3929
|
-
FailOnWarnings?: boolean;
|
|
3929
|
+
FailOnWarnings?: boolean | undefined;
|
|
3930
3930
|
}
|
|
3931
3931
|
/**
|
|
3932
3932
|
* @public
|
|
@@ -3936,82 +3936,82 @@ export interface ImportApiResponse {
|
|
|
3936
3936
|
* <p>The URI of the API, of the form \{api-id\}.execute-api.\{region\}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>
|
|
3937
3937
|
* @public
|
|
3938
3938
|
*/
|
|
3939
|
-
ApiEndpoint?: string;
|
|
3939
|
+
ApiEndpoint?: string | undefined;
|
|
3940
3940
|
/**
|
|
3941
3941
|
* <p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>
|
|
3942
3942
|
* @public
|
|
3943
3943
|
*/
|
|
3944
|
-
ApiGatewayManaged?: boolean;
|
|
3944
|
+
ApiGatewayManaged?: boolean | undefined;
|
|
3945
3945
|
/**
|
|
3946
3946
|
* <p>The API ID.</p>
|
|
3947
3947
|
* @public
|
|
3948
3948
|
*/
|
|
3949
|
-
ApiId?: string;
|
|
3949
|
+
ApiId?: string | undefined;
|
|
3950
3950
|
/**
|
|
3951
3951
|
* <p>An API key selection expression. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">API Key Selection Expressions</a>.</p>
|
|
3952
3952
|
* @public
|
|
3953
3953
|
*/
|
|
3954
|
-
ApiKeySelectionExpression?: string;
|
|
3954
|
+
ApiKeySelectionExpression?: string | undefined;
|
|
3955
3955
|
/**
|
|
3956
3956
|
* <p>A CORS configuration. Supported only for HTTP APIs.</p>
|
|
3957
3957
|
* @public
|
|
3958
3958
|
*/
|
|
3959
|
-
CorsConfiguration?: Cors;
|
|
3959
|
+
CorsConfiguration?: Cors | undefined;
|
|
3960
3960
|
/**
|
|
3961
3961
|
* <p>The timestamp when the API was created.</p>
|
|
3962
3962
|
* @public
|
|
3963
3963
|
*/
|
|
3964
|
-
CreatedDate?: Date;
|
|
3964
|
+
CreatedDate?: Date | undefined;
|
|
3965
3965
|
/**
|
|
3966
3966
|
* <p>The description of the API.</p>
|
|
3967
3967
|
* @public
|
|
3968
3968
|
*/
|
|
3969
|
-
Description?: string;
|
|
3969
|
+
Description?: string | undefined;
|
|
3970
3970
|
/**
|
|
3971
3971
|
* <p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>
|
|
3972
3972
|
* @public
|
|
3973
3973
|
*/
|
|
3974
|
-
DisableSchemaValidation?: boolean;
|
|
3974
|
+
DisableSchemaValidation?: boolean | undefined;
|
|
3975
3975
|
/**
|
|
3976
3976
|
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://\{api_id\}.execute-api.\{region\}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
|
|
3977
3977
|
* @public
|
|
3978
3978
|
*/
|
|
3979
|
-
DisableExecuteApiEndpoint?: boolean;
|
|
3979
|
+
DisableExecuteApiEndpoint?: boolean | undefined;
|
|
3980
3980
|
/**
|
|
3981
3981
|
* <p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>
|
|
3982
3982
|
* @public
|
|
3983
3983
|
*/
|
|
3984
|
-
ImportInfo?: string[];
|
|
3984
|
+
ImportInfo?: string[] | undefined;
|
|
3985
3985
|
/**
|
|
3986
3986
|
* <p>The name of the API.</p>
|
|
3987
3987
|
* @public
|
|
3988
3988
|
*/
|
|
3989
|
-
Name?: string;
|
|
3989
|
+
Name?: string | undefined;
|
|
3990
3990
|
/**
|
|
3991
3991
|
* <p>The API protocol.</p>
|
|
3992
3992
|
* @public
|
|
3993
3993
|
*/
|
|
3994
|
-
ProtocolType?: ProtocolType;
|
|
3994
|
+
ProtocolType?: ProtocolType | undefined;
|
|
3995
3995
|
/**
|
|
3996
3996
|
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
3997
3997
|
* @public
|
|
3998
3998
|
*/
|
|
3999
|
-
RouteSelectionExpression?: string;
|
|
3999
|
+
RouteSelectionExpression?: string | undefined;
|
|
4000
4000
|
/**
|
|
4001
4001
|
* <p>A collection of tags associated with the API.</p>
|
|
4002
4002
|
* @public
|
|
4003
4003
|
*/
|
|
4004
|
-
Tags?: Record<string, string
|
|
4004
|
+
Tags?: Record<string, string> | undefined;
|
|
4005
4005
|
/**
|
|
4006
4006
|
* <p>A version identifier for the API.</p>
|
|
4007
4007
|
* @public
|
|
4008
4008
|
*/
|
|
4009
|
-
Version?: string;
|
|
4009
|
+
Version?: string | undefined;
|
|
4010
4010
|
/**
|
|
4011
4011
|
* <p>The warning messages reported when failonwarnings is turned on during API import.</p>
|
|
4012
4012
|
* @public
|
|
4013
4013
|
*/
|
|
4014
|
-
Warnings?: string[];
|
|
4014
|
+
Warnings?: string[] | undefined;
|
|
4015
4015
|
}
|
|
4016
4016
|
/**
|
|
4017
4017
|
* <p></p>
|
|
@@ -4027,7 +4027,7 @@ export interface ReimportApiRequest {
|
|
|
4027
4027
|
* <p>Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.</p>
|
|
4028
4028
|
* @public
|
|
4029
4029
|
*/
|
|
4030
|
-
Basepath?: string;
|
|
4030
|
+
Basepath?: string | undefined;
|
|
4031
4031
|
/**
|
|
4032
4032
|
* <p>The OpenAPI definition. Supported only for HTTP APIs.</p>
|
|
4033
4033
|
* @public
|
|
@@ -4037,7 +4037,7 @@ export interface ReimportApiRequest {
|
|
|
4037
4037
|
* <p>Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.</p>
|
|
4038
4038
|
* @public
|
|
4039
4039
|
*/
|
|
4040
|
-
FailOnWarnings?: boolean;
|
|
4040
|
+
FailOnWarnings?: boolean | undefined;
|
|
4041
4041
|
}
|
|
4042
4042
|
/**
|
|
4043
4043
|
* @public
|
|
@@ -4047,82 +4047,82 @@ export interface ReimportApiResponse {
|
|
|
4047
4047
|
* <p>The URI of the API, of the form \{api-id\}.execute-api.\{region\}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>
|
|
4048
4048
|
* @public
|
|
4049
4049
|
*/
|
|
4050
|
-
ApiEndpoint?: string;
|
|
4050
|
+
ApiEndpoint?: string | undefined;
|
|
4051
4051
|
/**
|
|
4052
4052
|
* <p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>
|
|
4053
4053
|
* @public
|
|
4054
4054
|
*/
|
|
4055
|
-
ApiGatewayManaged?: boolean;
|
|
4055
|
+
ApiGatewayManaged?: boolean | undefined;
|
|
4056
4056
|
/**
|
|
4057
4057
|
* <p>The API ID.</p>
|
|
4058
4058
|
* @public
|
|
4059
4059
|
*/
|
|
4060
|
-
ApiId?: string;
|
|
4060
|
+
ApiId?: string | undefined;
|
|
4061
4061
|
/**
|
|
4062
4062
|
* <p>An API key selection expression. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">API Key Selection Expressions</a>.</p>
|
|
4063
4063
|
* @public
|
|
4064
4064
|
*/
|
|
4065
|
-
ApiKeySelectionExpression?: string;
|
|
4065
|
+
ApiKeySelectionExpression?: string | undefined;
|
|
4066
4066
|
/**
|
|
4067
4067
|
* <p>A CORS configuration. Supported only for HTTP APIs.</p>
|
|
4068
4068
|
* @public
|
|
4069
4069
|
*/
|
|
4070
|
-
CorsConfiguration?: Cors;
|
|
4070
|
+
CorsConfiguration?: Cors | undefined;
|
|
4071
4071
|
/**
|
|
4072
4072
|
* <p>The timestamp when the API was created.</p>
|
|
4073
4073
|
* @public
|
|
4074
4074
|
*/
|
|
4075
|
-
CreatedDate?: Date;
|
|
4075
|
+
CreatedDate?: Date | undefined;
|
|
4076
4076
|
/**
|
|
4077
4077
|
* <p>The description of the API.</p>
|
|
4078
4078
|
* @public
|
|
4079
4079
|
*/
|
|
4080
|
-
Description?: string;
|
|
4080
|
+
Description?: string | undefined;
|
|
4081
4081
|
/**
|
|
4082
4082
|
* <p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>
|
|
4083
4083
|
* @public
|
|
4084
4084
|
*/
|
|
4085
|
-
DisableSchemaValidation?: boolean;
|
|
4085
|
+
DisableSchemaValidation?: boolean | undefined;
|
|
4086
4086
|
/**
|
|
4087
4087
|
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://\{api_id\}.execute-api.\{region\}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
|
|
4088
4088
|
* @public
|
|
4089
4089
|
*/
|
|
4090
|
-
DisableExecuteApiEndpoint?: boolean;
|
|
4090
|
+
DisableExecuteApiEndpoint?: boolean | undefined;
|
|
4091
4091
|
/**
|
|
4092
4092
|
* <p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>
|
|
4093
4093
|
* @public
|
|
4094
4094
|
*/
|
|
4095
|
-
ImportInfo?: string[];
|
|
4095
|
+
ImportInfo?: string[] | undefined;
|
|
4096
4096
|
/**
|
|
4097
4097
|
* <p>The name of the API.</p>
|
|
4098
4098
|
* @public
|
|
4099
4099
|
*/
|
|
4100
|
-
Name?: string;
|
|
4100
|
+
Name?: string | undefined;
|
|
4101
4101
|
/**
|
|
4102
4102
|
* <p>The API protocol.</p>
|
|
4103
4103
|
* @public
|
|
4104
4104
|
*/
|
|
4105
|
-
ProtocolType?: ProtocolType;
|
|
4105
|
+
ProtocolType?: ProtocolType | undefined;
|
|
4106
4106
|
/**
|
|
4107
4107
|
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
4108
4108
|
* @public
|
|
4109
4109
|
*/
|
|
4110
|
-
RouteSelectionExpression?: string;
|
|
4110
|
+
RouteSelectionExpression?: string | undefined;
|
|
4111
4111
|
/**
|
|
4112
4112
|
* <p>A collection of tags associated with the API.</p>
|
|
4113
4113
|
* @public
|
|
4114
4114
|
*/
|
|
4115
|
-
Tags?: Record<string, string
|
|
4115
|
+
Tags?: Record<string, string> | undefined;
|
|
4116
4116
|
/**
|
|
4117
4117
|
* <p>A version identifier for the API.</p>
|
|
4118
4118
|
* @public
|
|
4119
4119
|
*/
|
|
4120
|
-
Version?: string;
|
|
4120
|
+
Version?: string | undefined;
|
|
4121
4121
|
/**
|
|
4122
4122
|
* <p>The warning messages reported when failonwarnings is turned on during API import.</p>
|
|
4123
4123
|
* @public
|
|
4124
4124
|
*/
|
|
4125
|
-
Warnings?: string[];
|
|
4125
|
+
Warnings?: string[] | undefined;
|
|
4126
4126
|
}
|
|
4127
4127
|
/**
|
|
4128
4128
|
* @public
|
|
@@ -4153,7 +4153,7 @@ export interface TagResourceRequest {
|
|
|
4153
4153
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
4154
4154
|
* @public
|
|
4155
4155
|
*/
|
|
4156
|
-
Tags?: Record<string, string
|
|
4156
|
+
Tags?: Record<string, string> | undefined;
|
|
4157
4157
|
}
|
|
4158
4158
|
/**
|
|
4159
4159
|
* @public
|
|
@@ -4189,57 +4189,57 @@ export interface UpdateApiRequest {
|
|
|
4189
4189
|
* <p>An API key selection expression. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">API Key Selection Expressions</a>.</p>
|
|
4190
4190
|
* @public
|
|
4191
4191
|
*/
|
|
4192
|
-
ApiKeySelectionExpression?: string;
|
|
4192
|
+
ApiKeySelectionExpression?: string | undefined;
|
|
4193
4193
|
/**
|
|
4194
4194
|
* <p>A CORS configuration. Supported only for HTTP APIs.</p>
|
|
4195
4195
|
* @public
|
|
4196
4196
|
*/
|
|
4197
|
-
CorsConfiguration?: Cors;
|
|
4197
|
+
CorsConfiguration?: Cors | undefined;
|
|
4198
4198
|
/**
|
|
4199
4199
|
* <p>This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, 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 arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.</p>
|
|
4200
4200
|
* @public
|
|
4201
4201
|
*/
|
|
4202
|
-
CredentialsArn?: string;
|
|
4202
|
+
CredentialsArn?: string | undefined;
|
|
4203
4203
|
/**
|
|
4204
4204
|
* <p>The description of the API.</p>
|
|
4205
4205
|
* @public
|
|
4206
4206
|
*/
|
|
4207
|
-
Description?: string;
|
|
4207
|
+
Description?: string | undefined;
|
|
4208
4208
|
/**
|
|
4209
4209
|
* <p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>
|
|
4210
4210
|
* @public
|
|
4211
4211
|
*/
|
|
4212
|
-
DisableSchemaValidation?: boolean;
|
|
4212
|
+
DisableSchemaValidation?: boolean | undefined;
|
|
4213
4213
|
/**
|
|
4214
4214
|
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://\{api_id\}.execute-api.\{region\}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
|
|
4215
4215
|
* @public
|
|
4216
4216
|
*/
|
|
4217
|
-
DisableExecuteApiEndpoint?: boolean;
|
|
4217
|
+
DisableExecuteApiEndpoint?: boolean | undefined;
|
|
4218
4218
|
/**
|
|
4219
4219
|
* <p>The name of the API.</p>
|
|
4220
4220
|
* @public
|
|
4221
4221
|
*/
|
|
4222
|
-
Name?: string;
|
|
4222
|
+
Name?: string | undefined;
|
|
4223
4223
|
/**
|
|
4224
4224
|
* <p>This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.</p>
|
|
4225
4225
|
* @public
|
|
4226
4226
|
*/
|
|
4227
|
-
RouteKey?: string;
|
|
4227
|
+
RouteKey?: string | undefined;
|
|
4228
4228
|
/**
|
|
4229
4229
|
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
4230
4230
|
* @public
|
|
4231
4231
|
*/
|
|
4232
|
-
RouteSelectionExpression?: string;
|
|
4232
|
+
RouteSelectionExpression?: string | undefined;
|
|
4233
4233
|
/**
|
|
4234
4234
|
* <p>This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.</p>
|
|
4235
4235
|
* @public
|
|
4236
4236
|
*/
|
|
4237
|
-
Target?: string;
|
|
4237
|
+
Target?: string | undefined;
|
|
4238
4238
|
/**
|
|
4239
4239
|
* <p>A version identifier for the API.</p>
|
|
4240
4240
|
* @public
|
|
4241
4241
|
*/
|
|
4242
|
-
Version?: string;
|
|
4242
|
+
Version?: string | undefined;
|
|
4243
4243
|
}
|
|
4244
4244
|
/**
|
|
4245
4245
|
* @public
|
|
@@ -4249,82 +4249,82 @@ export interface UpdateApiResponse {
|
|
|
4249
4249
|
* <p>The URI of the API, of the form \{api-id\}.execute-api.\{region\}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>
|
|
4250
4250
|
* @public
|
|
4251
4251
|
*/
|
|
4252
|
-
ApiEndpoint?: string;
|
|
4252
|
+
ApiEndpoint?: string | undefined;
|
|
4253
4253
|
/**
|
|
4254
4254
|
* <p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>
|
|
4255
4255
|
* @public
|
|
4256
4256
|
*/
|
|
4257
|
-
ApiGatewayManaged?: boolean;
|
|
4257
|
+
ApiGatewayManaged?: boolean | undefined;
|
|
4258
4258
|
/**
|
|
4259
4259
|
* <p>The API ID.</p>
|
|
4260
4260
|
* @public
|
|
4261
4261
|
*/
|
|
4262
|
-
ApiId?: string;
|
|
4262
|
+
ApiId?: string | undefined;
|
|
4263
4263
|
/**
|
|
4264
4264
|
* <p>An API key selection expression. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">API Key Selection Expressions</a>.</p>
|
|
4265
4265
|
* @public
|
|
4266
4266
|
*/
|
|
4267
|
-
ApiKeySelectionExpression?: string;
|
|
4267
|
+
ApiKeySelectionExpression?: string | undefined;
|
|
4268
4268
|
/**
|
|
4269
4269
|
* <p>A CORS configuration. Supported only for HTTP APIs.</p>
|
|
4270
4270
|
* @public
|
|
4271
4271
|
*/
|
|
4272
|
-
CorsConfiguration?: Cors;
|
|
4272
|
+
CorsConfiguration?: Cors | undefined;
|
|
4273
4273
|
/**
|
|
4274
4274
|
* <p>The timestamp when the API was created.</p>
|
|
4275
4275
|
* @public
|
|
4276
4276
|
*/
|
|
4277
|
-
CreatedDate?: Date;
|
|
4277
|
+
CreatedDate?: Date | undefined;
|
|
4278
4278
|
/**
|
|
4279
4279
|
* <p>The description of the API.</p>
|
|
4280
4280
|
* @public
|
|
4281
4281
|
*/
|
|
4282
|
-
Description?: string;
|
|
4282
|
+
Description?: string | undefined;
|
|
4283
4283
|
/**
|
|
4284
4284
|
* <p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>
|
|
4285
4285
|
* @public
|
|
4286
4286
|
*/
|
|
4287
|
-
DisableSchemaValidation?: boolean;
|
|
4287
|
+
DisableSchemaValidation?: boolean | undefined;
|
|
4288
4288
|
/**
|
|
4289
4289
|
* <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://\{api_id\}.execute-api.\{region\}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
|
|
4290
4290
|
* @public
|
|
4291
4291
|
*/
|
|
4292
|
-
DisableExecuteApiEndpoint?: boolean;
|
|
4292
|
+
DisableExecuteApiEndpoint?: boolean | undefined;
|
|
4293
4293
|
/**
|
|
4294
4294
|
* <p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>
|
|
4295
4295
|
* @public
|
|
4296
4296
|
*/
|
|
4297
|
-
ImportInfo?: string[];
|
|
4297
|
+
ImportInfo?: string[] | undefined;
|
|
4298
4298
|
/**
|
|
4299
4299
|
* <p>The name of the API.</p>
|
|
4300
4300
|
* @public
|
|
4301
4301
|
*/
|
|
4302
|
-
Name?: string;
|
|
4302
|
+
Name?: string | undefined;
|
|
4303
4303
|
/**
|
|
4304
4304
|
* <p>The API protocol.</p>
|
|
4305
4305
|
* @public
|
|
4306
4306
|
*/
|
|
4307
|
-
ProtocolType?: ProtocolType;
|
|
4307
|
+
ProtocolType?: ProtocolType | undefined;
|
|
4308
4308
|
/**
|
|
4309
4309
|
* <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be $\{request.method\} $\{request.path\}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
|
|
4310
4310
|
* @public
|
|
4311
4311
|
*/
|
|
4312
|
-
RouteSelectionExpression?: string;
|
|
4312
|
+
RouteSelectionExpression?: string | undefined;
|
|
4313
4313
|
/**
|
|
4314
4314
|
* <p>A collection of tags associated with the API.</p>
|
|
4315
4315
|
* @public
|
|
4316
4316
|
*/
|
|
4317
|
-
Tags?: Record<string, string
|
|
4317
|
+
Tags?: Record<string, string> | undefined;
|
|
4318
4318
|
/**
|
|
4319
4319
|
* <p>A version identifier for the API.</p>
|
|
4320
4320
|
* @public
|
|
4321
4321
|
*/
|
|
4322
|
-
Version?: string;
|
|
4322
|
+
Version?: string | undefined;
|
|
4323
4323
|
/**
|
|
4324
4324
|
* <p>The warning messages reported when failonwarnings is turned on during API import.</p>
|
|
4325
4325
|
* @public
|
|
4326
4326
|
*/
|
|
4327
|
-
Warnings?: string[];
|
|
4327
|
+
Warnings?: string[] | undefined;
|
|
4328
4328
|
}
|
|
4329
4329
|
/**
|
|
4330
4330
|
* <p>Updates an ApiMapping.</p>
|
|
@@ -4345,7 +4345,7 @@ export interface UpdateApiMappingRequest {
|
|
|
4345
4345
|
* <p>The API mapping key.</p>
|
|
4346
4346
|
* @public
|
|
4347
4347
|
*/
|
|
4348
|
-
ApiMappingKey?: string;
|
|
4348
|
+
ApiMappingKey?: string | undefined;
|
|
4349
4349
|
/**
|
|
4350
4350
|
* <p>The domain name.</p>
|
|
4351
4351
|
* @public
|
|
@@ -4355,7 +4355,7 @@ export interface UpdateApiMappingRequest {
|
|
|
4355
4355
|
* <p>The API stage.</p>
|
|
4356
4356
|
* @public
|
|
4357
4357
|
*/
|
|
4358
|
-
Stage?: string;
|
|
4358
|
+
Stage?: string | undefined;
|
|
4359
4359
|
}
|
|
4360
4360
|
/**
|
|
4361
4361
|
* @public
|
|
@@ -4365,22 +4365,22 @@ export interface UpdateApiMappingResponse {
|
|
|
4365
4365
|
* <p>The API identifier.</p>
|
|
4366
4366
|
* @public
|
|
4367
4367
|
*/
|
|
4368
|
-
ApiId?: string;
|
|
4368
|
+
ApiId?: string | undefined;
|
|
4369
4369
|
/**
|
|
4370
4370
|
* <p>The API mapping identifier.</p>
|
|
4371
4371
|
* @public
|
|
4372
4372
|
*/
|
|
4373
|
-
ApiMappingId?: string;
|
|
4373
|
+
ApiMappingId?: string | undefined;
|
|
4374
4374
|
/**
|
|
4375
4375
|
* <p>The API mapping key.</p>
|
|
4376
4376
|
* @public
|
|
4377
4377
|
*/
|
|
4378
|
-
ApiMappingKey?: string;
|
|
4378
|
+
ApiMappingKey?: string | undefined;
|
|
4379
4379
|
/**
|
|
4380
4380
|
* <p>The API stage.</p>
|
|
4381
4381
|
* @public
|
|
4382
4382
|
*/
|
|
4383
|
-
Stage?: string;
|
|
4383
|
+
Stage?: string | undefined;
|
|
4384
4384
|
}
|
|
4385
4385
|
/**
|
|
4386
4386
|
* <p>Updates an Authorizer.</p>
|
|
@@ -4396,7 +4396,7 @@ export interface UpdateAuthorizerRequest {
|
|
|
4396
4396
|
* <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, don't specify this parameter.</p>
|
|
4397
4397
|
* @public
|
|
4398
4398
|
*/
|
|
4399
|
-
AuthorizerCredentialsArn?: string;
|
|
4399
|
+
AuthorizerCredentialsArn?: string | undefined;
|
|
4400
4400
|
/**
|
|
4401
4401
|
* <p>The authorizer identifier.</p>
|
|
4402
4402
|
* @public
|
|
@@ -4406,48 +4406,48 @@ export interface UpdateAuthorizerRequest {
|
|
|
4406
4406
|
* <p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>
|
|
4407
4407
|
* @public
|
|
4408
4408
|
*/
|
|
4409
|
-
AuthorizerPayloadFormatVersion?: string;
|
|
4409
|
+
AuthorizerPayloadFormatVersion?: string | undefined;
|
|
4410
4410
|
/**
|
|
4411
4411
|
* <p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>
|
|
4412
4412
|
* @public
|
|
4413
4413
|
*/
|
|
4414
|
-
AuthorizerResultTtlInSeconds?: number;
|
|
4414
|
+
AuthorizerResultTtlInSeconds?: number | undefined;
|
|
4415
4415
|
/**
|
|
4416
4416
|
* <p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>
|
|
4417
4417
|
* @public
|
|
4418
4418
|
*/
|
|
4419
|
-
AuthorizerType?: AuthorizerType;
|
|
4419
|
+
AuthorizerType?: AuthorizerType | undefined;
|
|
4420
4420
|
/**
|
|
4421
4421
|
* <p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>\{account_id\}</replaceable>:function:<replaceable>\{lambda_function_name\}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>\{region\}</replaceable>:lambda:path/<replaceable>\{service_api\}</replaceable>
|
|
4422
4422
|
* , where <replaceable></replaceable>\{region\} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>
|
|
4423
4423
|
* @public
|
|
4424
4424
|
*/
|
|
4425
|
-
AuthorizerUri?: string;
|
|
4425
|
+
AuthorizerUri?: string | undefined;
|
|
4426
4426
|
/**
|
|
4427
4427
|
* <p>Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a></p>
|
|
4428
4428
|
* @public
|
|
4429
4429
|
*/
|
|
4430
|
-
EnableSimpleResponses?: boolean;
|
|
4430
|
+
EnableSimpleResponses?: boolean | undefined;
|
|
4431
4431
|
/**
|
|
4432
4432
|
* <p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>
|
|
4433
4433
|
* @public
|
|
4434
4434
|
*/
|
|
4435
|
-
IdentitySource?: string[];
|
|
4435
|
+
IdentitySource?: string[] | undefined;
|
|
4436
4436
|
/**
|
|
4437
4437
|
* <p>This parameter is not used.</p>
|
|
4438
4438
|
* @public
|
|
4439
4439
|
*/
|
|
4440
|
-
IdentityValidationExpression?: string;
|
|
4440
|
+
IdentityValidationExpression?: string | undefined;
|
|
4441
4441
|
/**
|
|
4442
4442
|
* <p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>
|
|
4443
4443
|
* @public
|
|
4444
4444
|
*/
|
|
4445
|
-
JwtConfiguration?: JWTConfiguration;
|
|
4445
|
+
JwtConfiguration?: JWTConfiguration | undefined;
|
|
4446
4446
|
/**
|
|
4447
4447
|
* <p>The name of the authorizer.</p>
|
|
4448
4448
|
* @public
|
|
4449
4449
|
*/
|
|
4450
|
-
Name?: string;
|
|
4450
|
+
Name?: string | undefined;
|
|
4451
4451
|
}
|
|
4452
4452
|
/**
|
|
4453
4453
|
* @public
|
|
@@ -4457,58 +4457,58 @@ export interface UpdateAuthorizerResponse {
|
|
|
4457
4457
|
* <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, don't specify this parameter. Supported only for REQUEST authorizers.</p>
|
|
4458
4458
|
* @public
|
|
4459
4459
|
*/
|
|
4460
|
-
AuthorizerCredentialsArn?: string;
|
|
4460
|
+
AuthorizerCredentialsArn?: string | undefined;
|
|
4461
4461
|
/**
|
|
4462
4462
|
* <p>The authorizer identifier.</p>
|
|
4463
4463
|
* @public
|
|
4464
4464
|
*/
|
|
4465
|
-
AuthorizerId?: string;
|
|
4465
|
+
AuthorizerId?: string | undefined;
|
|
4466
4466
|
/**
|
|
4467
4467
|
* <p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>
|
|
4468
4468
|
* @public
|
|
4469
4469
|
*/
|
|
4470
|
-
AuthorizerPayloadFormatVersion?: string;
|
|
4470
|
+
AuthorizerPayloadFormatVersion?: string | undefined;
|
|
4471
4471
|
/**
|
|
4472
4472
|
* <p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>
|
|
4473
4473
|
* @public
|
|
4474
4474
|
*/
|
|
4475
|
-
AuthorizerResultTtlInSeconds?: number;
|
|
4475
|
+
AuthorizerResultTtlInSeconds?: number | undefined;
|
|
4476
4476
|
/**
|
|
4477
4477
|
* <p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>
|
|
4478
4478
|
* @public
|
|
4479
4479
|
*/
|
|
4480
|
-
AuthorizerType?: AuthorizerType;
|
|
4480
|
+
AuthorizerType?: AuthorizerType | undefined;
|
|
4481
4481
|
/**
|
|
4482
4482
|
* <p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>\{account_id\}</replaceable>:function:<replaceable>\{lambda_function_name\}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>\{region\}</replaceable>:lambda:path/<replaceable>\{service_api\}</replaceable>
|
|
4483
4483
|
* , where <replaceable></replaceable>\{region\} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>
|
|
4484
4484
|
* @public
|
|
4485
4485
|
*/
|
|
4486
|
-
AuthorizerUri?: string;
|
|
4486
|
+
AuthorizerUri?: string | undefined;
|
|
4487
4487
|
/**
|
|
4488
4488
|
* <p>Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a></p>
|
|
4489
4489
|
* @public
|
|
4490
4490
|
*/
|
|
4491
|
-
EnableSimpleResponses?: boolean;
|
|
4491
|
+
EnableSimpleResponses?: boolean | undefined;
|
|
4492
4492
|
/**
|
|
4493
4493
|
* <p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>
|
|
4494
4494
|
* @public
|
|
4495
4495
|
*/
|
|
4496
|
-
IdentitySource?: string[];
|
|
4496
|
+
IdentitySource?: string[] | undefined;
|
|
4497
4497
|
/**
|
|
4498
4498
|
* <p>The validation expression does not apply to the REQUEST authorizer.</p>
|
|
4499
4499
|
* @public
|
|
4500
4500
|
*/
|
|
4501
|
-
IdentityValidationExpression?: string;
|
|
4501
|
+
IdentityValidationExpression?: string | undefined;
|
|
4502
4502
|
/**
|
|
4503
4503
|
* <p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>
|
|
4504
4504
|
* @public
|
|
4505
4505
|
*/
|
|
4506
|
-
JwtConfiguration?: JWTConfiguration;
|
|
4506
|
+
JwtConfiguration?: JWTConfiguration | undefined;
|
|
4507
4507
|
/**
|
|
4508
4508
|
* <p>The name of the authorizer.</p>
|
|
4509
4509
|
* @public
|
|
4510
4510
|
*/
|
|
4511
|
-
Name?: string;
|
|
4511
|
+
Name?: string | undefined;
|
|
4512
4512
|
}
|
|
4513
4513
|
/**
|
|
4514
4514
|
* <p>Updates a Deployment.</p>
|
|
@@ -4529,7 +4529,7 @@ export interface UpdateDeploymentRequest {
|
|
|
4529
4529
|
* <p>The description for the deployment resource.</p>
|
|
4530
4530
|
* @public
|
|
4531
4531
|
*/
|
|
4532
|
-
Description?: string;
|
|
4532
|
+
Description?: string | undefined;
|
|
4533
4533
|
}
|
|
4534
4534
|
/**
|
|
4535
4535
|
* @public
|
|
@@ -4539,32 +4539,32 @@ export interface UpdateDeploymentResponse {
|
|
|
4539
4539
|
* <p>Specifies whether a deployment was automatically released.</p>
|
|
4540
4540
|
* @public
|
|
4541
4541
|
*/
|
|
4542
|
-
AutoDeployed?: boolean;
|
|
4542
|
+
AutoDeployed?: boolean | undefined;
|
|
4543
4543
|
/**
|
|
4544
4544
|
* <p>The date and time when the Deployment resource was created.</p>
|
|
4545
4545
|
* @public
|
|
4546
4546
|
*/
|
|
4547
|
-
CreatedDate?: Date;
|
|
4547
|
+
CreatedDate?: Date | undefined;
|
|
4548
4548
|
/**
|
|
4549
4549
|
* <p>The identifier for the deployment.</p>
|
|
4550
4550
|
* @public
|
|
4551
4551
|
*/
|
|
4552
|
-
DeploymentId?: string;
|
|
4552
|
+
DeploymentId?: string | undefined;
|
|
4553
4553
|
/**
|
|
4554
4554
|
* <p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>
|
|
4555
4555
|
* @public
|
|
4556
4556
|
*/
|
|
4557
|
-
DeploymentStatus?: DeploymentStatus;
|
|
4557
|
+
DeploymentStatus?: DeploymentStatus | undefined;
|
|
4558
4558
|
/**
|
|
4559
4559
|
* <p>May contain additional feedback on the status of an API deployment.</p>
|
|
4560
4560
|
* @public
|
|
4561
4561
|
*/
|
|
4562
|
-
DeploymentStatusMessage?: string;
|
|
4562
|
+
DeploymentStatusMessage?: string | undefined;
|
|
4563
4563
|
/**
|
|
4564
4564
|
* <p>The description for the deployment.</p>
|
|
4565
4565
|
* @public
|
|
4566
4566
|
*/
|
|
4567
|
-
Description?: string;
|
|
4567
|
+
Description?: string | undefined;
|
|
4568
4568
|
}
|
|
4569
4569
|
/**
|
|
4570
4570
|
* <p>Updates a DomainName.</p>
|
|
@@ -4580,12 +4580,12 @@ export interface UpdateDomainNameRequest {
|
|
|
4580
4580
|
* <p>The domain name configurations.</p>
|
|
4581
4581
|
* @public
|
|
4582
4582
|
*/
|
|
4583
|
-
DomainNameConfigurations?: DomainNameConfiguration[];
|
|
4583
|
+
DomainNameConfigurations?: DomainNameConfiguration[] | undefined;
|
|
4584
4584
|
/**
|
|
4585
4585
|
* <p>The mutual TLS authentication configuration for a custom domain name.</p>
|
|
4586
4586
|
* @public
|
|
4587
4587
|
*/
|
|
4588
|
-
MutualTlsAuthentication?: MutualTlsAuthenticationInput;
|
|
4588
|
+
MutualTlsAuthentication?: MutualTlsAuthenticationInput | undefined;
|
|
4589
4589
|
}
|
|
4590
4590
|
/**
|
|
4591
4591
|
* @public
|
|
@@ -4595,27 +4595,27 @@ export interface UpdateDomainNameResponse {
|
|
|
4595
4595
|
* <p>The API mapping selection expression.</p>
|
|
4596
4596
|
* @public
|
|
4597
4597
|
*/
|
|
4598
|
-
ApiMappingSelectionExpression?: string;
|
|
4598
|
+
ApiMappingSelectionExpression?: string | undefined;
|
|
4599
4599
|
/**
|
|
4600
4600
|
* <p>The name of the DomainName resource.</p>
|
|
4601
4601
|
* @public
|
|
4602
4602
|
*/
|
|
4603
|
-
DomainName?: string;
|
|
4603
|
+
DomainName?: string | undefined;
|
|
4604
4604
|
/**
|
|
4605
4605
|
* <p>The domain name configurations.</p>
|
|
4606
4606
|
* @public
|
|
4607
4607
|
*/
|
|
4608
|
-
DomainNameConfigurations?: DomainNameConfiguration[];
|
|
4608
|
+
DomainNameConfigurations?: DomainNameConfiguration[] | undefined;
|
|
4609
4609
|
/**
|
|
4610
4610
|
* <p>The mutual TLS authentication configuration for a custom domain name.</p>
|
|
4611
4611
|
* @public
|
|
4612
4612
|
*/
|
|
4613
|
-
MutualTlsAuthentication?: MutualTlsAuthentication;
|
|
4613
|
+
MutualTlsAuthentication?: MutualTlsAuthentication | undefined;
|
|
4614
4614
|
/**
|
|
4615
4615
|
* <p>The collection of tags associated with a domain name.</p>
|
|
4616
4616
|
* @public
|
|
4617
4617
|
*/
|
|
4618
|
-
Tags?: Record<string, string
|
|
4618
|
+
Tags?: Record<string, string> | undefined;
|
|
4619
4619
|
}
|
|
4620
4620
|
/**
|
|
4621
4621
|
* <p>Updates an Integration.</p>
|
|
@@ -4631,27 +4631,27 @@ export interface UpdateIntegrationRequest {
|
|
|
4631
4631
|
* <p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>
|
|
4632
4632
|
* @public
|
|
4633
4633
|
*/
|
|
4634
|
-
ConnectionId?: string;
|
|
4634
|
+
ConnectionId?: string | undefined;
|
|
4635
4635
|
/**
|
|
4636
4636
|
* <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
|
|
4637
4637
|
* @public
|
|
4638
4638
|
*/
|
|
4639
|
-
ConnectionType?: ConnectionType;
|
|
4639
|
+
ConnectionType?: ConnectionType | undefined;
|
|
4640
4640
|
/**
|
|
4641
4641
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
4642
4642
|
* @public
|
|
4643
4643
|
*/
|
|
4644
|
-
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
4644
|
+
ContentHandlingStrategy?: ContentHandlingStrategy | undefined;
|
|
4645
4645
|
/**
|
|
4646
4646
|
* <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 arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>
|
|
4647
4647
|
* @public
|
|
4648
4648
|
*/
|
|
4649
|
-
CredentialsArn?: string;
|
|
4649
|
+
CredentialsArn?: string | undefined;
|
|
4650
4650
|
/**
|
|
4651
4651
|
* <p>The description of the integration</p>
|
|
4652
4652
|
* @public
|
|
4653
4653
|
*/
|
|
4654
|
-
Description?: string;
|
|
4654
|
+
Description?: string | undefined;
|
|
4655
4655
|
/**
|
|
4656
4656
|
* <p>The integration ID.</p>
|
|
4657
4657
|
* @public
|
|
@@ -4661,32 +4661,32 @@ export interface UpdateIntegrationRequest {
|
|
|
4661
4661
|
* <p>Specifies the integration's HTTP method type.</p>
|
|
4662
4662
|
* @public
|
|
4663
4663
|
*/
|
|
4664
|
-
IntegrationMethod?: string;
|
|
4664
|
+
IntegrationMethod?: string | undefined;
|
|
4665
4665
|
/**
|
|
4666
4666
|
* <p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html">Integration subtype reference</a>.</p>
|
|
4667
4667
|
* @public
|
|
4668
4668
|
*/
|
|
4669
|
-
IntegrationSubtype?: string;
|
|
4669
|
+
IntegrationSubtype?: string | undefined;
|
|
4670
4670
|
/**
|
|
4671
4671
|
* <p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
|
|
4672
4672
|
* @public
|
|
4673
4673
|
*/
|
|
4674
|
-
IntegrationType?: IntegrationType;
|
|
4674
|
+
IntegrationType?: IntegrationType | undefined;
|
|
4675
4675
|
/**
|
|
4676
4676
|
* <p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
|
|
4677
4677
|
* @public
|
|
4678
4678
|
*/
|
|
4679
|
-
IntegrationUri?: string;
|
|
4679
|
+
IntegrationUri?: string | undefined;
|
|
4680
4680
|
/**
|
|
4681
4681
|
* <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 requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>
|
|
4682
4682
|
* @public
|
|
4683
4683
|
*/
|
|
4684
|
-
PassthroughBehavior?: PassthroughBehavior;
|
|
4684
|
+
PassthroughBehavior?: PassthroughBehavior | undefined;
|
|
4685
4685
|
/**
|
|
4686
4686
|
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
|
|
4687
4687
|
* @public
|
|
4688
4688
|
*/
|
|
4689
|
-
PayloadFormatVersion?: string;
|
|
4689
|
+
PayloadFormatVersion?: string | undefined;
|
|
4690
4690
|
/**
|
|
4691
4691
|
* <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>\{location\}</replaceable>.<replaceable>\{name\}</replaceable>
|
|
4692
4692
|
* , where
|
|
@@ -4696,32 +4696,32 @@ export interface UpdateIntegrationRequest {
|
|
|
4696
4696
|
* must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
|
|
4697
4697
|
* @public
|
|
4698
4698
|
*/
|
|
4699
|
-
RequestParameters?: Record<string, string
|
|
4699
|
+
RequestParameters?: Record<string, string> | undefined;
|
|
4700
4700
|
/**
|
|
4701
4701
|
* <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. Supported only for WebSocket APIs.</p>
|
|
4702
4702
|
* @public
|
|
4703
4703
|
*/
|
|
4704
|
-
RequestTemplates?: Record<string, string
|
|
4704
|
+
RequestTemplates?: Record<string, string> | undefined;
|
|
4705
4705
|
/**
|
|
4706
4706
|
* <p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
|
|
4707
4707
|
* @public
|
|
4708
4708
|
*/
|
|
4709
|
-
ResponseParameters?: Record<string, Record<string, string
|
|
4709
|
+
ResponseParameters?: Record<string, Record<string, string>> | undefined;
|
|
4710
4710
|
/**
|
|
4711
4711
|
* <p>The template selection expression for the integration.</p>
|
|
4712
4712
|
* @public
|
|
4713
4713
|
*/
|
|
4714
|
-
TemplateSelectionExpression?: string;
|
|
4714
|
+
TemplateSelectionExpression?: string | undefined;
|
|
4715
4715
|
/**
|
|
4716
4716
|
* <p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>
|
|
4717
4717
|
* @public
|
|
4718
4718
|
*/
|
|
4719
|
-
TimeoutInMillis?: number;
|
|
4719
|
+
TimeoutInMillis?: number | undefined;
|
|
4720
4720
|
/**
|
|
4721
4721
|
* <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
|
|
4722
4722
|
* @public
|
|
4723
4723
|
*/
|
|
4724
|
-
TlsConfig?: TlsConfigInput;
|
|
4724
|
+
TlsConfig?: TlsConfigInput | undefined;
|
|
4725
4725
|
}
|
|
4726
4726
|
/**
|
|
4727
4727
|
* @public
|
|
@@ -4731,72 +4731,72 @@ export interface UpdateIntegrationResult {
|
|
|
4731
4731
|
* <p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>
|
|
4732
4732
|
* @public
|
|
4733
4733
|
*/
|
|
4734
|
-
ApiGatewayManaged?: boolean;
|
|
4734
|
+
ApiGatewayManaged?: boolean | undefined;
|
|
4735
4735
|
/**
|
|
4736
4736
|
* <p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>
|
|
4737
4737
|
* @public
|
|
4738
4738
|
*/
|
|
4739
|
-
ConnectionId?: string;
|
|
4739
|
+
ConnectionId?: string | undefined;
|
|
4740
4740
|
/**
|
|
4741
4741
|
* <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
|
|
4742
4742
|
* @public
|
|
4743
4743
|
*/
|
|
4744
|
-
ConnectionType?: ConnectionType;
|
|
4744
|
+
ConnectionType?: ConnectionType | undefined;
|
|
4745
4745
|
/**
|
|
4746
4746
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
4747
4747
|
* @public
|
|
4748
4748
|
*/
|
|
4749
|
-
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
4749
|
+
ContentHandlingStrategy?: ContentHandlingStrategy | undefined;
|
|
4750
4750
|
/**
|
|
4751
4751
|
* <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 arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>
|
|
4752
4752
|
* @public
|
|
4753
4753
|
*/
|
|
4754
|
-
CredentialsArn?: string;
|
|
4754
|
+
CredentialsArn?: string | undefined;
|
|
4755
4755
|
/**
|
|
4756
4756
|
* <p>Represents the description of an integration.</p>
|
|
4757
4757
|
* @public
|
|
4758
4758
|
*/
|
|
4759
|
-
Description?: string;
|
|
4759
|
+
Description?: string | undefined;
|
|
4760
4760
|
/**
|
|
4761
4761
|
* <p>Represents the identifier of an integration.</p>
|
|
4762
4762
|
* @public
|
|
4763
4763
|
*/
|
|
4764
|
-
IntegrationId?: string;
|
|
4764
|
+
IntegrationId?: string | undefined;
|
|
4765
4765
|
/**
|
|
4766
4766
|
* <p>Specifies the integration's HTTP method type.</p>
|
|
4767
4767
|
* @public
|
|
4768
4768
|
*/
|
|
4769
|
-
IntegrationMethod?: string;
|
|
4769
|
+
IntegrationMethod?: string | undefined;
|
|
4770
4770
|
/**
|
|
4771
4771
|
* <p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions">Integration Response Selection Expressions</a>.</p>
|
|
4772
4772
|
* @public
|
|
4773
4773
|
*/
|
|
4774
|
-
IntegrationResponseSelectionExpression?: string;
|
|
4774
|
+
IntegrationResponseSelectionExpression?: string | undefined;
|
|
4775
4775
|
/**
|
|
4776
4776
|
* <p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html">Integration subtype reference</a>.</p>
|
|
4777
4777
|
* @public
|
|
4778
4778
|
*/
|
|
4779
|
-
IntegrationSubtype?: string;
|
|
4779
|
+
IntegrationSubtype?: string | undefined;
|
|
4780
4780
|
/**
|
|
4781
4781
|
* <p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
|
|
4782
4782
|
* @public
|
|
4783
4783
|
*/
|
|
4784
|
-
IntegrationType?: IntegrationType;
|
|
4784
|
+
IntegrationType?: IntegrationType | undefined;
|
|
4785
4785
|
/**
|
|
4786
4786
|
* <p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
|
|
4787
4787
|
* @public
|
|
4788
4788
|
*/
|
|
4789
|
-
IntegrationUri?: string;
|
|
4789
|
+
IntegrationUri?: string | undefined;
|
|
4790
4790
|
/**
|
|
4791
4791
|
* <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 requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>
|
|
4792
4792
|
* @public
|
|
4793
4793
|
*/
|
|
4794
|
-
PassthroughBehavior?: PassthroughBehavior;
|
|
4794
|
+
PassthroughBehavior?: PassthroughBehavior | undefined;
|
|
4795
4795
|
/**
|
|
4796
4796
|
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
|
|
4797
4797
|
* @public
|
|
4798
4798
|
*/
|
|
4799
|
-
PayloadFormatVersion?: string;
|
|
4799
|
+
PayloadFormatVersion?: string | undefined;
|
|
4800
4800
|
/**
|
|
4801
4801
|
* <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. The method request parameter value must match the pattern of method.request.<replaceable>\{location\}</replaceable>.<replaceable>\{name\}</replaceable>
|
|
4802
4802
|
* , where
|
|
@@ -4806,32 +4806,32 @@ export interface UpdateIntegrationResult {
|
|
|
4806
4806
|
* must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
|
|
4807
4807
|
* @public
|
|
4808
4808
|
*/
|
|
4809
|
-
RequestParameters?: Record<string, string
|
|
4809
|
+
RequestParameters?: Record<string, string> | undefined;
|
|
4810
4810
|
/**
|
|
4811
4811
|
* <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. Supported only for WebSocket APIs.</p>
|
|
4812
4812
|
* @public
|
|
4813
4813
|
*/
|
|
4814
|
-
RequestTemplates?: Record<string, string
|
|
4814
|
+
RequestTemplates?: Record<string, string> | undefined;
|
|
4815
4815
|
/**
|
|
4816
4816
|
* <p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
|
|
4817
4817
|
* @public
|
|
4818
4818
|
*/
|
|
4819
|
-
ResponseParameters?: Record<string, Record<string, string
|
|
4819
|
+
ResponseParameters?: Record<string, Record<string, string>> | undefined;
|
|
4820
4820
|
/**
|
|
4821
4821
|
* <p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>
|
|
4822
4822
|
* @public
|
|
4823
4823
|
*/
|
|
4824
|
-
TemplateSelectionExpression?: string;
|
|
4824
|
+
TemplateSelectionExpression?: string | undefined;
|
|
4825
4825
|
/**
|
|
4826
4826
|
* <p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>
|
|
4827
4827
|
* @public
|
|
4828
4828
|
*/
|
|
4829
|
-
TimeoutInMillis?: number;
|
|
4829
|
+
TimeoutInMillis?: number | undefined;
|
|
4830
4830
|
/**
|
|
4831
4831
|
* <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
|
|
4832
4832
|
* @public
|
|
4833
4833
|
*/
|
|
4834
|
-
TlsConfig?: TlsConfig;
|
|
4834
|
+
TlsConfig?: TlsConfig | undefined;
|
|
4835
4835
|
}
|
|
4836
4836
|
/**
|
|
4837
4837
|
* <p>Updates an IntegrationResponses.</p>
|
|
@@ -4847,7 +4847,7 @@ export interface UpdateIntegrationResponseRequest {
|
|
|
4847
4847
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
4848
4848
|
* @public
|
|
4849
4849
|
*/
|
|
4850
|
-
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
4850
|
+
ContentHandlingStrategy?: ContentHandlingStrategy | undefined;
|
|
4851
4851
|
/**
|
|
4852
4852
|
* <p>The integration ID.</p>
|
|
4853
4853
|
* @public
|
|
@@ -4862,7 +4862,7 @@ export interface UpdateIntegrationResponseRequest {
|
|
|
4862
4862
|
* <p>The integration response key.</p>
|
|
4863
4863
|
* @public
|
|
4864
4864
|
*/
|
|
4865
|
-
IntegrationResponseKey?: string;
|
|
4865
|
+
IntegrationResponseKey?: string | undefined;
|
|
4866
4866
|
/**
|
|
4867
4867
|
* <p>A key-value map specifying response parameters that are passed to the method response from the backend. 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 method.response.header.<replaceable>\{name\}</replaceable>
|
|
4868
4868
|
* , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.<replaceable>\{name\}</replaceable>
|
|
@@ -4874,17 +4874,17 @@ export interface UpdateIntegrationResponseRequest {
|
|
|
4874
4874
|
* is a valid JSON expression without the $ prefix.</p>
|
|
4875
4875
|
* @public
|
|
4876
4876
|
*/
|
|
4877
|
-
ResponseParameters?: Record<string, string
|
|
4877
|
+
ResponseParameters?: Record<string, string> | undefined;
|
|
4878
4878
|
/**
|
|
4879
4879
|
* <p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>
|
|
4880
4880
|
* @public
|
|
4881
4881
|
*/
|
|
4882
|
-
ResponseTemplates?: Record<string, string
|
|
4882
|
+
ResponseTemplates?: Record<string, string> | undefined;
|
|
4883
4883
|
/**
|
|
4884
4884
|
* <p>The template selection expression for the integration response. Supported only for WebSocket APIs.</p>
|
|
4885
4885
|
* @public
|
|
4886
4886
|
*/
|
|
4887
|
-
TemplateSelectionExpression?: string;
|
|
4887
|
+
TemplateSelectionExpression?: string | undefined;
|
|
4888
4888
|
}
|
|
4889
4889
|
/**
|
|
4890
4890
|
* @public
|
|
@@ -4894,32 +4894,32 @@ export interface UpdateIntegrationResponseResponse {
|
|
|
4894
4894
|
* <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
|
|
4895
4895
|
* @public
|
|
4896
4896
|
*/
|
|
4897
|
-
ContentHandlingStrategy?: ContentHandlingStrategy;
|
|
4897
|
+
ContentHandlingStrategy?: ContentHandlingStrategy | undefined;
|
|
4898
4898
|
/**
|
|
4899
4899
|
* <p>The integration response ID.</p>
|
|
4900
4900
|
* @public
|
|
4901
4901
|
*/
|
|
4902
|
-
IntegrationResponseId?: string;
|
|
4902
|
+
IntegrationResponseId?: string | undefined;
|
|
4903
4903
|
/**
|
|
4904
4904
|
* <p>The integration response key.</p>
|
|
4905
4905
|
* @public
|
|
4906
4906
|
*/
|
|
4907
|
-
IntegrationResponseKey?: string;
|
|
4907
|
+
IntegrationResponseKey?: string | undefined;
|
|
4908
4908
|
/**
|
|
4909
4909
|
* <p>A key-value map specifying response parameters that are passed to the method response from the backend. 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 method.response.header.\{name\}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.\{name\} or integration.response.body.\{JSON-expression\}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.</p>
|
|
4910
4910
|
* @public
|
|
4911
4911
|
*/
|
|
4912
|
-
ResponseParameters?: Record<string, string
|
|
4912
|
+
ResponseParameters?: Record<string, string> | undefined;
|
|
4913
4913
|
/**
|
|
4914
4914
|
* <p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>
|
|
4915
4915
|
* @public
|
|
4916
4916
|
*/
|
|
4917
|
-
ResponseTemplates?: Record<string, string
|
|
4917
|
+
ResponseTemplates?: Record<string, string> | undefined;
|
|
4918
4918
|
/**
|
|
4919
4919
|
* <p>The template selection expressions for the integration response.</p>
|
|
4920
4920
|
* @public
|
|
4921
4921
|
*/
|
|
4922
|
-
TemplateSelectionExpression?: string;
|
|
4922
|
+
TemplateSelectionExpression?: string | undefined;
|
|
4923
4923
|
}
|
|
4924
4924
|
/**
|
|
4925
4925
|
* <p>Updates a Model.</p>
|
|
@@ -4935,12 +4935,12 @@ export interface UpdateModelRequest {
|
|
|
4935
4935
|
* <p>The content-type for the model, for example, "application/json".</p>
|
|
4936
4936
|
* @public
|
|
4937
4937
|
*/
|
|
4938
|
-
ContentType?: string;
|
|
4938
|
+
ContentType?: string | undefined;
|
|
4939
4939
|
/**
|
|
4940
4940
|
* <p>The description of the model.</p>
|
|
4941
4941
|
* @public
|
|
4942
4942
|
*/
|
|
4943
|
-
Description?: string;
|
|
4943
|
+
Description?: string | undefined;
|
|
4944
4944
|
/**
|
|
4945
4945
|
* <p>The model ID.</p>
|
|
4946
4946
|
* @public
|
|
@@ -4950,12 +4950,12 @@ export interface UpdateModelRequest {
|
|
|
4950
4950
|
* <p>The name of the model.</p>
|
|
4951
4951
|
* @public
|
|
4952
4952
|
*/
|
|
4953
|
-
Name?: string;
|
|
4953
|
+
Name?: string | undefined;
|
|
4954
4954
|
/**
|
|
4955
4955
|
* <p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>
|
|
4956
4956
|
* @public
|
|
4957
4957
|
*/
|
|
4958
|
-
Schema?: string;
|
|
4958
|
+
Schema?: string | undefined;
|
|
4959
4959
|
}
|
|
4960
4960
|
/**
|
|
4961
4961
|
* @public
|
|
@@ -4965,27 +4965,27 @@ export interface UpdateModelResponse {
|
|
|
4965
4965
|
* <p>The content-type for the model, for example, "application/json".</p>
|
|
4966
4966
|
* @public
|
|
4967
4967
|
*/
|
|
4968
|
-
ContentType?: string;
|
|
4968
|
+
ContentType?: string | undefined;
|
|
4969
4969
|
/**
|
|
4970
4970
|
* <p>The description of the model.</p>
|
|
4971
4971
|
* @public
|
|
4972
4972
|
*/
|
|
4973
|
-
Description?: string;
|
|
4973
|
+
Description?: string | undefined;
|
|
4974
4974
|
/**
|
|
4975
4975
|
* <p>The model identifier.</p>
|
|
4976
4976
|
* @public
|
|
4977
4977
|
*/
|
|
4978
|
-
ModelId?: string;
|
|
4978
|
+
ModelId?: string | undefined;
|
|
4979
4979
|
/**
|
|
4980
4980
|
* <p>The name of the model. Must be alphanumeric.</p>
|
|
4981
4981
|
* @public
|
|
4982
4982
|
*/
|
|
4983
|
-
Name?: string;
|
|
4983
|
+
Name?: string | undefined;
|
|
4984
4984
|
/**
|
|
4985
4985
|
* <p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>
|
|
4986
4986
|
* @public
|
|
4987
4987
|
*/
|
|
4988
|
-
Schema?: string;
|
|
4988
|
+
Schema?: string | undefined;
|
|
4989
4989
|
}
|
|
4990
4990
|
/**
|
|
4991
4991
|
* <p>Updates a Route.</p>
|
|
@@ -5001,42 +5001,42 @@ export interface UpdateRouteRequest {
|
|
|
5001
5001
|
* <p>Specifies whether an API key is required for the route. Supported only for WebSocket APIs.</p>
|
|
5002
5002
|
* @public
|
|
5003
5003
|
*/
|
|
5004
|
-
ApiKeyRequired?: boolean;
|
|
5004
|
+
ApiKeyRequired?: boolean | undefined;
|
|
5005
5005
|
/**
|
|
5006
5006
|
* <p>The authorization scopes supported by this route.</p>
|
|
5007
5007
|
* @public
|
|
5008
5008
|
*/
|
|
5009
|
-
AuthorizationScopes?: string[];
|
|
5009
|
+
AuthorizationScopes?: string[] | undefined;
|
|
5010
5010
|
/**
|
|
5011
5011
|
* <p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>
|
|
5012
5012
|
* @public
|
|
5013
5013
|
*/
|
|
5014
|
-
AuthorizationType?: AuthorizationType;
|
|
5014
|
+
AuthorizationType?: AuthorizationType | undefined;
|
|
5015
5015
|
/**
|
|
5016
5016
|
* <p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>
|
|
5017
5017
|
* @public
|
|
5018
5018
|
*/
|
|
5019
|
-
AuthorizerId?: string;
|
|
5019
|
+
AuthorizerId?: string | undefined;
|
|
5020
5020
|
/**
|
|
5021
5021
|
* <p>The model selection expression for the route. Supported only for WebSocket APIs.</p>
|
|
5022
5022
|
* @public
|
|
5023
5023
|
*/
|
|
5024
|
-
ModelSelectionExpression?: string;
|
|
5024
|
+
ModelSelectionExpression?: string | undefined;
|
|
5025
5025
|
/**
|
|
5026
5026
|
* <p>The operation name for the route.</p>
|
|
5027
5027
|
* @public
|
|
5028
5028
|
*/
|
|
5029
|
-
OperationName?: string;
|
|
5029
|
+
OperationName?: string | undefined;
|
|
5030
5030
|
/**
|
|
5031
5031
|
* <p>The request models for the route. Supported only for WebSocket APIs.</p>
|
|
5032
5032
|
* @public
|
|
5033
5033
|
*/
|
|
5034
|
-
RequestModels?: Record<string, string
|
|
5034
|
+
RequestModels?: Record<string, string> | undefined;
|
|
5035
5035
|
/**
|
|
5036
5036
|
* <p>The request parameters for the route. Supported only for WebSocket APIs.</p>
|
|
5037
5037
|
* @public
|
|
5038
5038
|
*/
|
|
5039
|
-
RequestParameters?: Record<string, ParameterConstraints
|
|
5039
|
+
RequestParameters?: Record<string, ParameterConstraints> | undefined;
|
|
5040
5040
|
/**
|
|
5041
5041
|
* <p>The route ID.</p>
|
|
5042
5042
|
* @public
|
|
@@ -5046,17 +5046,17 @@ export interface UpdateRouteRequest {
|
|
|
5046
5046
|
* <p>The route key for the route.</p>
|
|
5047
5047
|
* @public
|
|
5048
5048
|
*/
|
|
5049
|
-
RouteKey?: string;
|
|
5049
|
+
RouteKey?: string | undefined;
|
|
5050
5050
|
/**
|
|
5051
5051
|
* <p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>
|
|
5052
5052
|
* @public
|
|
5053
5053
|
*/
|
|
5054
|
-
RouteResponseSelectionExpression?: string;
|
|
5054
|
+
RouteResponseSelectionExpression?: string | undefined;
|
|
5055
5055
|
/**
|
|
5056
5056
|
* <p>The target for the route.</p>
|
|
5057
5057
|
* @public
|
|
5058
5058
|
*/
|
|
5059
|
-
Target?: string;
|
|
5059
|
+
Target?: string | undefined;
|
|
5060
5060
|
}
|
|
5061
5061
|
/**
|
|
5062
5062
|
* @public
|
|
@@ -5066,67 +5066,67 @@ export interface UpdateRouteResult {
|
|
|
5066
5066
|
* <p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>
|
|
5067
5067
|
* @public
|
|
5068
5068
|
*/
|
|
5069
|
-
ApiGatewayManaged?: boolean;
|
|
5069
|
+
ApiGatewayManaged?: boolean | undefined;
|
|
5070
5070
|
/**
|
|
5071
5071
|
* <p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>
|
|
5072
5072
|
* @public
|
|
5073
5073
|
*/
|
|
5074
|
-
ApiKeyRequired?: boolean;
|
|
5074
|
+
ApiKeyRequired?: boolean | undefined;
|
|
5075
5075
|
/**
|
|
5076
5076
|
* <p>A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>
|
|
5077
5077
|
* @public
|
|
5078
5078
|
*/
|
|
5079
|
-
AuthorizationScopes?: string[];
|
|
5079
|
+
AuthorizationScopes?: string[] | undefined;
|
|
5080
5080
|
/**
|
|
5081
5081
|
* <p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>
|
|
5082
5082
|
* @public
|
|
5083
5083
|
*/
|
|
5084
|
-
AuthorizationType?: AuthorizationType;
|
|
5084
|
+
AuthorizationType?: AuthorizationType | undefined;
|
|
5085
5085
|
/**
|
|
5086
5086
|
* <p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>
|
|
5087
5087
|
* @public
|
|
5088
5088
|
*/
|
|
5089
|
-
AuthorizerId?: string;
|
|
5089
|
+
AuthorizerId?: string | undefined;
|
|
5090
5090
|
/**
|
|
5091
5091
|
* <p>The model selection expression for the route. Supported only for WebSocket APIs.</p>
|
|
5092
5092
|
* @public
|
|
5093
5093
|
*/
|
|
5094
|
-
ModelSelectionExpression?: string;
|
|
5094
|
+
ModelSelectionExpression?: string | undefined;
|
|
5095
5095
|
/**
|
|
5096
5096
|
* <p>The operation name for the route.</p>
|
|
5097
5097
|
* @public
|
|
5098
5098
|
*/
|
|
5099
|
-
OperationName?: string;
|
|
5099
|
+
OperationName?: string | undefined;
|
|
5100
5100
|
/**
|
|
5101
5101
|
* <p>The request models for the route. Supported only for WebSocket APIs.</p>
|
|
5102
5102
|
* @public
|
|
5103
5103
|
*/
|
|
5104
|
-
RequestModels?: Record<string, string
|
|
5104
|
+
RequestModels?: Record<string, string> | undefined;
|
|
5105
5105
|
/**
|
|
5106
5106
|
* <p>The request parameters for the route. Supported only for WebSocket APIs.</p>
|
|
5107
5107
|
* @public
|
|
5108
5108
|
*/
|
|
5109
|
-
RequestParameters?: Record<string, ParameterConstraints
|
|
5109
|
+
RequestParameters?: Record<string, ParameterConstraints> | undefined;
|
|
5110
5110
|
/**
|
|
5111
5111
|
* <p>The route ID.</p>
|
|
5112
5112
|
* @public
|
|
5113
5113
|
*/
|
|
5114
|
-
RouteId?: string;
|
|
5114
|
+
RouteId?: string | undefined;
|
|
5115
5115
|
/**
|
|
5116
5116
|
* <p>The route key for the route.</p>
|
|
5117
5117
|
* @public
|
|
5118
5118
|
*/
|
|
5119
|
-
RouteKey?: string;
|
|
5119
|
+
RouteKey?: string | undefined;
|
|
5120
5120
|
/**
|
|
5121
5121
|
* <p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>
|
|
5122
5122
|
* @public
|
|
5123
5123
|
*/
|
|
5124
|
-
RouteResponseSelectionExpression?: string;
|
|
5124
|
+
RouteResponseSelectionExpression?: string | undefined;
|
|
5125
5125
|
/**
|
|
5126
5126
|
* <p>The target for the route.</p>
|
|
5127
5127
|
* @public
|
|
5128
5128
|
*/
|
|
5129
|
-
Target?: string;
|
|
5129
|
+
Target?: string | undefined;
|
|
5130
5130
|
}
|
|
5131
5131
|
/**
|
|
5132
5132
|
* <p>Updates a RouteResponse.</p>
|
|
@@ -5142,17 +5142,17 @@ export interface UpdateRouteResponseRequest {
|
|
|
5142
5142
|
* <p>The model selection expression for the route response. Supported only for WebSocket APIs.</p>
|
|
5143
5143
|
* @public
|
|
5144
5144
|
*/
|
|
5145
|
-
ModelSelectionExpression?: string;
|
|
5145
|
+
ModelSelectionExpression?: string | undefined;
|
|
5146
5146
|
/**
|
|
5147
5147
|
* <p>The response models for the route response.</p>
|
|
5148
5148
|
* @public
|
|
5149
5149
|
*/
|
|
5150
|
-
ResponseModels?: Record<string, string
|
|
5150
|
+
ResponseModels?: Record<string, string> | undefined;
|
|
5151
5151
|
/**
|
|
5152
5152
|
* <p>The route response parameters.</p>
|
|
5153
5153
|
* @public
|
|
5154
5154
|
*/
|
|
5155
|
-
ResponseParameters?: Record<string, ParameterConstraints
|
|
5155
|
+
ResponseParameters?: Record<string, ParameterConstraints> | undefined;
|
|
5156
5156
|
/**
|
|
5157
5157
|
* <p>The route ID.</p>
|
|
5158
5158
|
* @public
|
|
@@ -5167,7 +5167,7 @@ export interface UpdateRouteResponseRequest {
|
|
|
5167
5167
|
* <p>The route response key.</p>
|
|
5168
5168
|
* @public
|
|
5169
5169
|
*/
|
|
5170
|
-
RouteResponseKey?: string;
|
|
5170
|
+
RouteResponseKey?: string | undefined;
|
|
5171
5171
|
}
|
|
5172
5172
|
/**
|
|
5173
5173
|
* @public
|
|
@@ -5177,27 +5177,27 @@ export interface UpdateRouteResponseResponse {
|
|
|
5177
5177
|
* <p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>
|
|
5178
5178
|
* @public
|
|
5179
5179
|
*/
|
|
5180
|
-
ModelSelectionExpression?: string;
|
|
5180
|
+
ModelSelectionExpression?: string | undefined;
|
|
5181
5181
|
/**
|
|
5182
5182
|
* <p>Represents the response models of a route response.</p>
|
|
5183
5183
|
* @public
|
|
5184
5184
|
*/
|
|
5185
|
-
ResponseModels?: Record<string, string
|
|
5185
|
+
ResponseModels?: Record<string, string> | undefined;
|
|
5186
5186
|
/**
|
|
5187
5187
|
* <p>Represents the response parameters of a route response.</p>
|
|
5188
5188
|
* @public
|
|
5189
5189
|
*/
|
|
5190
|
-
ResponseParameters?: Record<string, ParameterConstraints
|
|
5190
|
+
ResponseParameters?: Record<string, ParameterConstraints> | undefined;
|
|
5191
5191
|
/**
|
|
5192
5192
|
* <p>Represents the identifier of a route response.</p>
|
|
5193
5193
|
* @public
|
|
5194
5194
|
*/
|
|
5195
|
-
RouteResponseId?: string;
|
|
5195
|
+
RouteResponseId?: string | undefined;
|
|
5196
5196
|
/**
|
|
5197
5197
|
* <p>Represents the route response key of a route response.</p>
|
|
5198
5198
|
* @public
|
|
5199
5199
|
*/
|
|
5200
|
-
RouteResponseKey?: string;
|
|
5200
|
+
RouteResponseKey?: string | undefined;
|
|
5201
5201
|
}
|
|
5202
5202
|
/**
|
|
5203
5203
|
* <p>Updates a Stage.</p>
|
|
@@ -5208,7 +5208,7 @@ export interface UpdateStageRequest {
|
|
|
5208
5208
|
* <p>Settings for logging access in this stage.</p>
|
|
5209
5209
|
* @public
|
|
5210
5210
|
*/
|
|
5211
|
-
AccessLogSettings?: AccessLogSettings;
|
|
5211
|
+
AccessLogSettings?: AccessLogSettings | undefined;
|
|
5212
5212
|
/**
|
|
5213
5213
|
* <p>The API identifier.</p>
|
|
5214
5214
|
* @public
|
|
@@ -5218,32 +5218,32 @@ export interface UpdateStageRequest {
|
|
|
5218
5218
|
* <p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>
|
|
5219
5219
|
* @public
|
|
5220
5220
|
*/
|
|
5221
|
-
AutoDeploy?: boolean;
|
|
5221
|
+
AutoDeploy?: boolean | undefined;
|
|
5222
5222
|
/**
|
|
5223
5223
|
* <p>The identifier of a client certificate for a Stage.</p>
|
|
5224
5224
|
* @public
|
|
5225
5225
|
*/
|
|
5226
|
-
ClientCertificateId?: string;
|
|
5226
|
+
ClientCertificateId?: string | undefined;
|
|
5227
5227
|
/**
|
|
5228
5228
|
* <p>The default route settings for the stage.</p>
|
|
5229
5229
|
* @public
|
|
5230
5230
|
*/
|
|
5231
|
-
DefaultRouteSettings?: RouteSettings;
|
|
5231
|
+
DefaultRouteSettings?: RouteSettings | undefined;
|
|
5232
5232
|
/**
|
|
5233
5233
|
* <p>The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.</p>
|
|
5234
5234
|
* @public
|
|
5235
5235
|
*/
|
|
5236
|
-
DeploymentId?: string;
|
|
5236
|
+
DeploymentId?: string | undefined;
|
|
5237
5237
|
/**
|
|
5238
5238
|
* <p>The description for the API stage.</p>
|
|
5239
5239
|
* @public
|
|
5240
5240
|
*/
|
|
5241
|
-
Description?: string;
|
|
5241
|
+
Description?: string | undefined;
|
|
5242
5242
|
/**
|
|
5243
5243
|
* <p>Route settings for the stage.</p>
|
|
5244
5244
|
* @public
|
|
5245
5245
|
*/
|
|
5246
|
-
RouteSettings?: Record<string, RouteSettings
|
|
5246
|
+
RouteSettings?: Record<string, RouteSettings> | undefined;
|
|
5247
5247
|
/**
|
|
5248
5248
|
* <p>The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.</p>
|
|
5249
5249
|
* @public
|
|
@@ -5253,7 +5253,7 @@ export interface UpdateStageRequest {
|
|
|
5253
5253
|
* <p>A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>
|
|
5254
5254
|
* @public
|
|
5255
5255
|
*/
|
|
5256
|
-
StageVariables?: Record<string, string
|
|
5256
|
+
StageVariables?: Record<string, string> | undefined;
|
|
5257
5257
|
}
|
|
5258
5258
|
/**
|
|
5259
5259
|
* @public
|
|
@@ -5263,72 +5263,72 @@ export interface UpdateStageResponse {
|
|
|
5263
5263
|
* <p>Settings for logging access in this stage.</p>
|
|
5264
5264
|
* @public
|
|
5265
5265
|
*/
|
|
5266
|
-
AccessLogSettings?: AccessLogSettings;
|
|
5266
|
+
AccessLogSettings?: AccessLogSettings | undefined;
|
|
5267
5267
|
/**
|
|
5268
5268
|
* <p>Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.</p>
|
|
5269
5269
|
* @public
|
|
5270
5270
|
*/
|
|
5271
|
-
ApiGatewayManaged?: boolean;
|
|
5271
|
+
ApiGatewayManaged?: boolean | undefined;
|
|
5272
5272
|
/**
|
|
5273
5273
|
* <p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>
|
|
5274
5274
|
* @public
|
|
5275
5275
|
*/
|
|
5276
|
-
AutoDeploy?: boolean;
|
|
5276
|
+
AutoDeploy?: boolean | undefined;
|
|
5277
5277
|
/**
|
|
5278
5278
|
* <p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>
|
|
5279
5279
|
* @public
|
|
5280
5280
|
*/
|
|
5281
|
-
ClientCertificateId?: string;
|
|
5281
|
+
ClientCertificateId?: string | undefined;
|
|
5282
5282
|
/**
|
|
5283
5283
|
* <p>The timestamp when the stage was created.</p>
|
|
5284
5284
|
* @public
|
|
5285
5285
|
*/
|
|
5286
|
-
CreatedDate?: Date;
|
|
5286
|
+
CreatedDate?: Date | undefined;
|
|
5287
5287
|
/**
|
|
5288
5288
|
* <p>Default route settings for the stage.</p>
|
|
5289
5289
|
* @public
|
|
5290
5290
|
*/
|
|
5291
|
-
DefaultRouteSettings?: RouteSettings;
|
|
5291
|
+
DefaultRouteSettings?: RouteSettings | undefined;
|
|
5292
5292
|
/**
|
|
5293
5293
|
* <p>The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.</p>
|
|
5294
5294
|
* @public
|
|
5295
5295
|
*/
|
|
5296
|
-
DeploymentId?: string;
|
|
5296
|
+
DeploymentId?: string | undefined;
|
|
5297
5297
|
/**
|
|
5298
5298
|
* <p>The description of the stage.</p>
|
|
5299
5299
|
* @public
|
|
5300
5300
|
*/
|
|
5301
|
-
Description?: string;
|
|
5301
|
+
Description?: string | undefined;
|
|
5302
5302
|
/**
|
|
5303
5303
|
* <p>Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.</p>
|
|
5304
5304
|
* @public
|
|
5305
5305
|
*/
|
|
5306
|
-
LastDeploymentStatusMessage?: string;
|
|
5306
|
+
LastDeploymentStatusMessage?: string | undefined;
|
|
5307
5307
|
/**
|
|
5308
5308
|
* <p>The timestamp when the stage was last updated.</p>
|
|
5309
5309
|
* @public
|
|
5310
5310
|
*/
|
|
5311
|
-
LastUpdatedDate?: Date;
|
|
5311
|
+
LastUpdatedDate?: Date | undefined;
|
|
5312
5312
|
/**
|
|
5313
5313
|
* <p>Route settings for the stage, by routeKey.</p>
|
|
5314
5314
|
* @public
|
|
5315
5315
|
*/
|
|
5316
|
-
RouteSettings?: Record<string, RouteSettings
|
|
5316
|
+
RouteSettings?: Record<string, RouteSettings> | undefined;
|
|
5317
5317
|
/**
|
|
5318
5318
|
* <p>The name of the stage.</p>
|
|
5319
5319
|
* @public
|
|
5320
5320
|
*/
|
|
5321
|
-
StageName?: string;
|
|
5321
|
+
StageName?: string | undefined;
|
|
5322
5322
|
/**
|
|
5323
5323
|
* <p>A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>
|
|
5324
5324
|
* @public
|
|
5325
5325
|
*/
|
|
5326
|
-
StageVariables?: Record<string, string
|
|
5326
|
+
StageVariables?: Record<string, string> | undefined;
|
|
5327
5327
|
/**
|
|
5328
5328
|
* <p>The collection of tags. Each tag element is associated with a given resource.</p>
|
|
5329
5329
|
* @public
|
|
5330
5330
|
*/
|
|
5331
|
-
Tags?: Record<string, string
|
|
5331
|
+
Tags?: Record<string, string> | undefined;
|
|
5332
5332
|
}
|
|
5333
5333
|
/**
|
|
5334
5334
|
* <p>Updates a VPC link.</p>
|
|
@@ -5339,7 +5339,7 @@ export interface UpdateVpcLinkRequest {
|
|
|
5339
5339
|
* <p>The name of the VPC link.</p>
|
|
5340
5340
|
* @public
|
|
5341
5341
|
*/
|
|
5342
|
-
Name?: string;
|
|
5342
|
+
Name?: string | undefined;
|
|
5343
5343
|
/**
|
|
5344
5344
|
* <p>The ID of the VPC link.</p>
|
|
5345
5345
|
* @public
|
|
@@ -5354,45 +5354,45 @@ export interface UpdateVpcLinkResponse {
|
|
|
5354
5354
|
* <p>The timestamp when the VPC link was created.</p>
|
|
5355
5355
|
* @public
|
|
5356
5356
|
*/
|
|
5357
|
-
CreatedDate?: Date;
|
|
5357
|
+
CreatedDate?: Date | undefined;
|
|
5358
5358
|
/**
|
|
5359
5359
|
* <p>The name of the VPC link.</p>
|
|
5360
5360
|
* @public
|
|
5361
5361
|
*/
|
|
5362
|
-
Name?: string;
|
|
5362
|
+
Name?: string | undefined;
|
|
5363
5363
|
/**
|
|
5364
5364
|
* <p>A list of security group IDs for the VPC link.</p>
|
|
5365
5365
|
* @public
|
|
5366
5366
|
*/
|
|
5367
|
-
SecurityGroupIds?: string[];
|
|
5367
|
+
SecurityGroupIds?: string[] | undefined;
|
|
5368
5368
|
/**
|
|
5369
5369
|
* <p>A list of subnet IDs to include in the VPC link.</p>
|
|
5370
5370
|
* @public
|
|
5371
5371
|
*/
|
|
5372
|
-
SubnetIds?: string[];
|
|
5372
|
+
SubnetIds?: string[] | undefined;
|
|
5373
5373
|
/**
|
|
5374
5374
|
* <p>Tags for the VPC link.</p>
|
|
5375
5375
|
* @public
|
|
5376
5376
|
*/
|
|
5377
|
-
Tags?: Record<string, string
|
|
5377
|
+
Tags?: Record<string, string> | undefined;
|
|
5378
5378
|
/**
|
|
5379
5379
|
* <p>The ID of the VPC link.</p>
|
|
5380
5380
|
* @public
|
|
5381
5381
|
*/
|
|
5382
|
-
VpcLinkId?: string;
|
|
5382
|
+
VpcLinkId?: string | undefined;
|
|
5383
5383
|
/**
|
|
5384
5384
|
* <p>The status of the VPC link.</p>
|
|
5385
5385
|
* @public
|
|
5386
5386
|
*/
|
|
5387
|
-
VpcLinkStatus?: VpcLinkStatus;
|
|
5387
|
+
VpcLinkStatus?: VpcLinkStatus | undefined;
|
|
5388
5388
|
/**
|
|
5389
5389
|
* <p>A message summarizing the cause of the status of the VPC link.</p>
|
|
5390
5390
|
* @public
|
|
5391
5391
|
*/
|
|
5392
|
-
VpcLinkStatusMessage?: string;
|
|
5392
|
+
VpcLinkStatusMessage?: string | undefined;
|
|
5393
5393
|
/**
|
|
5394
5394
|
* <p>The version of the VPC link.</p>
|
|
5395
5395
|
* @public
|
|
5396
5396
|
*/
|
|
5397
|
-
VpcLinkVersion?: VpcLinkVersion;
|
|
5397
|
+
VpcLinkVersion?: VpcLinkVersion | undefined;
|
|
5398
5398
|
}
|