@aws-sdk/client-appsync 3.476.0 → 3.478.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist-cjs/models/models_0.js +5 -1
- package/dist-cjs/protocols/Aws_restJson1.js +376 -828
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +377 -829
- package/dist-types/AppSync.d.ts +2 -2
- package/dist-types/AppSyncClient.d.ts +2 -2
- package/dist-types/commands/AssociateApiCommand.d.ts +3 -4
- package/dist-types/commands/AssociateMergedGraphqlApiCommand.d.ts +5 -6
- package/dist-types/commands/AssociateSourceGraphqlApiCommand.d.ts +5 -6
- package/dist-types/commands/CreateApiCacheCommand.d.ts +5 -6
- package/dist-types/commands/CreateApiKeyCommand.d.ts +3 -4
- package/dist-types/commands/CreateDataSourceCommand.d.ts +5 -6
- package/dist-types/commands/CreateDomainNameCommand.d.ts +2 -2
- package/dist-types/commands/CreateFunctionCommand.d.ts +4 -6
- package/dist-types/commands/CreateGraphqlApiCommand.d.ts +10 -4
- package/dist-types/commands/CreateResolverCommand.d.ts +7 -8
- package/dist-types/commands/CreateTypeCommand.d.ts +5 -6
- package/dist-types/commands/DeleteApiCacheCommand.d.ts +5 -6
- package/dist-types/commands/DeleteApiKeyCommand.d.ts +3 -4
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +5 -6
- package/dist-types/commands/DeleteDomainNameCommand.d.ts +5 -6
- package/dist-types/commands/DeleteFunctionCommand.d.ts +3 -4
- package/dist-types/commands/DeleteGraphqlApiCommand.d.ts +5 -6
- package/dist-types/commands/DeleteResolverCommand.d.ts +5 -6
- package/dist-types/commands/DeleteTypeCommand.d.ts +5 -6
- package/dist-types/commands/DisassociateApiCommand.d.ts +5 -6
- package/dist-types/commands/DisassociateMergedGraphqlApiCommand.d.ts +5 -6
- package/dist-types/commands/DisassociateSourceGraphqlApiCommand.d.ts +5 -6
- package/dist-types/commands/EvaluateCodeCommand.d.ts +7 -8
- package/dist-types/commands/EvaluateMappingTemplateCommand.d.ts +7 -8
- package/dist-types/commands/FlushApiCacheCommand.d.ts +5 -6
- package/dist-types/commands/GetApiAssociationCommand.d.ts +3 -4
- package/dist-types/commands/GetApiCacheCommand.d.ts +5 -6
- package/dist-types/commands/GetDataSourceCommand.d.ts +5 -6
- package/dist-types/commands/GetDataSourceIntrospectionCommand.d.ts +3 -4
- package/dist-types/commands/GetDomainNameCommand.d.ts +3 -4
- package/dist-types/commands/GetFunctionCommand.d.ts +3 -4
- package/dist-types/commands/GetGraphqlApiCommand.d.ts +6 -4
- package/dist-types/commands/GetIntrospectionSchemaCommand.d.ts +1 -2
- package/dist-types/commands/GetResolverCommand.d.ts +3 -4
- package/dist-types/commands/GetSchemaCreationStatusCommand.d.ts +3 -4
- package/dist-types/commands/GetSourceApiAssociationCommand.d.ts +3 -4
- package/dist-types/commands/GetTypeCommand.d.ts +5 -6
- package/dist-types/commands/ListApiKeysCommand.d.ts +6 -8
- package/dist-types/commands/ListDataSourcesCommand.d.ts +3 -4
- package/dist-types/commands/ListDomainNamesCommand.d.ts +2 -2
- package/dist-types/commands/ListFunctionsCommand.d.ts +3 -4
- package/dist-types/commands/ListGraphqlApisCommand.d.ts +5 -2
- package/dist-types/commands/ListResolversByFunctionCommand.d.ts +3 -4
- package/dist-types/commands/ListResolversCommand.d.ts +3 -4
- package/dist-types/commands/ListSourceApiAssociationsCommand.d.ts +3 -4
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -4
- package/dist-types/commands/ListTypesByAssociationCommand.d.ts +5 -6
- package/dist-types/commands/ListTypesCommand.d.ts +5 -6
- package/dist-types/commands/StartDataSourceIntrospectionCommand.d.ts +3 -4
- package/dist-types/commands/StartSchemaCreationCommand.d.ts +7 -8
- package/dist-types/commands/StartSchemaMergeCommand.d.ts +5 -6
- package/dist-types/commands/TagResourceCommand.d.ts +3 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -4
- package/dist-types/commands/UpdateApiCacheCommand.d.ts +5 -6
- package/dist-types/commands/UpdateApiKeyCommand.d.ts +3 -4
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +5 -6
- package/dist-types/commands/UpdateDomainNameCommand.d.ts +5 -6
- package/dist-types/commands/UpdateFunctionCommand.d.ts +3 -4
- package/dist-types/commands/UpdateGraphqlApiCommand.d.ts +11 -6
- package/dist-types/commands/UpdateResolverCommand.d.ts +5 -6
- package/dist-types/commands/UpdateSourceApiAssociationCommand.d.ts +5 -6
- package/dist-types/commands/UpdateTypeCommand.d.ts +5 -6
- package/dist-types/index.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +431 -383
- package/dist-types/ts3.4/models/models_0.d.ts +15 -0
- package/package.json +7 -6
|
@@ -29,41 +29,37 @@ export declare const AuthenticationType: {
|
|
|
29
29
|
export type AuthenticationType = (typeof AuthenticationType)[keyof typeof AuthenticationType];
|
|
30
30
|
/**
|
|
31
31
|
* @public
|
|
32
|
-
* <p>A <code>LambdaAuthorizerConfig</code> specifies how to authorize AppSync
|
|
33
|
-
*
|
|
34
|
-
* time.</p>
|
|
32
|
+
* <p>A <code>LambdaAuthorizerConfig</code> specifies how to authorize AppSync API access when
|
|
33
|
+
* using the <code>AWS_LAMBDA</code> authorizer mode. Be aware that an AppSync API can have only
|
|
34
|
+
* one Lambda authorizer configured at a time.</p>
|
|
35
35
|
*/
|
|
36
36
|
export interface LambdaAuthorizerConfig {
|
|
37
37
|
/**
|
|
38
38
|
* @public
|
|
39
|
-
* <p>The number of seconds a response should be cached for. The default is 0 seconds, which
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
* a <code>ttlOverride</code> key in its response.</p>
|
|
39
|
+
* <p>The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If
|
|
40
|
+
* you don't specify a value for <code>authorizerResultTtlInSeconds</code>, the default value is used. The maximum
|
|
41
|
+
* value is one hour (3600 seconds). The Lambda function can override this by returning a
|
|
42
|
+
* <code>ttlOverride</code> key in its response.</p>
|
|
44
43
|
*/
|
|
45
44
|
authorizerResultTtlInSeconds?: number;
|
|
46
45
|
/**
|
|
47
46
|
* @public
|
|
48
|
-
* <p>The Amazon Resource Name (ARN) of the Lambda function to be called for
|
|
49
|
-
*
|
|
50
|
-
* (<code>.../v3</code>), or an alias ARN. </p>
|
|
47
|
+
* <p>The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can
|
|
48
|
+
* be a standard Lambda ARN, a version ARN (<code>.../v3</code>), or an alias ARN. </p>
|
|
51
49
|
* <p>
|
|
52
|
-
* <b>Note</b>: This Lambda function must have the
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
* (CLI), run the following:</p>
|
|
50
|
+
* <b>Note</b>: This Lambda function must have the following
|
|
51
|
+
* resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is
|
|
52
|
+
* done for you. To use the Command Line Interface (CLI), run the following:</p>
|
|
56
53
|
* <p>
|
|
57
54
|
* <code>aws lambda add-permission --function-name
|
|
58
|
-
* "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync"
|
|
59
|
-
*
|
|
55
|
+
* "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal
|
|
56
|
+
* appsync.amazonaws.com --action lambda:InvokeFunction</code>
|
|
60
57
|
* </p>
|
|
61
58
|
*/
|
|
62
59
|
authorizerUri: string | undefined;
|
|
63
60
|
/**
|
|
64
61
|
* @public
|
|
65
|
-
* <p>A regular expression for validation of tokens before the Lambda function is
|
|
66
|
-
* called.</p>
|
|
62
|
+
* <p>A regular expression for validation of tokens before the Lambda function is called.</p>
|
|
67
63
|
*/
|
|
68
64
|
identityValidationExpression?: string;
|
|
69
65
|
}
|
|
@@ -74,16 +70,15 @@ export interface LambdaAuthorizerConfig {
|
|
|
74
70
|
export interface OpenIDConnectConfig {
|
|
75
71
|
/**
|
|
76
72
|
* @public
|
|
77
|
-
* <p>The issuer for the OIDC configuration. The issuer returned by discovery must exactly
|
|
78
|
-
*
|
|
73
|
+
* <p>The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of
|
|
74
|
+
* <code>iss</code> in the ID token.</p>
|
|
79
75
|
*/
|
|
80
76
|
issuer: string | undefined;
|
|
81
77
|
/**
|
|
82
78
|
* @public
|
|
83
|
-
* <p>The client identifier of the relying party at the OpenID identity provider. This
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
* validate against multiple client identifiers at a time.</p>
|
|
79
|
+
* <p>The client identifier of the relying party at the OpenID identity provider. This identifier is typically
|
|
80
|
+
* obtained when the relying party is registered with the OpenID identity provider. You can specify a regular
|
|
81
|
+
* expression so that AppSync can validate against multiple client identifiers at a time.</p>
|
|
87
82
|
*/
|
|
88
83
|
clientId?: string;
|
|
89
84
|
/**
|
|
@@ -114,8 +109,8 @@ export interface CognitoUserPoolConfig {
|
|
|
114
109
|
awsRegion: string | undefined;
|
|
115
110
|
/**
|
|
116
111
|
* @public
|
|
117
|
-
* <p>A regular expression for validating the incoming Amazon Cognito user pool app client
|
|
118
|
-
*
|
|
112
|
+
* <p>A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value
|
|
113
|
+
* isn't set, no filtering is applied.</p>
|
|
119
114
|
*/
|
|
120
115
|
appIdClientRegex?: string;
|
|
121
116
|
}
|
|
@@ -126,8 +121,8 @@ export interface CognitoUserPoolConfig {
|
|
|
126
121
|
export interface AdditionalAuthenticationProvider {
|
|
127
122
|
/**
|
|
128
123
|
* @public
|
|
129
|
-
* <p>The authentication type: API key, Identity and Access Management (IAM), OpenID
|
|
130
|
-
*
|
|
124
|
+
* <p>The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC),
|
|
125
|
+
* Amazon Cognito user pools, or Lambda.</p>
|
|
131
126
|
*/
|
|
132
127
|
authenticationType?: AuthenticationType;
|
|
133
128
|
/**
|
|
@@ -180,18 +175,18 @@ export interface ApiAssociation {
|
|
|
180
175
|
* <ul>
|
|
181
176
|
* <li>
|
|
182
177
|
* <p>
|
|
183
|
-
* <b>PROCESSING</b>: The API association is being
|
|
184
|
-
*
|
|
178
|
+
* <b>PROCESSING</b>: The API association is being created. You cannot
|
|
179
|
+
* modify association requests during processing.</p>
|
|
185
180
|
* </li>
|
|
186
181
|
* <li>
|
|
187
182
|
* <p>
|
|
188
|
-
* <b>SUCCESS</b>: The API association was successful.
|
|
189
|
-
*
|
|
183
|
+
* <b>SUCCESS</b>: The API association was successful. You can modify
|
|
184
|
+
* associations after success.</p>
|
|
190
185
|
* </li>
|
|
191
186
|
* <li>
|
|
192
187
|
* <p>
|
|
193
|
-
* <b>FAILED</b>: The API association has failed. You
|
|
194
|
-
*
|
|
188
|
+
* <b>FAILED</b>: The API association has failed. You can modify
|
|
189
|
+
* associations after failure.</p>
|
|
195
190
|
* </li>
|
|
196
191
|
* </ul>
|
|
197
192
|
*/
|
|
@@ -271,21 +266,19 @@ export interface ApiCache {
|
|
|
271
266
|
* <ul>
|
|
272
267
|
* <li>
|
|
273
268
|
* <p>
|
|
274
|
-
* <b>FULL_REQUEST_CACHING</b>: All requests are fully
|
|
275
|
-
* cached.</p>
|
|
269
|
+
* <b>FULL_REQUEST_CACHING</b>: All requests are fully cached.</p>
|
|
276
270
|
* </li>
|
|
277
271
|
* <li>
|
|
278
272
|
* <p>
|
|
279
|
-
* <b>PER_RESOLVER_CACHING</b>: Individual resolvers
|
|
280
|
-
*
|
|
273
|
+
* <b>PER_RESOLVER_CACHING</b>: Individual resolvers that you specify are
|
|
274
|
+
* cached.</p>
|
|
281
275
|
* </li>
|
|
282
276
|
* </ul>
|
|
283
277
|
*/
|
|
284
278
|
apiCachingBehavior?: ApiCachingBehavior;
|
|
285
279
|
/**
|
|
286
280
|
* @public
|
|
287
|
-
* <p>Transit encryption flag when connecting to cache. You cannot update this setting after
|
|
288
|
-
* creation.</p>
|
|
281
|
+
* <p>Transit encryption flag when connecting to cache. You cannot update this setting after creation.</p>
|
|
289
282
|
*/
|
|
290
283
|
transitEncryptionEnabled?: boolean;
|
|
291
284
|
/**
|
|
@@ -377,28 +370,23 @@ export interface ApiCache {
|
|
|
377
370
|
* <ul>
|
|
378
371
|
* <li>
|
|
379
372
|
* <p>
|
|
380
|
-
* <b>AVAILABLE</b>: The instance is available for
|
|
381
|
-
* use.</p>
|
|
373
|
+
* <b>AVAILABLE</b>: The instance is available for use.</p>
|
|
382
374
|
* </li>
|
|
383
375
|
* <li>
|
|
384
376
|
* <p>
|
|
385
|
-
* <b>CREATING</b>: The instance is currently
|
|
386
|
-
* creating.</p>
|
|
377
|
+
* <b>CREATING</b>: The instance is currently creating.</p>
|
|
387
378
|
* </li>
|
|
388
379
|
* <li>
|
|
389
380
|
* <p>
|
|
390
|
-
* <b>DELETING</b>: The instance is currently
|
|
391
|
-
* deleting.</p>
|
|
381
|
+
* <b>DELETING</b>: The instance is currently deleting.</p>
|
|
392
382
|
* </li>
|
|
393
383
|
* <li>
|
|
394
384
|
* <p>
|
|
395
|
-
* <b>MODIFYING</b>: The instance is currently
|
|
396
|
-
* modifying.</p>
|
|
385
|
+
* <b>MODIFYING</b>: The instance is currently modifying.</p>
|
|
397
386
|
* </li>
|
|
398
387
|
* <li>
|
|
399
388
|
* <p>
|
|
400
|
-
* <b>FAILED</b>: The instance has failed
|
|
401
|
-
* creation.</p>
|
|
389
|
+
* <b>FAILED</b>: The instance has failed creation.</p>
|
|
402
390
|
* </li>
|
|
403
391
|
* </ul>
|
|
404
392
|
*/
|
|
@@ -407,13 +395,12 @@ export interface ApiCache {
|
|
|
407
395
|
/**
|
|
408
396
|
* @public
|
|
409
397
|
* <p>Describes an API key.</p>
|
|
410
|
-
* <p>Customers invoke AppSync GraphQL API operations with API keys as an
|
|
411
|
-
*
|
|
398
|
+
* <p>Customers invoke AppSync GraphQL API operations with API keys as an identity mechanism.
|
|
399
|
+
* There are two key versions:</p>
|
|
412
400
|
* <p>
|
|
413
|
-
* <b>da1</b>: We introduced this version at launch in November
|
|
414
|
-
*
|
|
415
|
-
*
|
|
416
|
-
* longer be used.</p>
|
|
401
|
+
* <b>da1</b>: We introduced this version at launch in November 2017. These keys
|
|
402
|
+
* always expire after 7 days. Amazon DynamoDB TTL manages key expiration. These keys ceased to be valid
|
|
403
|
+
* after February 21, 2018, and they should no longer be used.</p>
|
|
417
404
|
* <ul>
|
|
418
405
|
* <li>
|
|
419
406
|
* <p>
|
|
@@ -421,8 +408,7 @@ export interface ApiCache {
|
|
|
421
408
|
* </li>
|
|
422
409
|
* <li>
|
|
423
410
|
* <p>
|
|
424
|
-
* <code>CreateApiKey</code> returns the expiration time in
|
|
425
|
-
* milliseconds.</p>
|
|
411
|
+
* <code>CreateApiKey</code> returns the expiration time in milliseconds.</p>
|
|
426
412
|
* </li>
|
|
427
413
|
* <li>
|
|
428
414
|
* <p>
|
|
@@ -433,45 +419,40 @@ export interface ApiCache {
|
|
|
433
419
|
* <code>DeleteApiKey</code> deletes the item from the table.</p>
|
|
434
420
|
* </li>
|
|
435
421
|
* <li>
|
|
436
|
-
* <p>Expiration is stored in DynamoDB as milliseconds. This results in a
|
|
437
|
-
*
|
|
438
|
-
*
|
|
439
|
-
* table on February 21, 2018.</p>
|
|
422
|
+
* <p>Expiration is stored in DynamoDB as milliseconds. This results in a bug where keys are
|
|
423
|
+
* not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a
|
|
424
|
+
* one-time action, we deleted these keys from the table on February 21, 2018.</p>
|
|
440
425
|
* </li>
|
|
441
426
|
* </ul>
|
|
442
427
|
* <p>
|
|
443
|
-
* <b>da2</b>: We introduced this version in February 2018 when
|
|
444
|
-
* AppSync added support to extend key expiration.</p>
|
|
428
|
+
* <b>da2</b>: We introduced this version in February 2018 when AppSync added support to extend key expiration.</p>
|
|
445
429
|
* <ul>
|
|
446
430
|
* <li>
|
|
447
431
|
* <p>
|
|
448
|
-
* <code>ListApiKeys</code> returns the expiration time and deletion time in
|
|
449
|
-
* seconds.</p>
|
|
432
|
+
* <code>ListApiKeys</code> returns the expiration time and deletion time in seconds.</p>
|
|
450
433
|
* </li>
|
|
451
434
|
* <li>
|
|
452
435
|
* <p>
|
|
453
|
-
* <code>CreateApiKey</code> returns the expiration time and deletion time in
|
|
454
|
-
*
|
|
436
|
+
* <code>CreateApiKey</code> returns the expiration time and deletion time in seconds and accepts a
|
|
437
|
+
* user-provided expiration time in seconds.</p>
|
|
455
438
|
* </li>
|
|
456
439
|
* <li>
|
|
457
440
|
* <p>
|
|
458
|
-
* <code>UpdateApiKey</code> returns the expiration time and and deletion time in
|
|
459
|
-
*
|
|
460
|
-
*
|
|
461
|
-
* long as the key isn't deleted.</p>
|
|
441
|
+
* <code>UpdateApiKey</code> returns the expiration time and and deletion time in seconds and accepts
|
|
442
|
+
* a user-provided expiration time in seconds. Expired API keys are kept for 60 days after the expiration
|
|
443
|
+
* time. You can update the key expiration time as long as the key isn't deleted.</p>
|
|
462
444
|
* </li>
|
|
463
445
|
* <li>
|
|
464
446
|
* <p>
|
|
465
447
|
* <code>DeleteApiKey</code> deletes the item from the table.</p>
|
|
466
448
|
* </li>
|
|
467
449
|
* <li>
|
|
468
|
-
* <p>Expiration is stored in DynamoDB as seconds. After the expiration
|
|
469
|
-
*
|
|
470
|
-
* before deletion.</p>
|
|
450
|
+
* <p>Expiration is stored in DynamoDB as seconds. After the expiration time, using the key to
|
|
451
|
+
* authenticate will fail. However, you can reinstate the key before deletion.</p>
|
|
471
452
|
* </li>
|
|
472
453
|
* <li>
|
|
473
|
-
* <p>Deletion is stored in DynamoDB as seconds. The key is deleted after
|
|
474
|
-
*
|
|
454
|
+
* <p>Deletion is stored in DynamoDB as seconds. The key is deleted after deletion
|
|
455
|
+
* time.</p>
|
|
475
456
|
* </li>
|
|
476
457
|
* </ul>
|
|
477
458
|
*/
|
|
@@ -488,14 +469,14 @@ export interface ApiKey {
|
|
|
488
469
|
description?: string;
|
|
489
470
|
/**
|
|
490
471
|
* @public
|
|
491
|
-
* <p>The time after which the API key expires. The date is represented as seconds since the
|
|
492
|
-
*
|
|
472
|
+
* <p>The time after which the API key expires. The date is represented as seconds since the epoch, rounded down
|
|
473
|
+
* to the nearest hour.</p>
|
|
493
474
|
*/
|
|
494
475
|
expires?: number;
|
|
495
476
|
/**
|
|
496
477
|
* @public
|
|
497
|
-
* <p>The time after which the API key is deleted. The date is represented as seconds since
|
|
498
|
-
*
|
|
478
|
+
* <p>The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded
|
|
479
|
+
* down to the nearest hour.</p>
|
|
499
480
|
*/
|
|
500
481
|
deletes?: number;
|
|
501
482
|
}
|
|
@@ -549,20 +530,21 @@ export declare const RuntimeName: {
|
|
|
549
530
|
export type RuntimeName = (typeof RuntimeName)[keyof typeof RuntimeName];
|
|
550
531
|
/**
|
|
551
532
|
* @public
|
|
552
|
-
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
553
|
-
* that if a runtime is specified, code must
|
|
533
|
+
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
534
|
+
* function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must
|
|
535
|
+
* also be specified.</p>
|
|
554
536
|
*/
|
|
555
537
|
export interface AppSyncRuntime {
|
|
556
538
|
/**
|
|
557
539
|
* @public
|
|
558
540
|
* <p>The <code>name</code> of the runtime to use. Currently, the only allowed value is
|
|
559
|
-
*
|
|
541
|
+
* <code>APPSYNC_JS</code>.</p>
|
|
560
542
|
*/
|
|
561
543
|
name: RuntimeName | undefined;
|
|
562
544
|
/**
|
|
563
545
|
* @public
|
|
564
546
|
* <p>The <code>version</code> of the runtime to use. Currently, the only allowed version is
|
|
565
|
-
*
|
|
547
|
+
* <code>1.0.0</code>.</p>
|
|
566
548
|
*/
|
|
567
549
|
runtimeVersion: string | undefined;
|
|
568
550
|
}
|
|
@@ -620,15 +602,13 @@ export interface CodeError {
|
|
|
620
602
|
/**
|
|
621
603
|
* @public
|
|
622
604
|
* <p>The type of code error. </p>
|
|
623
|
-
* <p>Examples include, but aren't limited to: <code>LINT_ERROR</code>,
|
|
624
|
-
* <code>PARSER_ERROR</code>.</p>
|
|
605
|
+
* <p>Examples include, but aren't limited to: <code>LINT_ERROR</code>, <code>PARSER_ERROR</code>.</p>
|
|
625
606
|
*/
|
|
626
607
|
errorType?: string;
|
|
627
608
|
/**
|
|
628
609
|
* @public
|
|
629
610
|
* <p>A user presentable error.</p>
|
|
630
|
-
* <p>Examples include, but aren't limited to: <code>Parsing error: Unterminated string
|
|
631
|
-
* literal</code>.</p>
|
|
611
|
+
* <p>Examples include, but aren't limited to: <code>Parsing error: Unterminated string literal</code>.</p>
|
|
632
612
|
*/
|
|
633
613
|
value?: string;
|
|
634
614
|
/**
|
|
@@ -639,8 +619,8 @@ export interface CodeError {
|
|
|
639
619
|
}
|
|
640
620
|
/**
|
|
641
621
|
* @public
|
|
642
|
-
* <p>Provides further details for the reason behind the bad request. For reason type
|
|
643
|
-
*
|
|
622
|
+
* <p>Provides further details for the reason behind the bad request. For reason type <code>CODE_ERROR</code>, the
|
|
623
|
+
* detail will contain a list of code errors.</p>
|
|
644
624
|
*/
|
|
645
625
|
export interface BadRequestDetail {
|
|
646
626
|
/**
|
|
@@ -662,8 +642,8 @@ export declare const BadRequestReason: {
|
|
|
662
642
|
export type BadRequestReason = (typeof BadRequestReason)[keyof typeof BadRequestReason];
|
|
663
643
|
/**
|
|
664
644
|
* @public
|
|
665
|
-
* <p>The request is not well formed. For example, a value is invalid or a required field is
|
|
666
|
-
*
|
|
645
|
+
* <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
|
|
646
|
+
* field values, and then try again.</p>
|
|
667
647
|
*/
|
|
668
648
|
export declare class BadRequestException extends __BaseException {
|
|
669
649
|
readonly name: "BadRequestException";
|
|
@@ -671,13 +651,13 @@ export declare class BadRequestException extends __BaseException {
|
|
|
671
651
|
/**
|
|
672
652
|
* @public
|
|
673
653
|
* <p>Provides context for the cause of the bad request. The only supported value is
|
|
674
|
-
*
|
|
654
|
+
* <code>CODE_ERROR</code>.</p>
|
|
675
655
|
*/
|
|
676
656
|
reason?: BadRequestReason;
|
|
677
657
|
/**
|
|
678
658
|
* @public
|
|
679
|
-
* <p>Provides further details for the reason behind the bad request. For reason type
|
|
680
|
-
*
|
|
659
|
+
* <p>Provides further details for the reason behind the bad request. For reason type <code>CODE_ERROR</code>, the
|
|
660
|
+
* detail will contain a list of code errors.</p>
|
|
681
661
|
*/
|
|
682
662
|
detail?: BadRequestDetail;
|
|
683
663
|
/**
|
|
@@ -699,8 +679,7 @@ export declare class InternalFailureException extends __BaseException {
|
|
|
699
679
|
}
|
|
700
680
|
/**
|
|
701
681
|
* @public
|
|
702
|
-
* <p>The resource specified in the request was not found. Check the resource, and then try
|
|
703
|
-
* again.</p>
|
|
682
|
+
* <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
|
|
704
683
|
*/
|
|
705
684
|
export declare class NotFoundException extends __BaseException {
|
|
706
685
|
readonly name: "NotFoundException";
|
|
@@ -751,7 +730,9 @@ export interface AssociateMergedGraphqlApiRequest {
|
|
|
751
730
|
sourceApiIdentifier: string | undefined;
|
|
752
731
|
/**
|
|
753
732
|
* @public
|
|
754
|
-
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
|
|
733
|
+
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
|
|
734
|
+
* APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs
|
|
735
|
+
* in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
|
|
755
736
|
*/
|
|
756
737
|
mergedApiIdentifier: string | undefined;
|
|
757
738
|
/**
|
|
@@ -786,12 +767,12 @@ export type SourceApiAssociationStatus = (typeof SourceApiAssociationStatus)[key
|
|
|
786
767
|
/**
|
|
787
768
|
* @public
|
|
788
769
|
* <p>Describes the configuration of a source API. A source API is a GraphQL API that is linked to a merged API.
|
|
789
|
-
* There can be multiple source APIs attached to each merged API.
|
|
790
|
-
*
|
|
791
|
-
* </p>
|
|
792
|
-
* <p>Source APIs can originate from your account or from other accounts via Amazon Web Services Resource Access
|
|
793
|
-
* information about sharing resources from other accounts, see <a href="https://docs.aws.amazon.com/ram/latest/userguide/what-is.html">What is Amazon Web Services Resource
|
|
794
|
-
* Manager?</a> in the <i>Amazon Web Services Resource Access Manager</i> guide.</p>
|
|
770
|
+
* There can be multiple source APIs attached to each merged API. When linked to a merged API, the source API's
|
|
771
|
+
* schema, data sources, and resolvers will be combined with other linked source API data to form a new, singular
|
|
772
|
+
* API. </p>
|
|
773
|
+
* <p>Source APIs can originate from your account or from other accounts via Amazon Web Services Resource Access
|
|
774
|
+
* Manager. For more information about sharing resources from other accounts, see <a href="https://docs.aws.amazon.com/ram/latest/userguide/what-is.html">What is Amazon Web Services Resource
|
|
775
|
+
* Access Manager?</a> in the <i>Amazon Web Services Resource Access Manager</i> guide.</p>
|
|
795
776
|
*/
|
|
796
777
|
export interface SourceApiAssociation {
|
|
797
778
|
/**
|
|
@@ -863,8 +844,8 @@ export interface AssociateMergedGraphqlApiResponse {
|
|
|
863
844
|
}
|
|
864
845
|
/**
|
|
865
846
|
* @public
|
|
866
|
-
* <p>Another modification is in progress at this time and it must complete before you can
|
|
867
|
-
*
|
|
847
|
+
* <p>Another modification is in progress at this time and it must complete before you can make your
|
|
848
|
+
* change.</p>
|
|
868
849
|
*/
|
|
869
850
|
export declare class ConcurrentModificationException extends __BaseException {
|
|
870
851
|
readonly name: "ConcurrentModificationException";
|
|
@@ -904,7 +885,9 @@ export declare class UnauthorizedException extends __BaseException {
|
|
|
904
885
|
export interface AssociateSourceGraphqlApiRequest {
|
|
905
886
|
/**
|
|
906
887
|
* @public
|
|
907
|
-
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
|
|
888
|
+
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
|
|
889
|
+
* APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs
|
|
890
|
+
* in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
|
|
908
891
|
*/
|
|
909
892
|
mergedApiIdentifier: string | undefined;
|
|
910
893
|
/**
|
|
@@ -973,8 +956,8 @@ export interface AuthorizationConfig {
|
|
|
973
956
|
* <ul>
|
|
974
957
|
* <li>
|
|
975
958
|
* <p>
|
|
976
|
-
* <b>AWS_IAM</b>: The authorization type is Signature
|
|
977
|
-
*
|
|
959
|
+
* <b>AWS_IAM</b>: The authorization type is Signature Version 4
|
|
960
|
+
* (SigV4).</p>
|
|
978
961
|
* </li>
|
|
979
962
|
* </ul>
|
|
980
963
|
*/
|
|
@@ -1003,8 +986,7 @@ export interface CreateApiCacheRequest {
|
|
|
1003
986
|
ttl: number | undefined;
|
|
1004
987
|
/**
|
|
1005
988
|
* @public
|
|
1006
|
-
* <p>Transit encryption flag when connecting to cache. You cannot update this setting after
|
|
1007
|
-
* creation.</p>
|
|
989
|
+
* <p>Transit encryption flag when connecting to cache. You cannot update this setting after creation.</p>
|
|
1008
990
|
*/
|
|
1009
991
|
transitEncryptionEnabled?: boolean;
|
|
1010
992
|
/**
|
|
@@ -1018,13 +1000,12 @@ export interface CreateApiCacheRequest {
|
|
|
1018
1000
|
* <ul>
|
|
1019
1001
|
* <li>
|
|
1020
1002
|
* <p>
|
|
1021
|
-
* <b>FULL_REQUEST_CACHING</b>: All requests are fully
|
|
1022
|
-
* cached.</p>
|
|
1003
|
+
* <b>FULL_REQUEST_CACHING</b>: All requests are fully cached.</p>
|
|
1023
1004
|
* </li>
|
|
1024
1005
|
* <li>
|
|
1025
1006
|
* <p>
|
|
1026
|
-
* <b>PER_RESOLVER_CACHING</b>: Individual resolvers
|
|
1027
|
-
*
|
|
1007
|
+
* <b>PER_RESOLVER_CACHING</b>: Individual resolvers that you specify are
|
|
1008
|
+
* cached.</p>
|
|
1028
1009
|
* </li>
|
|
1029
1010
|
* </ul>
|
|
1030
1011
|
*/
|
|
@@ -1135,9 +1116,9 @@ export interface CreateApiKeyRequest {
|
|
|
1135
1116
|
description?: string;
|
|
1136
1117
|
/**
|
|
1137
1118
|
* @public
|
|
1138
|
-
* <p>From the creation time, the time after which the API key expires. The date is
|
|
1139
|
-
*
|
|
1140
|
-
*
|
|
1119
|
+
* <p>From the creation time, the time after which the API key expires. The date is represented as seconds since
|
|
1120
|
+
* the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time.
|
|
1121
|
+
* For more information, see .</p>
|
|
1141
1122
|
*/
|
|
1142
1123
|
expires?: number;
|
|
1143
1124
|
}
|
|
@@ -1168,8 +1149,7 @@ export interface DeltaSyncConfig {
|
|
|
1168
1149
|
deltaSyncTableName?: string;
|
|
1169
1150
|
/**
|
|
1170
1151
|
* @public
|
|
1171
|
-
* <p>The number of minutes that a Delta Sync log entry is stored in the Delta Sync
|
|
1172
|
-
* table.</p>
|
|
1152
|
+
* <p>The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.</p>
|
|
1173
1153
|
*/
|
|
1174
1154
|
deltaSyncTableTTL?: number;
|
|
1175
1155
|
}
|
|
@@ -1207,9 +1187,8 @@ export interface DynamodbDataSourceConfig {
|
|
|
1207
1187
|
/**
|
|
1208
1188
|
* @public
|
|
1209
1189
|
* <p>Describes an OpenSearch data source configuration.</p>
|
|
1210
|
-
* <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This
|
|
1211
|
-
*
|
|
1212
|
-
* source.</p>
|
|
1190
|
+
* <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is
|
|
1191
|
+
* deprecated. For new data sources, use <a>OpenSearchServiceDataSourceConfig</a> to specify an OpenSearch data source.</p>
|
|
1213
1192
|
*/
|
|
1214
1193
|
export interface ElasticsearchDataSourceConfig {
|
|
1215
1194
|
/**
|
|
@@ -1230,8 +1209,8 @@ export interface ElasticsearchDataSourceConfig {
|
|
|
1230
1209
|
export interface EventBridgeDataSourceConfig {
|
|
1231
1210
|
/**
|
|
1232
1211
|
* @public
|
|
1233
|
-
* <p>The ARN of the event bus. For more information about event buses, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html">Amazon
|
|
1234
|
-
*
|
|
1212
|
+
* <p>The ARN of the event bus. For more information about event buses, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html">Amazon EventBridge event
|
|
1213
|
+
* buses</a>.</p>
|
|
1235
1214
|
*/
|
|
1236
1215
|
eventBusArn: string | undefined;
|
|
1237
1216
|
}
|
|
@@ -1242,10 +1221,9 @@ export interface EventBridgeDataSourceConfig {
|
|
|
1242
1221
|
export interface HttpDataSourceConfig {
|
|
1243
1222
|
/**
|
|
1244
1223
|
* @public
|
|
1245
|
-
* <p>The HTTP URL endpoint. You can specify either the domain name or IP, and port
|
|
1246
|
-
*
|
|
1247
|
-
*
|
|
1248
|
-
* HTTPS endpoints.</p>
|
|
1224
|
+
* <p>The HTTP URL endpoint. You can specify either the domain name or IP, and port combination, and the URL
|
|
1225
|
+
* scheme must be HTTP or HTTPS. If you don't specify the port, AppSync uses the default port 80
|
|
1226
|
+
* for the HTTP endpoint and port 443 for HTTPS endpoints.</p>
|
|
1249
1227
|
*/
|
|
1250
1228
|
endpoint?: string;
|
|
1251
1229
|
/**
|
|
@@ -1308,8 +1286,7 @@ export interface RdsHttpEndpointConfig {
|
|
|
1308
1286
|
schema?: string;
|
|
1309
1287
|
/**
|
|
1310
1288
|
* @public
|
|
1311
|
-
* <p>Amazon Web Services secret store Amazon Resource Name (ARN) for database
|
|
1312
|
-
* credentials.</p>
|
|
1289
|
+
* <p>Amazon Web Services secret store Amazon Resource Name (ARN) for database credentials.</p>
|
|
1313
1290
|
*/
|
|
1314
1291
|
awsSecretStoreArn?: string;
|
|
1315
1292
|
}
|
|
@@ -1335,9 +1312,8 @@ export interface RelationalDatabaseDataSourceConfig {
|
|
|
1335
1312
|
* <ul>
|
|
1336
1313
|
* <li>
|
|
1337
1314
|
* <p>
|
|
1338
|
-
* <b>RDS_HTTP_ENDPOINT</b>: The relational database
|
|
1339
|
-
*
|
|
1340
|
-
* endpoint.</p>
|
|
1315
|
+
* <b>RDS_HTTP_ENDPOINT</b>: The relational database source type is an
|
|
1316
|
+
* Amazon Relational Database Service (Amazon RDS) HTTP endpoint.</p>
|
|
1341
1317
|
* </li>
|
|
1342
1318
|
* </ul>
|
|
1343
1319
|
*/
|
|
@@ -1392,8 +1368,8 @@ export interface CreateDataSourceRequest {
|
|
|
1392
1368
|
type: DataSourceType | undefined;
|
|
1393
1369
|
/**
|
|
1394
1370
|
* @public
|
|
1395
|
-
* <p>The Identity and Access Management (IAM) service role Amazon Resource Name (ARN)
|
|
1396
|
-
*
|
|
1371
|
+
* <p>The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.
|
|
1372
|
+
* The system assumes this role when accessing the data source.</p>
|
|
1397
1373
|
*/
|
|
1398
1374
|
serviceRoleArn?: string;
|
|
1399
1375
|
/**
|
|
@@ -1409,8 +1385,9 @@ export interface CreateDataSourceRequest {
|
|
|
1409
1385
|
/**
|
|
1410
1386
|
* @public
|
|
1411
1387
|
* <p>Amazon OpenSearch Service settings.</p>
|
|
1412
|
-
* <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This
|
|
1413
|
-
*
|
|
1388
|
+
* <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is
|
|
1389
|
+
* deprecated. For new data sources, use <a>CreateDataSourceRequest$openSearchServiceConfig</a> to
|
|
1390
|
+
* create an OpenSearch data source.</p>
|
|
1414
1391
|
*/
|
|
1415
1392
|
elasticsearchConfig?: ElasticsearchDataSourceConfig;
|
|
1416
1393
|
/**
|
|
@@ -1460,51 +1437,50 @@ export interface DataSource {
|
|
|
1460
1437
|
* <ul>
|
|
1461
1438
|
* <li>
|
|
1462
1439
|
* <p>
|
|
1463
|
-
* <b>AWS_LAMBDA</b>: The data source is an Lambda
|
|
1440
|
+
* <b>AWS_LAMBDA</b>: The data source is an Lambda
|
|
1441
|
+
* function.</p>
|
|
1464
1442
|
* </li>
|
|
1465
1443
|
* <li>
|
|
1466
1444
|
* <p>
|
|
1467
|
-
* <b>AMAZON_DYNAMODB</b>: The data source is an Amazon DynamoDB
|
|
1445
|
+
* <b>AMAZON_DYNAMODB</b>: The data source is an Amazon DynamoDB
|
|
1446
|
+
* table.</p>
|
|
1468
1447
|
* </li>
|
|
1469
1448
|
* <li>
|
|
1470
1449
|
* <p>
|
|
1471
|
-
* <b>AMAZON_ELASTICSEARCH</b>: The data source is an
|
|
1472
|
-
*
|
|
1450
|
+
* <b>AMAZON_ELASTICSEARCH</b>: The data source is an Amazon OpenSearch Service
|
|
1451
|
+
* domain.</p>
|
|
1473
1452
|
* </li>
|
|
1474
1453
|
* <li>
|
|
1475
1454
|
* <p>
|
|
1476
|
-
* <b>AMAZON_OPENSEARCH_SERVICE</b>: The data source is
|
|
1477
|
-
* an Amazon OpenSearch Service domain.</p>
|
|
1455
|
+
* <b>AMAZON_OPENSEARCH_SERVICE</b>: The data source is an Amazon OpenSearch Service domain.</p>
|
|
1478
1456
|
* </li>
|
|
1479
1457
|
* <li>
|
|
1480
1458
|
* <p>
|
|
1481
|
-
* <b>AMAZON_EVENTBRIDGE</b>: The data source is an
|
|
1482
|
-
*
|
|
1459
|
+
* <b>AMAZON_EVENTBRIDGE</b>: The data source is an Amazon EventBridge
|
|
1460
|
+
* configuration.</p>
|
|
1483
1461
|
* </li>
|
|
1484
1462
|
* <li>
|
|
1485
1463
|
* <p>
|
|
1486
|
-
* <b>NONE</b>: There is no data source. Use this type
|
|
1487
|
-
*
|
|
1488
|
-
*
|
|
1489
|
-
* subscription from a mutation.</p>
|
|
1464
|
+
* <b>NONE</b>: There is no data source. Use this type when you want to
|
|
1465
|
+
* invoke a GraphQL operation without connecting to a data source, such as when you're performing data
|
|
1466
|
+
* transformation with resolvers or invoking a subscription from a mutation.</p>
|
|
1490
1467
|
* </li>
|
|
1491
1468
|
* <li>
|
|
1492
1469
|
* <p>
|
|
1493
|
-
* <b>HTTP</b>: The data source is an HTTP
|
|
1494
|
-
* endpoint.</p>
|
|
1470
|
+
* <b>HTTP</b>: The data source is an HTTP endpoint.</p>
|
|
1495
1471
|
* </li>
|
|
1496
1472
|
* <li>
|
|
1497
1473
|
* <p>
|
|
1498
|
-
* <b>RELATIONAL_DATABASE</b>: The data source is a
|
|
1499
|
-
*
|
|
1474
|
+
* <b>RELATIONAL_DATABASE</b>: The data source is a relational
|
|
1475
|
+
* database.</p>
|
|
1500
1476
|
* </li>
|
|
1501
1477
|
* </ul>
|
|
1502
1478
|
*/
|
|
1503
1479
|
type?: DataSourceType;
|
|
1504
1480
|
/**
|
|
1505
1481
|
* @public
|
|
1506
|
-
* <p>The Identity and Access Management (IAM) service role Amazon Resource Name (ARN)
|
|
1507
|
-
*
|
|
1482
|
+
* <p>The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.
|
|
1483
|
+
* The system assumes this role when accessing the data source.</p>
|
|
1508
1484
|
*/
|
|
1509
1485
|
serviceRoleArn?: string;
|
|
1510
1486
|
/**
|
|
@@ -1564,9 +1540,7 @@ export interface CreateDomainNameRequest {
|
|
|
1564
1540
|
domainName: string | undefined;
|
|
1565
1541
|
/**
|
|
1566
1542
|
* @public
|
|
1567
|
-
* <p>The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager
|
|
1568
|
-
* (ACM) certificate or an Identity and Access Management (IAM)
|
|
1569
|
-
* server certificate.</p>
|
|
1543
|
+
* <p>The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.</p>
|
|
1570
1544
|
*/
|
|
1571
1545
|
certificateArn: string | undefined;
|
|
1572
1546
|
/**
|
|
@@ -1592,9 +1566,7 @@ export interface DomainNameConfig {
|
|
|
1592
1566
|
description?: string;
|
|
1593
1567
|
/**
|
|
1594
1568
|
* @public
|
|
1595
|
-
* <p>The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager
|
|
1596
|
-
* (ACM) certificate or an Identity and Access Management (IAM)
|
|
1597
|
-
* server certificate.</p>
|
|
1569
|
+
* <p>The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.</p>
|
|
1598
1570
|
*/
|
|
1599
1571
|
certificateArn?: string;
|
|
1600
1572
|
/**
|
|
@@ -1646,22 +1618,21 @@ export declare const ConflictHandlerType: {
|
|
|
1646
1618
|
export type ConflictHandlerType = (typeof ConflictHandlerType)[keyof typeof ConflictHandlerType];
|
|
1647
1619
|
/**
|
|
1648
1620
|
* @public
|
|
1649
|
-
* <p>The <code>LambdaConflictHandlerConfig</code> object when configuring <code>LAMBDA</code>
|
|
1650
|
-
*
|
|
1621
|
+
* <p>The <code>LambdaConflictHandlerConfig</code> object when configuring <code>LAMBDA</code> as the Conflict
|
|
1622
|
+
* Handler.</p>
|
|
1651
1623
|
*/
|
|
1652
1624
|
export interface LambdaConflictHandlerConfig {
|
|
1653
1625
|
/**
|
|
1654
1626
|
* @public
|
|
1655
|
-
* <p>The Amazon Resource Name (ARN) for the Lambda function to use as the
|
|
1656
|
-
* Conflict Handler.</p>
|
|
1627
|
+
* <p>The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.</p>
|
|
1657
1628
|
*/
|
|
1658
1629
|
lambdaConflictHandlerArn?: string;
|
|
1659
1630
|
}
|
|
1660
1631
|
/**
|
|
1661
1632
|
* @public
|
|
1662
1633
|
* <p>Describes a Sync configuration for a resolver.</p>
|
|
1663
|
-
* <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the
|
|
1664
|
-
*
|
|
1634
|
+
* <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is
|
|
1635
|
+
* invoked.</p>
|
|
1665
1636
|
*/
|
|
1666
1637
|
export interface SyncConfig {
|
|
1667
1638
|
/**
|
|
@@ -1670,19 +1641,18 @@ export interface SyncConfig {
|
|
|
1670
1641
|
* <ul>
|
|
1671
1642
|
* <li>
|
|
1672
1643
|
* <p>
|
|
1673
|
-
* <b>OPTIMISTIC_CONCURRENCY</b>: Resolve conflicts by
|
|
1674
|
-
*
|
|
1675
|
-
* server.</p>
|
|
1644
|
+
* <b>OPTIMISTIC_CONCURRENCY</b>: Resolve conflicts by rejecting mutations
|
|
1645
|
+
* when versions don't match the latest version at the server.</p>
|
|
1676
1646
|
* </li>
|
|
1677
1647
|
* <li>
|
|
1678
1648
|
* <p>
|
|
1679
|
-
* <b>AUTOMERGE</b>: Resolve conflicts with the
|
|
1680
|
-
*
|
|
1649
|
+
* <b>AUTOMERGE</b>: Resolve conflicts with the Automerge conflict
|
|
1650
|
+
* resolution strategy.</p>
|
|
1681
1651
|
* </li>
|
|
1682
1652
|
* <li>
|
|
1683
1653
|
* <p>
|
|
1684
|
-
* <b>LAMBDA</b>: Resolve conflicts with an Lambda function
|
|
1685
|
-
* <code>LambdaConflictHandlerConfig</code>.</p>
|
|
1654
|
+
* <b>LAMBDA</b>: Resolve conflicts with an Lambda function
|
|
1655
|
+
* supplied in the <code>LambdaConflictHandlerConfig</code>.</p>
|
|
1686
1656
|
* </li>
|
|
1687
1657
|
* </ul>
|
|
1688
1658
|
*/
|
|
@@ -1693,21 +1663,21 @@ export interface SyncConfig {
|
|
|
1693
1663
|
* <ul>
|
|
1694
1664
|
* <li>
|
|
1695
1665
|
* <p>
|
|
1696
|
-
* <b>VERSION</b>: Detect conflicts based on object
|
|
1697
|
-
*
|
|
1666
|
+
* <b>VERSION</b>: Detect conflicts based on object versions for this
|
|
1667
|
+
* resolver.</p>
|
|
1698
1668
|
* </li>
|
|
1699
1669
|
* <li>
|
|
1700
1670
|
* <p>
|
|
1701
|
-
* <b>NONE</b>: Do not detect conflicts when invoking
|
|
1702
|
-
*
|
|
1671
|
+
* <b>NONE</b>: Do not detect conflicts when invoking this
|
|
1672
|
+
* resolver.</p>
|
|
1703
1673
|
* </li>
|
|
1704
1674
|
* </ul>
|
|
1705
1675
|
*/
|
|
1706
1676
|
conflictDetection?: ConflictDetectionType;
|
|
1707
1677
|
/**
|
|
1708
1678
|
* @public
|
|
1709
|
-
* <p>The <code>LambdaConflictHandlerConfig</code> when configuring <code>LAMBDA</code> as the
|
|
1710
|
-
*
|
|
1679
|
+
* <p>The <code>LambdaConflictHandlerConfig</code> when configuring <code>LAMBDA</code> as the Conflict
|
|
1680
|
+
* Handler.</p>
|
|
1711
1681
|
*/
|
|
1712
1682
|
lambdaConflictHandlerConfig?: LambdaConflictHandlerConfig;
|
|
1713
1683
|
}
|
|
@@ -1738,8 +1708,8 @@ export interface CreateFunctionRequest {
|
|
|
1738
1708
|
dataSourceName: string | undefined;
|
|
1739
1709
|
/**
|
|
1740
1710
|
* @public
|
|
1741
|
-
* <p>The <code>Function</code> request mapping template. Functions support only the
|
|
1742
|
-
*
|
|
1711
|
+
* <p>The <code>Function</code> request mapping template. Functions support only the 2018-05-29 version of the
|
|
1712
|
+
* request mapping template.</p>
|
|
1743
1713
|
*/
|
|
1744
1714
|
requestMappingTemplate?: string;
|
|
1745
1715
|
/**
|
|
@@ -1749,16 +1719,15 @@ export interface CreateFunctionRequest {
|
|
|
1749
1719
|
responseMappingTemplate?: string;
|
|
1750
1720
|
/**
|
|
1751
1721
|
* @public
|
|
1752
|
-
* <p>The <code>version</code> of the request mapping template. Currently, the supported value
|
|
1753
|
-
*
|
|
1754
|
-
* <code>functionVersion</code> is required.</p>
|
|
1722
|
+
* <p>The <code>version</code> of the request mapping template. Currently, the supported value is 2018-05-29. Note
|
|
1723
|
+
* that when using VTL and mapping templates, the <code>functionVersion</code> is required.</p>
|
|
1755
1724
|
*/
|
|
1756
1725
|
functionVersion?: string;
|
|
1757
1726
|
/**
|
|
1758
1727
|
* @public
|
|
1759
1728
|
* <p>Describes a Sync configuration for a resolver.</p>
|
|
1760
|
-
* <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the
|
|
1761
|
-
*
|
|
1729
|
+
* <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is
|
|
1730
|
+
* invoked.</p>
|
|
1762
1731
|
*/
|
|
1763
1732
|
syncConfig?: SyncConfig;
|
|
1764
1733
|
/**
|
|
@@ -1768,22 +1737,21 @@ export interface CreateFunctionRequest {
|
|
|
1768
1737
|
maxBatchSize?: number;
|
|
1769
1738
|
/**
|
|
1770
1739
|
* @public
|
|
1771
|
-
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
1772
|
-
* that if a runtime is specified, code must
|
|
1740
|
+
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
1741
|
+
* function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must
|
|
1742
|
+
* also be specified.</p>
|
|
1773
1743
|
*/
|
|
1774
1744
|
runtime?: AppSyncRuntime;
|
|
1775
1745
|
/**
|
|
1776
1746
|
* @public
|
|
1777
|
-
* <p>The <code>function</code> code that contains the request and response functions. When
|
|
1778
|
-
*
|
|
1779
|
-
* <code>APPSYNC_JS</code>.</p>
|
|
1747
|
+
* <p>The <code>function</code> code that contains the request and response functions. When code is used, the
|
|
1748
|
+
* <code>runtime</code> is required. The <code>runtime</code> value must be <code>APPSYNC_JS</code>.</p>
|
|
1780
1749
|
*/
|
|
1781
1750
|
code?: string;
|
|
1782
1751
|
}
|
|
1783
1752
|
/**
|
|
1784
1753
|
* @public
|
|
1785
|
-
* <p>A function is a reusable entity. You can use multiple functions to compose the resolver
|
|
1786
|
-
* logic.</p>
|
|
1754
|
+
* <p>A function is a reusable entity. You can use multiple functions to compose the resolver logic.</p>
|
|
1787
1755
|
*/
|
|
1788
1756
|
export interface FunctionConfiguration {
|
|
1789
1757
|
/**
|
|
@@ -1813,8 +1781,8 @@ export interface FunctionConfiguration {
|
|
|
1813
1781
|
dataSourceName?: string;
|
|
1814
1782
|
/**
|
|
1815
1783
|
* @public
|
|
1816
|
-
* <p>The <code>Function</code> request mapping template. Functions support only the
|
|
1817
|
-
*
|
|
1784
|
+
* <p>The <code>Function</code> request mapping template. Functions support only the 2018-05-29 version of the
|
|
1785
|
+
* request mapping template.</p>
|
|
1818
1786
|
*/
|
|
1819
1787
|
requestMappingTemplate?: string;
|
|
1820
1788
|
/**
|
|
@@ -1824,15 +1792,15 @@ export interface FunctionConfiguration {
|
|
|
1824
1792
|
responseMappingTemplate?: string;
|
|
1825
1793
|
/**
|
|
1826
1794
|
* @public
|
|
1827
|
-
* <p>The version of the request mapping template. Currently, only the 2018-05-29 version of
|
|
1828
|
-
*
|
|
1795
|
+
* <p>The version of the request mapping template. Currently, only the 2018-05-29 version of the template is
|
|
1796
|
+
* supported.</p>
|
|
1829
1797
|
*/
|
|
1830
1798
|
functionVersion?: string;
|
|
1831
1799
|
/**
|
|
1832
1800
|
* @public
|
|
1833
1801
|
* <p>Describes a Sync configuration for a resolver.</p>
|
|
1834
|
-
* <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the
|
|
1835
|
-
*
|
|
1802
|
+
* <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is
|
|
1803
|
+
* invoked.</p>
|
|
1836
1804
|
*/
|
|
1837
1805
|
syncConfig?: SyncConfig;
|
|
1838
1806
|
/**
|
|
@@ -1842,15 +1810,15 @@ export interface FunctionConfiguration {
|
|
|
1842
1810
|
maxBatchSize?: number;
|
|
1843
1811
|
/**
|
|
1844
1812
|
* @public
|
|
1845
|
-
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
1846
|
-
* that if a runtime is specified, code must
|
|
1813
|
+
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
1814
|
+
* function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must
|
|
1815
|
+
* also be specified.</p>
|
|
1847
1816
|
*/
|
|
1848
1817
|
runtime?: AppSyncRuntime;
|
|
1849
1818
|
/**
|
|
1850
1819
|
* @public
|
|
1851
|
-
* <p>The <code>function</code> code that contains the request and response functions. When
|
|
1852
|
-
*
|
|
1853
|
-
* <code>APPSYNC_JS</code>.</p>
|
|
1820
|
+
* <p>The <code>function</code> code that contains the request and response functions. When code is used, the
|
|
1821
|
+
* <code>runtime</code> is required. The <code>runtime</code> value must be <code>APPSYNC_JS</code>.</p>
|
|
1854
1822
|
*/
|
|
1855
1823
|
code?: string;
|
|
1856
1824
|
}
|
|
@@ -1876,6 +1844,18 @@ export declare const GraphQLApiType: {
|
|
|
1876
1844
|
* @public
|
|
1877
1845
|
*/
|
|
1878
1846
|
export type GraphQLApiType = (typeof GraphQLApiType)[keyof typeof GraphQLApiType];
|
|
1847
|
+
/**
|
|
1848
|
+
* @public
|
|
1849
|
+
* @enum
|
|
1850
|
+
*/
|
|
1851
|
+
export declare const GraphQLApiIntrospectionConfig: {
|
|
1852
|
+
readonly DISABLED: "DISABLED";
|
|
1853
|
+
readonly ENABLED: "ENABLED";
|
|
1854
|
+
};
|
|
1855
|
+
/**
|
|
1856
|
+
* @public
|
|
1857
|
+
*/
|
|
1858
|
+
export type GraphQLApiIntrospectionConfig = (typeof GraphQLApiIntrospectionConfig)[keyof typeof GraphQLApiIntrospectionConfig];
|
|
1879
1859
|
/**
|
|
1880
1860
|
* @public
|
|
1881
1861
|
* @enum
|
|
@@ -1900,13 +1880,12 @@ export interface LogConfig {
|
|
|
1900
1880
|
* <ul>
|
|
1901
1881
|
* <li>
|
|
1902
1882
|
* <p>
|
|
1903
|
-
* <b>NONE</b>: No field-level logs are
|
|
1904
|
-
* captured.</p>
|
|
1883
|
+
* <b>NONE</b>: No field-level logs are captured.</p>
|
|
1905
1884
|
* </li>
|
|
1906
1885
|
* <li>
|
|
1907
1886
|
* <p>
|
|
1908
|
-
* <b>ERROR</b>: Logs the following information only for
|
|
1909
|
-
*
|
|
1887
|
+
* <b>ERROR</b>: Logs the following information only for the fields that are
|
|
1888
|
+
* in error:</p>
|
|
1910
1889
|
* <ul>
|
|
1911
1890
|
* <li>
|
|
1912
1891
|
* <p>The error section in the server response.</p>
|
|
@@ -1915,22 +1894,20 @@ export interface LogConfig {
|
|
|
1915
1894
|
* <p>Field-level errors.</p>
|
|
1916
1895
|
* </li>
|
|
1917
1896
|
* <li>
|
|
1918
|
-
* <p>The generated request/response functions that got resolved for error
|
|
1919
|
-
* fields.</p>
|
|
1897
|
+
* <p>The generated request/response functions that got resolved for error fields.</p>
|
|
1920
1898
|
* </li>
|
|
1921
1899
|
* </ul>
|
|
1922
1900
|
* </li>
|
|
1923
1901
|
* <li>
|
|
1924
1902
|
* <p>
|
|
1925
|
-
* <b>ALL</b>: The following information is logged for
|
|
1926
|
-
*
|
|
1903
|
+
* <b>ALL</b>: The following information is logged for all fields in the
|
|
1904
|
+
* query:</p>
|
|
1927
1905
|
* <ul>
|
|
1928
1906
|
* <li>
|
|
1929
1907
|
* <p>Field-level tracing information.</p>
|
|
1930
1908
|
* </li>
|
|
1931
1909
|
* <li>
|
|
1932
|
-
* <p>The generated request/response functions that got resolved for each
|
|
1933
|
-
* field.</p>
|
|
1910
|
+
* <p>The generated request/response functions that got resolved for each field.</p>
|
|
1934
1911
|
* </li>
|
|
1935
1912
|
* </ul>
|
|
1936
1913
|
* </li>
|
|
@@ -1939,14 +1916,14 @@ export interface LogConfig {
|
|
|
1939
1916
|
fieldLogLevel: FieldLogLevel | undefined;
|
|
1940
1917
|
/**
|
|
1941
1918
|
* @public
|
|
1942
|
-
* <p>The service role that AppSync assumes to publish to CloudWatch
|
|
1943
|
-
*
|
|
1919
|
+
* <p>The service role that AppSync assumes to publish to CloudWatch logs in your
|
|
1920
|
+
* account.</p>
|
|
1944
1921
|
*/
|
|
1945
1922
|
cloudWatchLogsRoleArn: string | undefined;
|
|
1946
1923
|
/**
|
|
1947
1924
|
* @public
|
|
1948
|
-
* <p>Set to TRUE to exclude sections that contain information such as headers, context, and
|
|
1949
|
-
*
|
|
1925
|
+
* <p>Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping
|
|
1926
|
+
* templates, regardless of logging level.</p>
|
|
1950
1927
|
*/
|
|
1951
1928
|
excludeVerboseContent?: boolean;
|
|
1952
1929
|
}
|
|
@@ -1979,14 +1956,14 @@ export interface UserPoolConfig {
|
|
|
1979
1956
|
awsRegion: string | undefined;
|
|
1980
1957
|
/**
|
|
1981
1958
|
* @public
|
|
1982
|
-
* <p>The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool
|
|
1983
|
-
* configuration.</p>
|
|
1959
|
+
* <p>The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool
|
|
1960
|
+
* authentication doesn't match the Amazon Cognito user pool configuration.</p>
|
|
1984
1961
|
*/
|
|
1985
1962
|
defaultAction: DefaultAction | undefined;
|
|
1986
1963
|
/**
|
|
1987
1964
|
* @public
|
|
1988
|
-
* <p>A regular expression for validating the incoming Amazon Cognito user pool app client
|
|
1989
|
-
*
|
|
1965
|
+
* <p>A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value
|
|
1966
|
+
* isn't set, no filtering is applied.</p>
|
|
1990
1967
|
*/
|
|
1991
1968
|
appIdClientRegex?: string;
|
|
1992
1969
|
}
|
|
@@ -2018,8 +1995,8 @@ export interface CreateGraphqlApiRequest {
|
|
|
2018
1995
|
logConfig?: LogConfig;
|
|
2019
1996
|
/**
|
|
2020
1997
|
* @public
|
|
2021
|
-
* <p>The authentication type: API key, Identity and Access Management (IAM), OpenID
|
|
2022
|
-
*
|
|
1998
|
+
* <p>The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC),
|
|
1999
|
+
* Amazon Cognito user pools, or Lambda.</p>
|
|
2023
2000
|
*/
|
|
2024
2001
|
authenticationType: AuthenticationType | undefined;
|
|
2025
2002
|
/**
|
|
@@ -2039,14 +2016,12 @@ export interface CreateGraphqlApiRequest {
|
|
|
2039
2016
|
tags?: Record<string, string>;
|
|
2040
2017
|
/**
|
|
2041
2018
|
* @public
|
|
2042
|
-
* <p>A list of additional authentication providers for the <code>GraphqlApi</code>
|
|
2043
|
-
* API.</p>
|
|
2019
|
+
* <p>A list of additional authentication providers for the <code>GraphqlApi</code> API.</p>
|
|
2044
2020
|
*/
|
|
2045
2021
|
additionalAuthenticationProviders?: AdditionalAuthenticationProvider[];
|
|
2046
2022
|
/**
|
|
2047
2023
|
* @public
|
|
2048
|
-
* <p>A flag indicating whether to use X-Ray tracing for the
|
|
2049
|
-
* <code>GraphqlApi</code>.</p>
|
|
2024
|
+
* <p>A flag indicating whether to use X-Ray tracing for the <code>GraphqlApi</code>.</p>
|
|
2050
2025
|
*/
|
|
2051
2026
|
xrayEnabled?: boolean;
|
|
2052
2027
|
/**
|
|
@@ -2064,15 +2039,14 @@ export interface CreateGraphqlApiRequest {
|
|
|
2064
2039
|
/**
|
|
2065
2040
|
* @public
|
|
2066
2041
|
* <p>The value that indicates whether the GraphQL API is a standard API (<code>GRAPHQL</code>) or merged API
|
|
2067
|
-
*
|
|
2042
|
+
* (<code>MERGED</code>).</p>
|
|
2068
2043
|
*/
|
|
2069
2044
|
apiType?: GraphQLApiType;
|
|
2070
2045
|
/**
|
|
2071
2046
|
* @public
|
|
2072
|
-
* <p>The Identity and Access Management service role ARN for a merged API. The AppSync
|
|
2073
|
-
*
|
|
2074
|
-
*
|
|
2075
|
-
* automatically.</p>
|
|
2047
|
+
* <p>The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role
|
|
2048
|
+
* on behalf of the Merged API to validate access to source APIs at runtime and to prompt the
|
|
2049
|
+
* <code>AUTO_MERGE</code> to update the merged API endpoint with the source API changes automatically.</p>
|
|
2076
2050
|
*/
|
|
2077
2051
|
mergedApiExecutionRoleArn?: string;
|
|
2078
2052
|
/**
|
|
@@ -2081,6 +2055,34 @@ export interface CreateGraphqlApiRequest {
|
|
|
2081
2055
|
* <p>This field accepts any string input with a length of 0 - 256 characters.</p>
|
|
2082
2056
|
*/
|
|
2083
2057
|
ownerContact?: string;
|
|
2058
|
+
/**
|
|
2059
|
+
* @public
|
|
2060
|
+
* <p>Sets the value of the GraphQL API to enable (<code>ENABLED</code>) or disable (<code>DISABLED</code>)
|
|
2061
|
+
* introspection. If no value is provided, the introspection configuration will be set to <code>ENABLED</code> by
|
|
2062
|
+
* default. This field will produce an error if the operation attempts to use the introspection feature while this
|
|
2063
|
+
* field is disabled.</p>
|
|
2064
|
+
* <p>For more information about introspection, see <a href="https://graphql.org/learn/introspection/">GraphQL
|
|
2065
|
+
* introspection</a>.</p>
|
|
2066
|
+
*/
|
|
2067
|
+
introspectionConfig?: GraphQLApiIntrospectionConfig;
|
|
2068
|
+
/**
|
|
2069
|
+
* @public
|
|
2070
|
+
* <p>The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed
|
|
2071
|
+
* in the body of query. The default value is <code>0</code> (or unspecified), which indicates there's no depth
|
|
2072
|
+
* limit. If you set a limit, it can be between <code>1</code> and <code>75</code> nested levels. This field will
|
|
2073
|
+
* produce a limit error if the operation falls out of bounds.</p>
|
|
2074
|
+
* <p>Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error,
|
|
2075
|
+
* the error will be thrown upwards to the first nullable field available.</p>
|
|
2076
|
+
*/
|
|
2077
|
+
queryDepthLimit?: number;
|
|
2078
|
+
/**
|
|
2079
|
+
* @public
|
|
2080
|
+
* <p>The maximum number of resolvers that can be invoked in a single request. The default value is <code>0</code>
|
|
2081
|
+
* (or unspecified), which will set the limit to <code>10000</code>. When specified, the limit value can be
|
|
2082
|
+
* between <code>1</code> and <code>10000</code>. This field will produce a limit error if the operation falls out
|
|
2083
|
+
* of bounds.</p>
|
|
2084
|
+
*/
|
|
2085
|
+
resolverCountLimit?: number;
|
|
2084
2086
|
}
|
|
2085
2087
|
/**
|
|
2086
2088
|
* @public
|
|
@@ -2134,20 +2136,18 @@ export interface GraphqlApi {
|
|
|
2134
2136
|
tags?: Record<string, string>;
|
|
2135
2137
|
/**
|
|
2136
2138
|
* @public
|
|
2137
|
-
* <p>A list of additional authentication providers for the <code>GraphqlApi</code>
|
|
2138
|
-
* API.</p>
|
|
2139
|
+
* <p>A list of additional authentication providers for the <code>GraphqlApi</code> API.</p>
|
|
2139
2140
|
*/
|
|
2140
2141
|
additionalAuthenticationProviders?: AdditionalAuthenticationProvider[];
|
|
2141
2142
|
/**
|
|
2142
2143
|
* @public
|
|
2143
|
-
* <p>A flag indicating whether to use X-Ray tracing for this
|
|
2144
|
-
* <code>GraphqlApi</code>.</p>
|
|
2144
|
+
* <p>A flag indicating whether to use X-Ray tracing for this <code>GraphqlApi</code>.</p>
|
|
2145
2145
|
*/
|
|
2146
2146
|
xrayEnabled?: boolean;
|
|
2147
2147
|
/**
|
|
2148
2148
|
* @public
|
|
2149
2149
|
* <p>The ARN of the WAF access control list (ACL) associated with this
|
|
2150
|
-
*
|
|
2150
|
+
* <code>GraphqlApi</code>, if one exists.</p>
|
|
2151
2151
|
*/
|
|
2152
2152
|
wafWebAclArn?: string;
|
|
2153
2153
|
/**
|
|
@@ -2170,15 +2170,14 @@ export interface GraphqlApi {
|
|
|
2170
2170
|
/**
|
|
2171
2171
|
* @public
|
|
2172
2172
|
* <p>The value that indicates whether the GraphQL API is a standard API (<code>GRAPHQL</code>) or merged API
|
|
2173
|
-
*
|
|
2173
|
+
* (<code>MERGED</code>).</p>
|
|
2174
2174
|
*/
|
|
2175
2175
|
apiType?: GraphQLApiType;
|
|
2176
2176
|
/**
|
|
2177
2177
|
* @public
|
|
2178
|
-
* <p>The Identity and Access Management service role ARN for a merged API. The AppSync
|
|
2179
|
-
*
|
|
2180
|
-
*
|
|
2181
|
-
* automatically.</p>
|
|
2178
|
+
* <p>The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role
|
|
2179
|
+
* on behalf of the Merged API to validate access to source APIs at runtime and to prompt the
|
|
2180
|
+
* <code>AUTO_MERGE</code> to update the merged API endpoint with the source API changes automatically.</p>
|
|
2182
2181
|
*/
|
|
2183
2182
|
mergedApiExecutionRoleArn?: string;
|
|
2184
2183
|
/**
|
|
@@ -2192,6 +2191,34 @@ export interface GraphqlApi {
|
|
|
2192
2191
|
* <p>This field accepts any string input with a length of 0 - 256 characters.</p>
|
|
2193
2192
|
*/
|
|
2194
2193
|
ownerContact?: string;
|
|
2194
|
+
/**
|
|
2195
|
+
* @public
|
|
2196
|
+
* <p>Sets the value of the GraphQL API to enable (<code>ENABLED</code>) or disable (<code>DISABLED</code>)
|
|
2197
|
+
* introspection. If no value is provided, the introspection configuration will be set to <code>ENABLED</code> by
|
|
2198
|
+
* default. This field will produce an error if the operation attempts to use the introspection feature while this
|
|
2199
|
+
* field is disabled.</p>
|
|
2200
|
+
* <p>For more information about introspection, see <a href="https://graphql.org/learn/introspection/">GraphQL
|
|
2201
|
+
* introspection</a>.</p>
|
|
2202
|
+
*/
|
|
2203
|
+
introspectionConfig?: GraphQLApiIntrospectionConfig;
|
|
2204
|
+
/**
|
|
2205
|
+
* @public
|
|
2206
|
+
* <p>The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed
|
|
2207
|
+
* in the body of query. The default value is <code>0</code> (or unspecified), which indicates there's no depth
|
|
2208
|
+
* limit. If you set a limit, it can be between <code>1</code> and <code>75</code> nested levels. This field will
|
|
2209
|
+
* produce a limit error if the operation falls out of bounds.</p>
|
|
2210
|
+
* <p>Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error,
|
|
2211
|
+
* the error will be thrown upwards to the first nullable field available.</p>
|
|
2212
|
+
*/
|
|
2213
|
+
queryDepthLimit?: number;
|
|
2214
|
+
/**
|
|
2215
|
+
* @public
|
|
2216
|
+
* <p>The maximum number of resolvers that can be invoked in a single request. The default value is <code>0</code>
|
|
2217
|
+
* (or unspecified), which will set the limit to <code>10000</code>. When specified, the limit value can be
|
|
2218
|
+
* between <code>1</code> and <code>10000</code>. This field will produce a limit error if the operation falls out
|
|
2219
|
+
* of bounds.</p>
|
|
2220
|
+
*/
|
|
2221
|
+
resolverCountLimit?: number;
|
|
2195
2222
|
}
|
|
2196
2223
|
/**
|
|
2197
2224
|
* @public
|
|
@@ -2217,8 +2244,8 @@ export interface CachingConfig {
|
|
|
2217
2244
|
/**
|
|
2218
2245
|
* @public
|
|
2219
2246
|
* <p>The caching keys for a resolver that has caching activated.</p>
|
|
2220
|
-
* <p>Valid values are entries from the <code>$context.arguments</code>,
|
|
2221
|
-
* <code>$context.
|
|
2247
|
+
* <p>Valid values are entries from the <code>$context.arguments</code>, <code>$context.source</code>, and
|
|
2248
|
+
* <code>$context.identity</code> maps.</p>
|
|
2222
2249
|
*/
|
|
2223
2250
|
cachingKeys?: string[];
|
|
2224
2251
|
}
|
|
@@ -2272,12 +2299,10 @@ export interface CreateResolverRequest {
|
|
|
2272
2299
|
/**
|
|
2273
2300
|
* @public
|
|
2274
2301
|
* <p>The mapping template to use for requests.</p>
|
|
2275
|
-
* <p>A resolver uses a request mapping template to convert a GraphQL expression into a format
|
|
2276
|
-
*
|
|
2277
|
-
*
|
|
2278
|
-
*
|
|
2279
|
-
* source. For all other data sources, VTL request and response mapping templates are
|
|
2280
|
-
* required.</p>
|
|
2302
|
+
* <p>A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source
|
|
2303
|
+
* can understand. Mapping templates are written in Apache Velocity Template Language (VTL).</p>
|
|
2304
|
+
* <p>VTL request mapping templates are optional when using an Lambda data source. For all other
|
|
2305
|
+
* data sources, VTL request and response mapping templates are required.</p>
|
|
2281
2306
|
*/
|
|
2282
2307
|
requestMappingTemplate?: string;
|
|
2283
2308
|
/**
|
|
@@ -2291,16 +2316,14 @@ export interface CreateResolverRequest {
|
|
|
2291
2316
|
* <ul>
|
|
2292
2317
|
* <li>
|
|
2293
2318
|
* <p>
|
|
2294
|
-
* <b>UNIT</b>: A UNIT resolver type. A UNIT resolver is
|
|
2295
|
-
*
|
|
2296
|
-
* a single data source.</p>
|
|
2319
|
+
* <b>UNIT</b>: A UNIT resolver type. A UNIT resolver is the default
|
|
2320
|
+
* resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.</p>
|
|
2297
2321
|
* </li>
|
|
2298
2322
|
* <li>
|
|
2299
2323
|
* <p>
|
|
2300
|
-
* <b>PIPELINE</b>: A PIPELINE resolver type. You can
|
|
2301
|
-
*
|
|
2302
|
-
*
|
|
2303
|
-
* multiple data sources.</p>
|
|
2324
|
+
* <b>PIPELINE</b>: A PIPELINE resolver type. You can use a PIPELINE
|
|
2325
|
+
* resolver to invoke a series of <code>Function</code> objects in a serial manner. You can use a pipeline
|
|
2326
|
+
* resolver to run a GraphQL query against multiple data sources.</p>
|
|
2304
2327
|
* </li>
|
|
2305
2328
|
* </ul>
|
|
2306
2329
|
*/
|
|
@@ -2327,15 +2350,15 @@ export interface CreateResolverRequest {
|
|
|
2327
2350
|
maxBatchSize?: number;
|
|
2328
2351
|
/**
|
|
2329
2352
|
* @public
|
|
2330
|
-
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
2331
|
-
* that if a runtime is specified, code must
|
|
2353
|
+
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
2354
|
+
* function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must
|
|
2355
|
+
* also be specified.</p>
|
|
2332
2356
|
*/
|
|
2333
2357
|
runtime?: AppSyncRuntime;
|
|
2334
2358
|
/**
|
|
2335
2359
|
* @public
|
|
2336
|
-
* <p>The <code>resolver</code> code that contains the request and response functions. When
|
|
2337
|
-
*
|
|
2338
|
-
* <code>APPSYNC_JS</code>.</p>
|
|
2360
|
+
* <p>The <code>resolver</code> code that contains the request and response functions. When code is used, the
|
|
2361
|
+
* <code>runtime</code> is required. The <code>runtime</code> value must be <code>APPSYNC_JS</code>.</p>
|
|
2339
2362
|
*/
|
|
2340
2363
|
code?: string;
|
|
2341
2364
|
}
|
|
@@ -2380,16 +2403,14 @@ export interface Resolver {
|
|
|
2380
2403
|
* <ul>
|
|
2381
2404
|
* <li>
|
|
2382
2405
|
* <p>
|
|
2383
|
-
* <b>UNIT</b>: A UNIT resolver type. A UNIT resolver is
|
|
2384
|
-
*
|
|
2385
|
-
* a single data source.</p>
|
|
2406
|
+
* <b>UNIT</b>: A UNIT resolver type. A UNIT resolver is the default
|
|
2407
|
+
* resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.</p>
|
|
2386
2408
|
* </li>
|
|
2387
2409
|
* <li>
|
|
2388
2410
|
* <p>
|
|
2389
|
-
* <b>PIPELINE</b>: A PIPELINE resolver type. You can
|
|
2390
|
-
*
|
|
2391
|
-
*
|
|
2392
|
-
* multiple data sources.</p>
|
|
2411
|
+
* <b>PIPELINE</b>: A PIPELINE resolver type. You can use a PIPELINE
|
|
2412
|
+
* resolver to invoke a series of <code>Function</code> objects in a serial manner. You can use a pipeline
|
|
2413
|
+
* resolver to run a GraphQL query against multiple data sources.</p>
|
|
2393
2414
|
* </li>
|
|
2394
2415
|
* </ul>
|
|
2395
2416
|
*/
|
|
@@ -2416,15 +2437,15 @@ export interface Resolver {
|
|
|
2416
2437
|
maxBatchSize?: number;
|
|
2417
2438
|
/**
|
|
2418
2439
|
* @public
|
|
2419
|
-
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
2420
|
-
* that if a runtime is specified, code must
|
|
2440
|
+
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
2441
|
+
* function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must
|
|
2442
|
+
* also be specified.</p>
|
|
2421
2443
|
*/
|
|
2422
2444
|
runtime?: AppSyncRuntime;
|
|
2423
2445
|
/**
|
|
2424
2446
|
* @public
|
|
2425
|
-
* <p>The <code>resolver</code> code that contains the request and response functions. When
|
|
2426
|
-
*
|
|
2427
|
-
* <code>APPSYNC_JS</code>.</p>
|
|
2447
|
+
* <p>The <code>resolver</code> code that contains the request and response functions. When code is used, the
|
|
2448
|
+
* <code>runtime</code> is required. The <code>runtime</code> value must be <code>APPSYNC_JS</code>.</p>
|
|
2428
2449
|
*/
|
|
2429
2450
|
code?: string;
|
|
2430
2451
|
}
|
|
@@ -2713,7 +2734,9 @@ export interface DisassociateMergedGraphqlApiResponse {
|
|
|
2713
2734
|
export interface DisassociateSourceGraphqlApiRequest {
|
|
2714
2735
|
/**
|
|
2715
2736
|
* @public
|
|
2716
|
-
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
|
|
2737
|
+
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
|
|
2738
|
+
* APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs
|
|
2739
|
+
* in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
|
|
2717
2740
|
*/
|
|
2718
2741
|
mergedApiIdentifier: string | undefined;
|
|
2719
2742
|
/**
|
|
@@ -2738,27 +2761,26 @@ export interface DisassociateSourceGraphqlApiResponse {
|
|
|
2738
2761
|
export interface EvaluateCodeRequest {
|
|
2739
2762
|
/**
|
|
2740
2763
|
* @public
|
|
2741
|
-
* <p>The runtime to be used when evaluating the code. Currently, only the
|
|
2742
|
-
*
|
|
2764
|
+
* <p>The runtime to be used when evaluating the code. Currently, only the <code>APPSYNC_JS</code> runtime is
|
|
2765
|
+
* supported.</p>
|
|
2743
2766
|
*/
|
|
2744
2767
|
runtime: AppSyncRuntime | undefined;
|
|
2745
2768
|
/**
|
|
2746
2769
|
* @public
|
|
2747
|
-
* <p>The code definition to be evaluated. Note that <code>code</code> and
|
|
2748
|
-
*
|
|
2749
|
-
* must be <code>APPSYNC_JS</code>.</p>
|
|
2770
|
+
* <p>The code definition to be evaluated. Note that <code>code</code> and <code>runtime</code> are both required
|
|
2771
|
+
* for this action. The <code>runtime</code> value must be <code>APPSYNC_JS</code>.</p>
|
|
2750
2772
|
*/
|
|
2751
2773
|
code: string | undefined;
|
|
2752
2774
|
/**
|
|
2753
2775
|
* @public
|
|
2754
|
-
* <p>The map that holds all of the contextual information for your resolver invocation. A
|
|
2755
|
-
*
|
|
2776
|
+
* <p>The map that holds all of the contextual information for your resolver invocation. A <code>context</code> is
|
|
2777
|
+
* required for this action.</p>
|
|
2756
2778
|
*/
|
|
2757
2779
|
context: string | undefined;
|
|
2758
2780
|
/**
|
|
2759
2781
|
* @public
|
|
2760
|
-
* <p>The function within the code to be evaluated. If provided, the valid values are
|
|
2761
|
-
* <code>
|
|
2782
|
+
* <p>The function within the code to be evaluated. If provided, the valid values are <code>request</code> and
|
|
2783
|
+
* <code>response</code>.</p>
|
|
2762
2784
|
*/
|
|
2763
2785
|
function?: string;
|
|
2764
2786
|
}
|
|
@@ -2794,8 +2816,8 @@ export interface EvaluateCodeResponse {
|
|
|
2794
2816
|
error?: EvaluateCodeErrorDetail;
|
|
2795
2817
|
/**
|
|
2796
2818
|
* @public
|
|
2797
|
-
* <p>A list of logs that were generated by calls to <code>util.log.info</code> and
|
|
2798
|
-
*
|
|
2819
|
+
* <p>A list of logs that were generated by calls to <code>util.log.info</code> and <code>util.log.error</code> in
|
|
2820
|
+
* the evaluated code.</p>
|
|
2799
2821
|
*/
|
|
2800
2822
|
logs?: string[];
|
|
2801
2823
|
}
|
|
@@ -2805,21 +2827,21 @@ export interface EvaluateCodeResponse {
|
|
|
2805
2827
|
export interface EvaluateMappingTemplateRequest {
|
|
2806
2828
|
/**
|
|
2807
2829
|
* @public
|
|
2808
|
-
* <p>The mapping template; this can be a request or response template. A
|
|
2809
|
-
*
|
|
2830
|
+
* <p>The mapping template; this can be a request or response template. A <code>template</code> is required for
|
|
2831
|
+
* this action.</p>
|
|
2810
2832
|
*/
|
|
2811
2833
|
template: string | undefined;
|
|
2812
2834
|
/**
|
|
2813
2835
|
* @public
|
|
2814
|
-
* <p>The map that holds all of the contextual information for your resolver invocation. A
|
|
2815
|
-
*
|
|
2836
|
+
* <p>The map that holds all of the contextual information for your resolver invocation. A <code>context</code> is
|
|
2837
|
+
* required for this action.</p>
|
|
2816
2838
|
*/
|
|
2817
2839
|
context: string | undefined;
|
|
2818
2840
|
}
|
|
2819
2841
|
/**
|
|
2820
2842
|
* @public
|
|
2821
|
-
* <p>Contains the list of errors generated. When using JavaScript, this will apply to the
|
|
2822
|
-
*
|
|
2843
|
+
* <p>Contains the list of errors generated. When using JavaScript, this will apply to the request or response
|
|
2844
|
+
* function evaluation.</p>
|
|
2823
2845
|
*/
|
|
2824
2846
|
export interface ErrorDetail {
|
|
2825
2847
|
/**
|
|
@@ -2844,8 +2866,8 @@ export interface EvaluateMappingTemplateResponse {
|
|
|
2844
2866
|
error?: ErrorDetail;
|
|
2845
2867
|
/**
|
|
2846
2868
|
* @public
|
|
2847
|
-
* <p>A list of logs that were generated by calls to <code>util.log.info</code> and
|
|
2848
|
-
*
|
|
2869
|
+
* <p>A list of logs that were generated by calls to <code>util.log.info</code> and <code>util.log.error</code> in
|
|
2870
|
+
* the evaluated code.</p>
|
|
2849
2871
|
*/
|
|
2850
2872
|
logs?: string[];
|
|
2851
2873
|
}
|
|
@@ -3174,8 +3196,8 @@ export type SchemaStatus = (typeof SchemaStatus)[keyof typeof SchemaStatus];
|
|
|
3174
3196
|
export interface GetSchemaCreationStatusResponse {
|
|
3175
3197
|
/**
|
|
3176
3198
|
* @public
|
|
3177
|
-
* <p>The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When
|
|
3178
|
-
*
|
|
3199
|
+
* <p>The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the
|
|
3200
|
+
* ACTIVE state, you can add data.</p>
|
|
3179
3201
|
*/
|
|
3180
3202
|
status?: SchemaStatus;
|
|
3181
3203
|
/**
|
|
@@ -3190,7 +3212,9 @@ export interface GetSchemaCreationStatusResponse {
|
|
|
3190
3212
|
export interface GetSourceApiAssociationRequest {
|
|
3191
3213
|
/**
|
|
3192
3214
|
* @public
|
|
3193
|
-
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
|
|
3215
|
+
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
|
|
3216
|
+
* APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs
|
|
3217
|
+
* in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
|
|
3194
3218
|
*/
|
|
3195
3219
|
mergedApiIdentifier: string | undefined;
|
|
3196
3220
|
/**
|
|
@@ -3250,8 +3274,8 @@ export interface ListApiKeysRequest {
|
|
|
3250
3274
|
apiId: string | undefined;
|
|
3251
3275
|
/**
|
|
3252
3276
|
* @public
|
|
3253
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
3254
|
-
*
|
|
3277
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can use to return the
|
|
3278
|
+
* next set of items in the list.</p>
|
|
3255
3279
|
*/
|
|
3256
3280
|
nextToken?: string;
|
|
3257
3281
|
/**
|
|
@@ -3271,8 +3295,8 @@ export interface ListApiKeysResponse {
|
|
|
3271
3295
|
apiKeys?: ApiKey[];
|
|
3272
3296
|
/**
|
|
3273
3297
|
* @public
|
|
3274
|
-
* <p>An identifier to pass in the next request to this operation to return the next set of
|
|
3275
|
-
*
|
|
3298
|
+
* <p>An identifier to pass in the next request to this operation to return the next set of items in the
|
|
3299
|
+
* list.</p>
|
|
3276
3300
|
*/
|
|
3277
3301
|
nextToken?: string;
|
|
3278
3302
|
}
|
|
@@ -3287,8 +3311,8 @@ export interface ListDataSourcesRequest {
|
|
|
3287
3311
|
apiId: string | undefined;
|
|
3288
3312
|
/**
|
|
3289
3313
|
* @public
|
|
3290
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
3291
|
-
*
|
|
3314
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can use to return the
|
|
3315
|
+
* next set of items in the list.</p>
|
|
3292
3316
|
*/
|
|
3293
3317
|
nextToken?: string;
|
|
3294
3318
|
/**
|
|
@@ -3308,8 +3332,8 @@ export interface ListDataSourcesResponse {
|
|
|
3308
3332
|
dataSources?: DataSource[];
|
|
3309
3333
|
/**
|
|
3310
3334
|
* @public
|
|
3311
|
-
* <p>An identifier to pass in the next request to this operation to return the next set of
|
|
3312
|
-
*
|
|
3335
|
+
* <p>An identifier to pass in the next request to this operation to return the next set of items in the
|
|
3336
|
+
* list.</p>
|
|
3313
3337
|
*/
|
|
3314
3338
|
nextToken?: string;
|
|
3315
3339
|
}
|
|
@@ -3356,8 +3380,8 @@ export interface ListFunctionsRequest {
|
|
|
3356
3380
|
apiId: string | undefined;
|
|
3357
3381
|
/**
|
|
3358
3382
|
* @public
|
|
3359
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
3360
|
-
*
|
|
3383
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can use to return the
|
|
3384
|
+
* next set of items in the list.</p>
|
|
3361
3385
|
*/
|
|
3362
3386
|
nextToken?: string;
|
|
3363
3387
|
/**
|
|
@@ -3377,8 +3401,8 @@ export interface ListFunctionsResponse {
|
|
|
3377
3401
|
functions?: FunctionConfiguration[];
|
|
3378
3402
|
/**
|
|
3379
3403
|
* @public
|
|
3380
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
3381
|
-
*
|
|
3404
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can use to return the
|
|
3405
|
+
* next set of items in the list.</p>
|
|
3382
3406
|
*/
|
|
3383
3407
|
nextToken?: string;
|
|
3384
3408
|
}
|
|
@@ -3400,8 +3424,8 @@ export type Ownership = (typeof Ownership)[keyof typeof Ownership];
|
|
|
3400
3424
|
export interface ListGraphqlApisRequest {
|
|
3401
3425
|
/**
|
|
3402
3426
|
* @public
|
|
3403
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
3404
|
-
*
|
|
3427
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can use to return the
|
|
3428
|
+
* next set of items in the list.</p>
|
|
3405
3429
|
*/
|
|
3406
3430
|
nextToken?: string;
|
|
3407
3431
|
/**
|
|
@@ -3412,7 +3436,7 @@ export interface ListGraphqlApisRequest {
|
|
|
3412
3436
|
/**
|
|
3413
3437
|
* @public
|
|
3414
3438
|
* <p>The value that indicates whether the GraphQL API is a standard API (<code>GRAPHQL</code>) or merged API
|
|
3415
|
-
*
|
|
3439
|
+
* (<code>MERGED</code>).</p>
|
|
3416
3440
|
*/
|
|
3417
3441
|
apiType?: GraphQLApiType;
|
|
3418
3442
|
/**
|
|
@@ -3432,8 +3456,8 @@ export interface ListGraphqlApisResponse {
|
|
|
3432
3456
|
graphqlApis?: GraphqlApi[];
|
|
3433
3457
|
/**
|
|
3434
3458
|
* @public
|
|
3435
|
-
* <p>An identifier to pass in the next request to this operation to return the next set of
|
|
3436
|
-
*
|
|
3459
|
+
* <p>An identifier to pass in the next request to this operation to return the next set of items in the
|
|
3460
|
+
* list.</p>
|
|
3437
3461
|
*/
|
|
3438
3462
|
nextToken?: string;
|
|
3439
3463
|
}
|
|
@@ -3453,8 +3477,8 @@ export interface ListResolversRequest {
|
|
|
3453
3477
|
typeName: string | undefined;
|
|
3454
3478
|
/**
|
|
3455
3479
|
* @public
|
|
3456
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
3457
|
-
*
|
|
3480
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can use to return the
|
|
3481
|
+
* next set of items in the list.</p>
|
|
3458
3482
|
*/
|
|
3459
3483
|
nextToken?: string;
|
|
3460
3484
|
/**
|
|
@@ -3474,8 +3498,8 @@ export interface ListResolversResponse {
|
|
|
3474
3498
|
resolvers?: Resolver[];
|
|
3475
3499
|
/**
|
|
3476
3500
|
* @public
|
|
3477
|
-
* <p>An identifier to pass in the next request to this operation to return the next set of
|
|
3478
|
-
*
|
|
3501
|
+
* <p>An identifier to pass in the next request to this operation to return the next set of items in the
|
|
3502
|
+
* list.</p>
|
|
3479
3503
|
*/
|
|
3480
3504
|
nextToken?: string;
|
|
3481
3505
|
}
|
|
@@ -3495,8 +3519,8 @@ export interface ListResolversByFunctionRequest {
|
|
|
3495
3519
|
functionId: string | undefined;
|
|
3496
3520
|
/**
|
|
3497
3521
|
* @public
|
|
3498
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
3499
|
-
*
|
|
3522
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can use to return the
|
|
3523
|
+
* next set of items in the list.</p>
|
|
3500
3524
|
*/
|
|
3501
3525
|
nextToken?: string;
|
|
3502
3526
|
/**
|
|
@@ -3634,8 +3658,8 @@ export interface ListTypesRequest {
|
|
|
3634
3658
|
format: TypeDefinitionFormat | undefined;
|
|
3635
3659
|
/**
|
|
3636
3660
|
* @public
|
|
3637
|
-
* <p>An identifier that was returned from the previous call to this operation, which you can
|
|
3638
|
-
*
|
|
3661
|
+
* <p>An identifier that was returned from the previous call to this operation, which you can use to return the
|
|
3662
|
+
* next set of items in the list.</p>
|
|
3639
3663
|
*/
|
|
3640
3664
|
nextToken?: string;
|
|
3641
3665
|
/**
|
|
@@ -3655,8 +3679,8 @@ export interface ListTypesResponse {
|
|
|
3655
3679
|
types?: Type[];
|
|
3656
3680
|
/**
|
|
3657
3681
|
* @public
|
|
3658
|
-
* <p>An identifier to pass in the next request to this operation to return the next set of
|
|
3659
|
-
*
|
|
3682
|
+
* <p>An identifier to pass in the next request to this operation to return the next set of items in the
|
|
3683
|
+
* list.</p>
|
|
3660
3684
|
*/
|
|
3661
3685
|
nextToken?: string;
|
|
3662
3686
|
}
|
|
@@ -3666,7 +3690,9 @@ export interface ListTypesResponse {
|
|
|
3666
3690
|
export interface ListTypesByAssociationRequest {
|
|
3667
3691
|
/**
|
|
3668
3692
|
* @public
|
|
3669
|
-
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
|
|
3693
|
+
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
|
|
3694
|
+
* APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs
|
|
3695
|
+
* in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
|
|
3670
3696
|
*/
|
|
3671
3697
|
mergedApiIdentifier: string | undefined;
|
|
3672
3698
|
/**
|
|
@@ -3788,8 +3814,8 @@ export interface StartSchemaCreationRequest {
|
|
|
3788
3814
|
export interface StartSchemaCreationResponse {
|
|
3789
3815
|
/**
|
|
3790
3816
|
* @public
|
|
3791
|
-
* <p>The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When
|
|
3792
|
-
*
|
|
3817
|
+
* <p>The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the
|
|
3818
|
+
* ACTIVE state, you can add data.</p>
|
|
3793
3819
|
*/
|
|
3794
3820
|
status?: SchemaStatus;
|
|
3795
3821
|
}
|
|
@@ -3804,7 +3830,9 @@ export interface StartSchemaMergeRequest {
|
|
|
3804
3830
|
associationId: string | undefined;
|
|
3805
3831
|
/**
|
|
3806
3832
|
* @public
|
|
3807
|
-
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
|
|
3833
|
+
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
|
|
3834
|
+
* APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs
|
|
3835
|
+
* in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
|
|
3808
3836
|
*/
|
|
3809
3837
|
mergedApiIdentifier: string | undefined;
|
|
3810
3838
|
}
|
|
@@ -3880,13 +3908,12 @@ export interface UpdateApiCacheRequest {
|
|
|
3880
3908
|
* <ul>
|
|
3881
3909
|
* <li>
|
|
3882
3910
|
* <p>
|
|
3883
|
-
* <b>FULL_REQUEST_CACHING</b>: All requests are fully
|
|
3884
|
-
* cached.</p>
|
|
3911
|
+
* <b>FULL_REQUEST_CACHING</b>: All requests are fully cached.</p>
|
|
3885
3912
|
* </li>
|
|
3886
3913
|
* <li>
|
|
3887
3914
|
* <p>
|
|
3888
|
-
* <b>PER_RESOLVER_CACHING</b>: Individual resolvers
|
|
3889
|
-
*
|
|
3915
|
+
* <b>PER_RESOLVER_CACHING</b>: Individual resolvers that you specify are
|
|
3916
|
+
* cached.</p>
|
|
3890
3917
|
* </li>
|
|
3891
3918
|
* </ul>
|
|
3892
3919
|
*/
|
|
@@ -4002,8 +4029,8 @@ export interface UpdateApiKeyRequest {
|
|
|
4002
4029
|
description?: string;
|
|
4003
4030
|
/**
|
|
4004
4031
|
* @public
|
|
4005
|
-
* <p>From the update time, the time after which the API key expires. The date is represented
|
|
4006
|
-
*
|
|
4032
|
+
* <p>From the update time, the time after which the API key expires. The date is represented as seconds since the
|
|
4033
|
+
* epoch. For more information, see .</p>
|
|
4007
4034
|
*/
|
|
4008
4035
|
expires?: number;
|
|
4009
4036
|
}
|
|
@@ -4059,8 +4086,8 @@ export interface UpdateDataSourceRequest {
|
|
|
4059
4086
|
/**
|
|
4060
4087
|
* @public
|
|
4061
4088
|
* <p>The new OpenSearch configuration.</p>
|
|
4062
|
-
* <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This
|
|
4063
|
-
*
|
|
4089
|
+
* <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is
|
|
4090
|
+
* deprecated. Instead, use <a>UpdateDataSourceRequest$openSearchServiceConfig</a> to update an OpenSearch data source.</p>
|
|
4064
4091
|
*/
|
|
4065
4092
|
elasticsearchConfig?: ElasticsearchDataSourceConfig;
|
|
4066
4093
|
/**
|
|
@@ -4151,8 +4178,8 @@ export interface UpdateFunctionRequest {
|
|
|
4151
4178
|
dataSourceName: string | undefined;
|
|
4152
4179
|
/**
|
|
4153
4180
|
* @public
|
|
4154
|
-
* <p>The <code>Function</code> request mapping template. Functions support only the
|
|
4155
|
-
*
|
|
4181
|
+
* <p>The <code>Function</code> request mapping template. Functions support only the 2018-05-29 version of the
|
|
4182
|
+
* request mapping template.</p>
|
|
4156
4183
|
*/
|
|
4157
4184
|
requestMappingTemplate?: string;
|
|
4158
4185
|
/**
|
|
@@ -4162,16 +4189,15 @@ export interface UpdateFunctionRequest {
|
|
|
4162
4189
|
responseMappingTemplate?: string;
|
|
4163
4190
|
/**
|
|
4164
4191
|
* @public
|
|
4165
|
-
* <p>The <code>version</code> of the request mapping template. Currently, the supported value
|
|
4166
|
-
*
|
|
4167
|
-
* <code>functionVersion</code> is required.</p>
|
|
4192
|
+
* <p>The <code>version</code> of the request mapping template. Currently, the supported value is 2018-05-29. Note
|
|
4193
|
+
* that when using VTL and mapping templates, the <code>functionVersion</code> is required.</p>
|
|
4168
4194
|
*/
|
|
4169
4195
|
functionVersion?: string;
|
|
4170
4196
|
/**
|
|
4171
4197
|
* @public
|
|
4172
4198
|
* <p>Describes a Sync configuration for a resolver.</p>
|
|
4173
|
-
* <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the
|
|
4174
|
-
*
|
|
4199
|
+
* <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is
|
|
4200
|
+
* invoked.</p>
|
|
4175
4201
|
*/
|
|
4176
4202
|
syncConfig?: SyncConfig;
|
|
4177
4203
|
/**
|
|
@@ -4181,15 +4207,15 @@ export interface UpdateFunctionRequest {
|
|
|
4181
4207
|
maxBatchSize?: number;
|
|
4182
4208
|
/**
|
|
4183
4209
|
* @public
|
|
4184
|
-
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
4185
|
-
* that if a runtime is specified, code must
|
|
4210
|
+
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
4211
|
+
* function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must
|
|
4212
|
+
* also be specified.</p>
|
|
4186
4213
|
*/
|
|
4187
4214
|
runtime?: AppSyncRuntime;
|
|
4188
4215
|
/**
|
|
4189
4216
|
* @public
|
|
4190
|
-
* <p>The <code>function</code> code that contains the request and response functions. When
|
|
4191
|
-
*
|
|
4192
|
-
* <code>APPSYNC_JS</code>.</p>
|
|
4217
|
+
* <p>The <code>function</code> code that contains the request and response functions. When code is used, the
|
|
4218
|
+
* <code>runtime</code> is required. The <code>runtime</code> value must be <code>APPSYNC_JS</code>.</p>
|
|
4193
4219
|
*/
|
|
4194
4220
|
code?: string;
|
|
4195
4221
|
}
|
|
@@ -4229,8 +4255,7 @@ export interface UpdateGraphqlApiRequest {
|
|
|
4229
4255
|
authenticationType?: AuthenticationType;
|
|
4230
4256
|
/**
|
|
4231
4257
|
* @public
|
|
4232
|
-
* <p>The new Amazon Cognito user pool configuration for the <code>~GraphqlApi</code>
|
|
4233
|
-
* object.</p>
|
|
4258
|
+
* <p>The new Amazon Cognito user pool configuration for the <code>~GraphqlApi</code> object.</p>
|
|
4234
4259
|
*/
|
|
4235
4260
|
userPoolConfig?: UserPoolConfig;
|
|
4236
4261
|
/**
|
|
@@ -4240,14 +4265,12 @@ export interface UpdateGraphqlApiRequest {
|
|
|
4240
4265
|
openIDConnectConfig?: OpenIDConnectConfig;
|
|
4241
4266
|
/**
|
|
4242
4267
|
* @public
|
|
4243
|
-
* <p>A list of additional authentication providers for the <code>GraphqlApi</code>
|
|
4244
|
-
* API.</p>
|
|
4268
|
+
* <p>A list of additional authentication providers for the <code>GraphqlApi</code> API.</p>
|
|
4245
4269
|
*/
|
|
4246
4270
|
additionalAuthenticationProviders?: AdditionalAuthenticationProvider[];
|
|
4247
4271
|
/**
|
|
4248
4272
|
* @public
|
|
4249
|
-
* <p>A flag indicating whether to use X-Ray tracing for the
|
|
4250
|
-
* <code>GraphqlApi</code>.</p>
|
|
4273
|
+
* <p>A flag indicating whether to use X-Ray tracing for the <code>GraphqlApi</code>.</p>
|
|
4251
4274
|
*/
|
|
4252
4275
|
xrayEnabled?: boolean;
|
|
4253
4276
|
/**
|
|
@@ -4257,10 +4280,9 @@ export interface UpdateGraphqlApiRequest {
|
|
|
4257
4280
|
lambdaAuthorizerConfig?: LambdaAuthorizerConfig;
|
|
4258
4281
|
/**
|
|
4259
4282
|
* @public
|
|
4260
|
-
* <p>The Identity and Access Management service role ARN for a merged API. The AppSync
|
|
4261
|
-
*
|
|
4262
|
-
*
|
|
4263
|
-
* automatically.</p>
|
|
4283
|
+
* <p>The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role
|
|
4284
|
+
* on behalf of the Merged API to validate access to source APIs at runtime and to prompt the
|
|
4285
|
+
* <code>AUTO_MERGE</code> to update the merged API endpoint with the source API changes automatically.</p>
|
|
4264
4286
|
*/
|
|
4265
4287
|
mergedApiExecutionRoleArn?: string;
|
|
4266
4288
|
/**
|
|
@@ -4269,6 +4291,34 @@ export interface UpdateGraphqlApiRequest {
|
|
|
4269
4291
|
* <p>This field accepts any string input with a length of 0 - 256 characters.</p>
|
|
4270
4292
|
*/
|
|
4271
4293
|
ownerContact?: string;
|
|
4294
|
+
/**
|
|
4295
|
+
* @public
|
|
4296
|
+
* <p>Sets the value of the GraphQL API to enable (<code>ENABLED</code>) or disable (<code>DISABLED</code>)
|
|
4297
|
+
* introspection. If no value is provided, the introspection configuration will be set to <code>ENABLED</code> by
|
|
4298
|
+
* default. This field will produce an error if the operation attempts to use the introspection feature while this
|
|
4299
|
+
* field is disabled.</p>
|
|
4300
|
+
* <p>For more information about introspection, see <a href="https://graphql.org/learn/introspection/">GraphQL
|
|
4301
|
+
* introspection</a>.</p>
|
|
4302
|
+
*/
|
|
4303
|
+
introspectionConfig?: GraphQLApiIntrospectionConfig;
|
|
4304
|
+
/**
|
|
4305
|
+
* @public
|
|
4306
|
+
* <p>The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed
|
|
4307
|
+
* in the body of query. The default value is <code>0</code> (or unspecified), which indicates there's no depth
|
|
4308
|
+
* limit. If you set a limit, it can be between <code>1</code> and <code>75</code> nested levels. This field will
|
|
4309
|
+
* produce a limit error if the operation falls out of bounds.</p>
|
|
4310
|
+
* <p>Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error,
|
|
4311
|
+
* the error will be thrown upwards to the first nullable field available.</p>
|
|
4312
|
+
*/
|
|
4313
|
+
queryDepthLimit?: number;
|
|
4314
|
+
/**
|
|
4315
|
+
* @public
|
|
4316
|
+
* <p>The maximum number of resolvers that can be invoked in a single request. The default value is <code>0</code>
|
|
4317
|
+
* (or unspecified), which will set the limit to <code>10000</code>. When specified, the limit value can be
|
|
4318
|
+
* between <code>1</code> and <code>10000</code>. This field will produce a limit error if the operation falls out
|
|
4319
|
+
* of bounds.</p>
|
|
4320
|
+
*/
|
|
4321
|
+
resolverCountLimit?: number;
|
|
4272
4322
|
}
|
|
4273
4323
|
/**
|
|
4274
4324
|
* @public
|
|
@@ -4307,12 +4357,10 @@ export interface UpdateResolverRequest {
|
|
|
4307
4357
|
/**
|
|
4308
4358
|
* @public
|
|
4309
4359
|
* <p>The new request mapping template.</p>
|
|
4310
|
-
* <p>A resolver uses a request mapping template to convert a GraphQL expression into a format
|
|
4311
|
-
*
|
|
4312
|
-
*
|
|
4313
|
-
*
|
|
4314
|
-
* source. For all other data sources, VTL request and response mapping templates are
|
|
4315
|
-
* required.</p>
|
|
4360
|
+
* <p>A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source
|
|
4361
|
+
* can understand. Mapping templates are written in Apache Velocity Template Language (VTL).</p>
|
|
4362
|
+
* <p>VTL request mapping templates are optional when using an Lambda data source. For all other
|
|
4363
|
+
* data sources, VTL request and response mapping templates are required.</p>
|
|
4316
4364
|
*/
|
|
4317
4365
|
requestMappingTemplate?: string;
|
|
4318
4366
|
/**
|
|
@@ -4326,16 +4374,14 @@ export interface UpdateResolverRequest {
|
|
|
4326
4374
|
* <ul>
|
|
4327
4375
|
* <li>
|
|
4328
4376
|
* <p>
|
|
4329
|
-
* <b>UNIT</b>: A UNIT resolver type. A UNIT resolver is
|
|
4330
|
-
*
|
|
4331
|
-
* a single data source.</p>
|
|
4377
|
+
* <b>UNIT</b>: A UNIT resolver type. A UNIT resolver is the default
|
|
4378
|
+
* resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.</p>
|
|
4332
4379
|
* </li>
|
|
4333
4380
|
* <li>
|
|
4334
4381
|
* <p>
|
|
4335
|
-
* <b>PIPELINE</b>: A PIPELINE resolver type. You can
|
|
4336
|
-
*
|
|
4337
|
-
*
|
|
4338
|
-
* multiple data sources.</p>
|
|
4382
|
+
* <b>PIPELINE</b>: A PIPELINE resolver type. You can use a PIPELINE
|
|
4383
|
+
* resolver to invoke a series of <code>Function</code> objects in a serial manner. You can use a pipeline
|
|
4384
|
+
* resolver to run a GraphQL query against multiple data sources.</p>
|
|
4339
4385
|
* </li>
|
|
4340
4386
|
* </ul>
|
|
4341
4387
|
*/
|
|
@@ -4362,15 +4408,15 @@ export interface UpdateResolverRequest {
|
|
|
4362
4408
|
maxBatchSize?: number;
|
|
4363
4409
|
/**
|
|
4364
4410
|
* @public
|
|
4365
|
-
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
4366
|
-
* that if a runtime is specified, code must
|
|
4411
|
+
* <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
|
|
4412
|
+
* function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must
|
|
4413
|
+
* also be specified.</p>
|
|
4367
4414
|
*/
|
|
4368
4415
|
runtime?: AppSyncRuntime;
|
|
4369
4416
|
/**
|
|
4370
4417
|
* @public
|
|
4371
|
-
* <p>The <code>resolver</code> code that contains the request and response functions. When
|
|
4372
|
-
*
|
|
4373
|
-
* <code>APPSYNC_JS</code>.</p>
|
|
4418
|
+
* <p>The <code>resolver</code> code that contains the request and response functions. When code is used, the
|
|
4419
|
+
* <code>runtime</code> is required. The <code>runtime</code> value must be <code>APPSYNC_JS</code>.</p>
|
|
4374
4420
|
*/
|
|
4375
4421
|
code?: string;
|
|
4376
4422
|
}
|
|
@@ -4395,7 +4441,9 @@ export interface UpdateSourceApiAssociationRequest {
|
|
|
4395
4441
|
associationId: string | undefined;
|
|
4396
4442
|
/**
|
|
4397
4443
|
* @public
|
|
4398
|
-
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
|
|
4444
|
+
* <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
|
|
4445
|
+
* APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs
|
|
4446
|
+
* in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
|
|
4399
4447
|
*/
|
|
4400
4448
|
mergedApiIdentifier: string | undefined;
|
|
4401
4449
|
/**
|
|
@@ -4552,7 +4600,7 @@ export interface DataSourceIntrospectionModel {
|
|
|
4552
4600
|
/**
|
|
4553
4601
|
* @public
|
|
4554
4602
|
* <p>Contains the output of the SDL that was generated from the introspected types. This is controlled by the
|
|
4555
|
-
*
|
|
4603
|
+
* <code>includeModelsSDL</code> parameter of the <code>GetDataSourceIntrospection</code> operation.</p>
|
|
4556
4604
|
*/
|
|
4557
4605
|
sdl?: string;
|
|
4558
4606
|
}
|