@aws-sdk/client-appsync 3.533.0 → 3.540.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.
Files changed (139) hide show
  1. package/dist-cjs/endpoint/endpointResolver.js +4 -2
  2. package/dist-cjs/index.js +0 -3
  3. package/dist-es/endpoint/endpointResolver.js +3 -1
  4. package/dist-es/index.js +0 -1
  5. package/dist-types/AppSync.d.ts +4 -1
  6. package/dist-types/AppSyncClient.d.ts +1 -1
  7. package/dist-types/commands/AssociateApiCommand.d.ts +2 -1
  8. package/dist-types/commands/AssociateMergedGraphqlApiCommand.d.ts +2 -1
  9. package/dist-types/commands/AssociateSourceGraphqlApiCommand.d.ts +2 -1
  10. package/dist-types/commands/CreateApiCacheCommand.d.ts +2 -1
  11. package/dist-types/commands/CreateApiKeyCommand.d.ts +2 -1
  12. package/dist-types/commands/CreateDataSourceCommand.d.ts +2 -1
  13. package/dist-types/commands/CreateDomainNameCommand.d.ts +2 -1
  14. package/dist-types/commands/CreateFunctionCommand.d.ts +2 -1
  15. package/dist-types/commands/CreateGraphqlApiCommand.d.ts +2 -1
  16. package/dist-types/commands/CreateResolverCommand.d.ts +2 -1
  17. package/dist-types/commands/CreateTypeCommand.d.ts +2 -1
  18. package/dist-types/commands/DeleteApiCacheCommand.d.ts +2 -1
  19. package/dist-types/commands/DeleteApiKeyCommand.d.ts +2 -1
  20. package/dist-types/commands/DeleteDataSourceCommand.d.ts +2 -1
  21. package/dist-types/commands/DeleteDomainNameCommand.d.ts +2 -1
  22. package/dist-types/commands/DeleteFunctionCommand.d.ts +2 -1
  23. package/dist-types/commands/DeleteGraphqlApiCommand.d.ts +2 -1
  24. package/dist-types/commands/DeleteResolverCommand.d.ts +2 -1
  25. package/dist-types/commands/DeleteTypeCommand.d.ts +2 -1
  26. package/dist-types/commands/DisassociateApiCommand.d.ts +2 -1
  27. package/dist-types/commands/DisassociateMergedGraphqlApiCommand.d.ts +2 -1
  28. package/dist-types/commands/DisassociateSourceGraphqlApiCommand.d.ts +2 -1
  29. package/dist-types/commands/EvaluateCodeCommand.d.ts +2 -1
  30. package/dist-types/commands/EvaluateMappingTemplateCommand.d.ts +2 -1
  31. package/dist-types/commands/FlushApiCacheCommand.d.ts +2 -1
  32. package/dist-types/commands/GetApiAssociationCommand.d.ts +2 -1
  33. package/dist-types/commands/GetApiCacheCommand.d.ts +2 -1
  34. package/dist-types/commands/GetDataSourceCommand.d.ts +2 -1
  35. package/dist-types/commands/GetDataSourceIntrospectionCommand.d.ts +2 -1
  36. package/dist-types/commands/GetDomainNameCommand.d.ts +2 -1
  37. package/dist-types/commands/GetFunctionCommand.d.ts +2 -1
  38. package/dist-types/commands/GetGraphqlApiCommand.d.ts +2 -1
  39. package/dist-types/commands/GetGraphqlApiEnvironmentVariablesCommand.d.ts +2 -1
  40. package/dist-types/commands/GetIntrospectionSchemaCommand.d.ts +2 -1
  41. package/dist-types/commands/GetResolverCommand.d.ts +2 -1
  42. package/dist-types/commands/GetSchemaCreationStatusCommand.d.ts +2 -1
  43. package/dist-types/commands/GetSourceApiAssociationCommand.d.ts +2 -1
  44. package/dist-types/commands/GetTypeCommand.d.ts +2 -1
  45. package/dist-types/commands/ListApiKeysCommand.d.ts +2 -1
  46. package/dist-types/commands/ListDataSourcesCommand.d.ts +2 -1
  47. package/dist-types/commands/ListDomainNamesCommand.d.ts +2 -1
  48. package/dist-types/commands/ListFunctionsCommand.d.ts +2 -1
  49. package/dist-types/commands/ListGraphqlApisCommand.d.ts +2 -1
  50. package/dist-types/commands/ListResolversByFunctionCommand.d.ts +2 -1
  51. package/dist-types/commands/ListResolversCommand.d.ts +2 -1
  52. package/dist-types/commands/ListSourceApiAssociationsCommand.d.ts +2 -1
  53. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  54. package/dist-types/commands/ListTypesByAssociationCommand.d.ts +2 -1
  55. package/dist-types/commands/ListTypesCommand.d.ts +2 -1
  56. package/dist-types/commands/PutGraphqlApiEnvironmentVariablesCommand.d.ts +2 -1
  57. package/dist-types/commands/StartDataSourceIntrospectionCommand.d.ts +2 -1
  58. package/dist-types/commands/StartSchemaCreationCommand.d.ts +2 -1
  59. package/dist-types/commands/StartSchemaMergeCommand.d.ts +2 -1
  60. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  61. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  62. package/dist-types/commands/UpdateApiCacheCommand.d.ts +2 -1
  63. package/dist-types/commands/UpdateApiKeyCommand.d.ts +2 -1
  64. package/dist-types/commands/UpdateDataSourceCommand.d.ts +2 -1
  65. package/dist-types/commands/UpdateDomainNameCommand.d.ts +2 -1
  66. package/dist-types/commands/UpdateFunctionCommand.d.ts +2 -1
  67. package/dist-types/commands/UpdateGraphqlApiCommand.d.ts +2 -1
  68. package/dist-types/commands/UpdateResolverCommand.d.ts +2 -1
  69. package/dist-types/commands/UpdateSourceApiAssociationCommand.d.ts +2 -1
  70. package/dist-types/commands/UpdateTypeCommand.d.ts +2 -1
  71. package/dist-types/index.d.ts +0 -1
  72. package/dist-types/models/models_0.d.ts +588 -588
  73. package/dist-types/ts3.4/AppSync.d.ts +3 -0
  74. package/dist-types/ts3.4/commands/AssociateApiCommand.d.ts +9 -0
  75. package/dist-types/ts3.4/commands/AssociateMergedGraphqlApiCommand.d.ts +9 -0
  76. package/dist-types/ts3.4/commands/AssociateSourceGraphqlApiCommand.d.ts +9 -0
  77. package/dist-types/ts3.4/commands/CreateApiCacheCommand.d.ts +9 -0
  78. package/dist-types/ts3.4/commands/CreateApiKeyCommand.d.ts +9 -0
  79. package/dist-types/ts3.4/commands/CreateDataSourceCommand.d.ts +9 -0
  80. package/dist-types/ts3.4/commands/CreateDomainNameCommand.d.ts +9 -0
  81. package/dist-types/ts3.4/commands/CreateFunctionCommand.d.ts +9 -0
  82. package/dist-types/ts3.4/commands/CreateGraphqlApiCommand.d.ts +9 -0
  83. package/dist-types/ts3.4/commands/CreateResolverCommand.d.ts +9 -0
  84. package/dist-types/ts3.4/commands/CreateTypeCommand.d.ts +9 -0
  85. package/dist-types/ts3.4/commands/DeleteApiCacheCommand.d.ts +9 -0
  86. package/dist-types/ts3.4/commands/DeleteApiKeyCommand.d.ts +9 -0
  87. package/dist-types/ts3.4/commands/DeleteDataSourceCommand.d.ts +9 -0
  88. package/dist-types/ts3.4/commands/DeleteDomainNameCommand.d.ts +9 -0
  89. package/dist-types/ts3.4/commands/DeleteFunctionCommand.d.ts +9 -0
  90. package/dist-types/ts3.4/commands/DeleteGraphqlApiCommand.d.ts +9 -0
  91. package/dist-types/ts3.4/commands/DeleteResolverCommand.d.ts +9 -0
  92. package/dist-types/ts3.4/commands/DeleteTypeCommand.d.ts +9 -0
  93. package/dist-types/ts3.4/commands/DisassociateApiCommand.d.ts +9 -0
  94. package/dist-types/ts3.4/commands/DisassociateMergedGraphqlApiCommand.d.ts +9 -0
  95. package/dist-types/ts3.4/commands/DisassociateSourceGraphqlApiCommand.d.ts +9 -0
  96. package/dist-types/ts3.4/commands/EvaluateCodeCommand.d.ts +9 -0
  97. package/dist-types/ts3.4/commands/EvaluateMappingTemplateCommand.d.ts +9 -0
  98. package/dist-types/ts3.4/commands/FlushApiCacheCommand.d.ts +9 -0
  99. package/dist-types/ts3.4/commands/GetApiAssociationCommand.d.ts +9 -0
  100. package/dist-types/ts3.4/commands/GetApiCacheCommand.d.ts +9 -0
  101. package/dist-types/ts3.4/commands/GetDataSourceCommand.d.ts +9 -0
  102. package/dist-types/ts3.4/commands/GetDataSourceIntrospectionCommand.d.ts +9 -0
  103. package/dist-types/ts3.4/commands/GetDomainNameCommand.d.ts +9 -0
  104. package/dist-types/ts3.4/commands/GetFunctionCommand.d.ts +9 -0
  105. package/dist-types/ts3.4/commands/GetGraphqlApiCommand.d.ts +9 -0
  106. package/dist-types/ts3.4/commands/GetGraphqlApiEnvironmentVariablesCommand.d.ts +9 -0
  107. package/dist-types/ts3.4/commands/GetIntrospectionSchemaCommand.d.ts +9 -0
  108. package/dist-types/ts3.4/commands/GetResolverCommand.d.ts +9 -0
  109. package/dist-types/ts3.4/commands/GetSchemaCreationStatusCommand.d.ts +9 -0
  110. package/dist-types/ts3.4/commands/GetSourceApiAssociationCommand.d.ts +9 -0
  111. package/dist-types/ts3.4/commands/GetTypeCommand.d.ts +7 -0
  112. package/dist-types/ts3.4/commands/ListApiKeysCommand.d.ts +9 -0
  113. package/dist-types/ts3.4/commands/ListDataSourcesCommand.d.ts +9 -0
  114. package/dist-types/ts3.4/commands/ListDomainNamesCommand.d.ts +9 -0
  115. package/dist-types/ts3.4/commands/ListFunctionsCommand.d.ts +9 -0
  116. package/dist-types/ts3.4/commands/ListGraphqlApisCommand.d.ts +9 -0
  117. package/dist-types/ts3.4/commands/ListResolversByFunctionCommand.d.ts +9 -0
  118. package/dist-types/ts3.4/commands/ListResolversCommand.d.ts +9 -0
  119. package/dist-types/ts3.4/commands/ListSourceApiAssociationsCommand.d.ts +9 -0
  120. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  121. package/dist-types/ts3.4/commands/ListTypesByAssociationCommand.d.ts +9 -0
  122. package/dist-types/ts3.4/commands/ListTypesCommand.d.ts +9 -0
  123. package/dist-types/ts3.4/commands/PutGraphqlApiEnvironmentVariablesCommand.d.ts +9 -0
  124. package/dist-types/ts3.4/commands/StartDataSourceIntrospectionCommand.d.ts +9 -0
  125. package/dist-types/ts3.4/commands/StartSchemaCreationCommand.d.ts +9 -0
  126. package/dist-types/ts3.4/commands/StartSchemaMergeCommand.d.ts +9 -0
  127. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  128. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  129. package/dist-types/ts3.4/commands/UpdateApiCacheCommand.d.ts +9 -0
  130. package/dist-types/ts3.4/commands/UpdateApiKeyCommand.d.ts +9 -0
  131. package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +9 -0
  132. package/dist-types/ts3.4/commands/UpdateDomainNameCommand.d.ts +9 -0
  133. package/dist-types/ts3.4/commands/UpdateFunctionCommand.d.ts +9 -0
  134. package/dist-types/ts3.4/commands/UpdateGraphqlApiCommand.d.ts +9 -0
  135. package/dist-types/ts3.4/commands/UpdateResolverCommand.d.ts +9 -0
  136. package/dist-types/ts3.4/commands/UpdateSourceApiAssociationCommand.d.ts +9 -0
  137. package/dist-types/ts3.4/commands/UpdateTypeCommand.d.ts +9 -0
  138. package/dist-types/ts3.4/index.d.ts +0 -1
  139. package/package.json +41 -41
@@ -1,8 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { AppSyncServiceException as __BaseException } from "./AppSyncServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>You don't have access to perform this operation on this resource.</p>
5
+ * @public
6
6
  */
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
@@ -28,22 +28,21 @@ export declare const AuthenticationType: {
28
28
  */
29
29
  export type AuthenticationType = (typeof AuthenticationType)[keyof typeof AuthenticationType];
30
30
  /**
31
- * @public
32
31
  * <p>A <code>LambdaAuthorizerConfig</code> specifies how to authorize AppSync API access when
33
32
  * using the <code>AWS_LAMBDA</code> authorizer mode. Be aware that an AppSync API can have only
34
33
  * one Lambda authorizer configured at a time.</p>
34
+ * @public
35
35
  */
36
36
  export interface LambdaAuthorizerConfig {
37
37
  /**
38
- * @public
39
38
  * <p>The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If
40
39
  * you don't specify a value for <code>authorizerResultTtlInSeconds</code>, the default value is used. The maximum
41
40
  * value is one hour (3600 seconds). The Lambda function can override this by returning a
42
41
  * <code>ttlOverride</code> key in its response.</p>
42
+ * @public
43
43
  */
44
44
  authorizerResultTtlInSeconds?: number;
45
45
  /**
46
- * @public
47
46
  * <p>The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can
48
47
  * be a standard Lambda ARN, a version ARN (<code>.../v3</code>), or an alias ARN. </p>
49
48
  * <p>
@@ -55,89 +54,90 @@ export interface LambdaAuthorizerConfig {
55
54
  * "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal
56
55
  * appsync.amazonaws.com --action lambda:InvokeFunction</code>
57
56
  * </p>
57
+ * @public
58
58
  */
59
59
  authorizerUri: string | undefined;
60
60
  /**
61
- * @public
62
61
  * <p>A regular expression for validation of tokens before the Lambda function is called.</p>
62
+ * @public
63
63
  */
64
64
  identityValidationExpression?: string;
65
65
  }
66
66
  /**
67
- * @public
68
67
  * <p>Describes an OpenID Connect (OIDC) configuration.</p>
68
+ * @public
69
69
  */
70
70
  export interface OpenIDConnectConfig {
71
71
  /**
72
- * @public
73
72
  * <p>The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of
74
73
  * <code>iss</code> in the ID token.</p>
74
+ * @public
75
75
  */
76
76
  issuer: string | undefined;
77
77
  /**
78
- * @public
79
78
  * <p>The client identifier of the relying party at the OpenID identity provider. This identifier is typically
80
79
  * obtained when the relying party is registered with the OpenID identity provider. You can specify a regular
81
80
  * expression so that AppSync can validate against multiple client identifiers at a time.</p>
81
+ * @public
82
82
  */
83
83
  clientId?: string;
84
84
  /**
85
- * @public
86
85
  * <p>The number of milliseconds that a token is valid after it's issued to a user.</p>
86
+ * @public
87
87
  */
88
88
  iatTTL?: number;
89
89
  /**
90
- * @public
91
90
  * <p>The number of milliseconds that a token is valid after being authenticated.</p>
91
+ * @public
92
92
  */
93
93
  authTTL?: number;
94
94
  }
95
95
  /**
96
- * @public
97
96
  * <p>Describes an Amazon Cognito user pool configuration.</p>
97
+ * @public
98
98
  */
99
99
  export interface CognitoUserPoolConfig {
100
100
  /**
101
- * @public
102
101
  * <p>The user pool ID.</p>
102
+ * @public
103
103
  */
104
104
  userPoolId: string | undefined;
105
105
  /**
106
- * @public
107
106
  * <p>The Amazon Web Services Region in which the user pool was created.</p>
107
+ * @public
108
108
  */
109
109
  awsRegion: string | undefined;
110
110
  /**
111
- * @public
112
111
  * <p>A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value
113
112
  * isn't set, no filtering is applied.</p>
113
+ * @public
114
114
  */
115
115
  appIdClientRegex?: string;
116
116
  }
117
117
  /**
118
- * @public
119
118
  * <p>Describes an additional authentication provider.</p>
119
+ * @public
120
120
  */
121
121
  export interface AdditionalAuthenticationProvider {
122
122
  /**
123
- * @public
124
123
  * <p>The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC),
125
124
  * Amazon Cognito user pools, or Lambda.</p>
125
+ * @public
126
126
  */
127
127
  authenticationType?: AuthenticationType;
128
128
  /**
129
- * @public
130
129
  * <p>The OIDC configuration.</p>
130
+ * @public
131
131
  */
132
132
  openIDConnectConfig?: OpenIDConnectConfig;
133
133
  /**
134
- * @public
135
134
  * <p>The Amazon Cognito user pool configuration.</p>
135
+ * @public
136
136
  */
137
137
  userPoolConfig?: CognitoUserPoolConfig;
138
138
  /**
139
- * @public
140
139
  * <p>Configuration for Lambda function authorization.</p>
140
+ * @public
141
141
  */
142
142
  lambdaAuthorizerConfig?: LambdaAuthorizerConfig;
143
143
  }
@@ -155,22 +155,21 @@ export declare const AssociationStatus: {
155
155
  */
156
156
  export type AssociationStatus = (typeof AssociationStatus)[keyof typeof AssociationStatus];
157
157
  /**
158
- * @public
159
158
  * <p>Describes an <code>ApiAssociation</code> object.</p>
159
+ * @public
160
160
  */
161
161
  export interface ApiAssociation {
162
162
  /**
163
- * @public
164
163
  * <p>The domain name.</p>
164
+ * @public
165
165
  */
166
166
  domainName?: string;
167
167
  /**
168
- * @public
169
168
  * <p>The API ID.</p>
169
+ * @public
170
170
  */
171
171
  apiId?: string;
172
172
  /**
173
- * @public
174
173
  * <p>Identifies the status of an association.</p>
175
174
  * <ul>
176
175
  * <li>
@@ -189,11 +188,12 @@ export interface ApiAssociation {
189
188
  * associations after failure.</p>
190
189
  * </li>
191
190
  * </ul>
191
+ * @public
192
192
  */
193
193
  associationStatus?: AssociationStatus;
194
194
  /**
195
- * @public
196
195
  * <p>Details about the last deployment status.</p>
196
+ * @public
197
197
  */
198
198
  deploymentDetail?: string;
199
199
  }
@@ -262,18 +262,17 @@ export declare const ApiCacheType: {
262
262
  */
263
263
  export type ApiCacheType = (typeof ApiCacheType)[keyof typeof ApiCacheType];
264
264
  /**
265
- * @public
266
265
  * <p>The <code>ApiCache</code> object.</p>
266
+ * @public
267
267
  */
268
268
  export interface ApiCache {
269
269
  /**
270
- * @public
271
270
  * <p>TTL in seconds for cache entries.</p>
272
271
  * <p>Valid values are 1–3,600 seconds.</p>
272
+ * @public
273
273
  */
274
274
  ttl?: number;
275
275
  /**
276
- * @public
277
276
  * <p>Caching behavior.</p>
278
277
  * <ul>
279
278
  * <li>
@@ -286,20 +285,20 @@ export interface ApiCache {
286
285
  * cached.</p>
287
286
  * </li>
288
287
  * </ul>
288
+ * @public
289
289
  */
290
290
  apiCachingBehavior?: ApiCachingBehavior;
291
291
  /**
292
- * @public
293
292
  * <p>Transit encryption flag when connecting to cache. You cannot update this setting after creation.</p>
293
+ * @public
294
294
  */
295
295
  transitEncryptionEnabled?: boolean;
296
296
  /**
297
- * @public
298
297
  * <p>At-rest encryption flag for cache. You cannot update this setting after creation.</p>
298
+ * @public
299
299
  */
300
300
  atRestEncryptionEnabled?: boolean;
301
301
  /**
302
- * @public
303
302
  * <p>The cache instance type. Valid values are </p>
304
303
  * <ul>
305
304
  * <li>
@@ -374,10 +373,10 @@ export interface ApiCache {
374
373
  * <b>R4_8XLARGE</b>: A r4.8xlarge instance type.</p>
375
374
  * </li>
376
375
  * </ul>
376
+ * @public
377
377
  */
378
378
  type?: ApiCacheType;
379
379
  /**
380
- * @public
381
380
  * <p>The cache instance status.</p>
382
381
  * <ul>
383
382
  * <li>
@@ -401,10 +400,10 @@ export interface ApiCache {
401
400
  * <b>FAILED</b>: The instance has failed creation.</p>
402
401
  * </li>
403
402
  * </ul>
403
+ * @public
404
404
  */
405
405
  status?: ApiCacheStatus;
406
406
  /**
407
- * @public
408
407
  * <p>Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:</p>
409
408
  * <ul>
410
409
  * <li>
@@ -419,11 +418,11 @@ export interface ApiCache {
419
418
  * </ul>
420
419
  * <p>Metrics will be recorded by API ID. You can set the value to <code>ENABLED</code> or
421
420
  * <code>DISABLED</code>.</p>
421
+ * @public
422
422
  */
423
423
  healthMetricsConfig?: CacheHealthMetricsConfig;
424
424
  }
425
425
  /**
426
- * @public
427
426
  * <p>Describes an API key.</p>
428
427
  * <p>Customers invoke AppSync GraphQL API operations with API keys as an identity mechanism.
429
428
  * There are two key versions:</p>
@@ -485,34 +484,35 @@ export interface ApiCache {
485
484
  * time.</p>
486
485
  * </li>
487
486
  * </ul>
487
+ * @public
488
488
  */
489
489
  export interface ApiKey {
490
490
  /**
491
- * @public
492
491
  * <p>The API key ID.</p>
492
+ * @public
493
493
  */
494
494
  id?: string;
495
495
  /**
496
- * @public
497
496
  * <p>A description of the purpose of the API key.</p>
497
+ * @public
498
498
  */
499
499
  description?: string;
500
500
  /**
501
- * @public
502
501
  * <p>The time after which the API key expires. The date is represented as seconds since the epoch, rounded down
503
502
  * to the nearest hour.</p>
503
+ * @public
504
504
  */
505
505
  expires?: number;
506
506
  /**
507
- * @public
508
507
  * <p>The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded
509
508
  * down to the nearest hour.</p>
509
+ * @public
510
510
  */
511
511
  deletes?: number;
512
512
  }
513
513
  /**
514
- * @public
515
514
  * <p>The API key exceeded a limit. Try your request again.</p>
515
+ * @public
516
516
  */
517
517
  export declare class ApiKeyLimitExceededException extends __BaseException {
518
518
  readonly name: "ApiKeyLimitExceededException";
@@ -523,9 +523,9 @@ export declare class ApiKeyLimitExceededException extends __BaseException {
523
523
  constructor(opts: __ExceptionOptionType<ApiKeyLimitExceededException, __BaseException>);
524
524
  }
525
525
  /**
526
- * @public
527
526
  * <p>The API key expiration must be set to a value between 1 and 365 days from creation (for
528
527
  * <code>CreateApiKey</code>) or from update (for <code>UpdateApiKey</code>).</p>
528
+ * @public
529
529
  */
530
530
  export declare class ApiKeyValidityOutOfBoundsException extends __BaseException {
531
531
  readonly name: "ApiKeyValidityOutOfBoundsException";
@@ -536,8 +536,8 @@ export declare class ApiKeyValidityOutOfBoundsException extends __BaseException
536
536
  constructor(opts: __ExceptionOptionType<ApiKeyValidityOutOfBoundsException, __BaseException>);
537
537
  }
538
538
  /**
539
- * @public
540
539
  * <p>The GraphQL API exceeded a limit. Try your request again.</p>
540
+ * @public
541
541
  */
542
542
  export declare class ApiLimitExceededException extends __BaseException {
543
543
  readonly name: "ApiLimitExceededException";
@@ -559,22 +559,22 @@ export declare const RuntimeName: {
559
559
  */
560
560
  export type RuntimeName = (typeof RuntimeName)[keyof typeof RuntimeName];
561
561
  /**
562
- * @public
563
562
  * <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
564
563
  * function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must
565
564
  * also be specified.</p>
565
+ * @public
566
566
  */
567
567
  export interface AppSyncRuntime {
568
568
  /**
569
- * @public
570
569
  * <p>The <code>name</code> of the runtime to use. Currently, the only allowed value is
571
570
  * <code>APPSYNC_JS</code>.</p>
571
+ * @public
572
572
  */
573
573
  name: RuntimeName | undefined;
574
574
  /**
575
- * @public
576
575
  * <p>The <code>version</code> of the runtime to use. Currently, the only allowed version is
577
576
  * <code>1.0.0</code>.</p>
577
+ * @public
578
578
  */
579
579
  runtimeVersion: string | undefined;
580
580
  }
@@ -583,13 +583,13 @@ export interface AppSyncRuntime {
583
583
  */
584
584
  export interface AssociateApiRequest {
585
585
  /**
586
- * @public
587
586
  * <p>The domain name.</p>
587
+ * @public
588
588
  */
589
589
  domainName: string | undefined;
590
590
  /**
591
- * @public
592
591
  * <p>The API ID. Private APIs can not be associated with custom domains.</p>
592
+ * @public
593
593
  */
594
594
  apiId: string | undefined;
595
595
  }
@@ -598,64 +598,64 @@ export interface AssociateApiRequest {
598
598
  */
599
599
  export interface AssociateApiResponse {
600
600
  /**
601
- * @public
602
601
  * <p>The <code>ApiAssociation</code> object.</p>
602
+ * @public
603
603
  */
604
604
  apiAssociation?: ApiAssociation;
605
605
  }
606
606
  /**
607
- * @public
608
607
  * <p>Describes the location of the error in a code sample.</p>
608
+ * @public
609
609
  */
610
610
  export interface CodeErrorLocation {
611
611
  /**
612
- * @public
613
612
  * <p>The line number in the code. Defaults to <code>0</code> if unknown.</p>
613
+ * @public
614
614
  */
615
615
  line?: number;
616
616
  /**
617
- * @public
618
617
  * <p>The column number in the code. Defaults to <code>0</code> if unknown.</p>
618
+ * @public
619
619
  */
620
620
  column?: number;
621
621
  /**
622
- * @public
623
622
  * <p>The span/length of the error. Defaults to <code>-1</code> if unknown.</p>
623
+ * @public
624
624
  */
625
625
  span?: number;
626
626
  }
627
627
  /**
628
- * @public
629
628
  * <p>Describes an AppSync error.</p>
629
+ * @public
630
630
  */
631
631
  export interface CodeError {
632
632
  /**
633
- * @public
634
633
  * <p>The type of code error. </p>
635
634
  * <p>Examples include, but aren't limited to: <code>LINT_ERROR</code>, <code>PARSER_ERROR</code>.</p>
635
+ * @public
636
636
  */
637
637
  errorType?: string;
638
638
  /**
639
- * @public
640
639
  * <p>A user presentable error.</p>
641
640
  * <p>Examples include, but aren't limited to: <code>Parsing error: Unterminated string literal</code>.</p>
641
+ * @public
642
642
  */
643
643
  value?: string;
644
644
  /**
645
- * @public
646
645
  * <p>The line, column, and span location of the error in the code.</p>
646
+ * @public
647
647
  */
648
648
  location?: CodeErrorLocation;
649
649
  }
650
650
  /**
651
- * @public
652
651
  * <p>Provides further details for the reason behind the bad request. For reason type <code>CODE_ERROR</code>, the
653
652
  * detail will contain a list of code errors.</p>
653
+ * @public
654
654
  */
655
655
  export interface BadRequestDetail {
656
656
  /**
657
- * @public
658
657
  * <p>Contains the list of errors in the request.</p>
658
+ * @public
659
659
  */
660
660
  codeErrors?: CodeError[];
661
661
  }
@@ -671,23 +671,23 @@ export declare const BadRequestReason: {
671
671
  */
672
672
  export type BadRequestReason = (typeof BadRequestReason)[keyof typeof BadRequestReason];
673
673
  /**
674
- * @public
675
674
  * <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the
676
675
  * field values, and then try again.</p>
676
+ * @public
677
677
  */
678
678
  export declare class BadRequestException extends __BaseException {
679
679
  readonly name: "BadRequestException";
680
680
  readonly $fault: "client";
681
681
  /**
682
- * @public
683
682
  * <p>Provides context for the cause of the bad request. The only supported value is
684
683
  * <code>CODE_ERROR</code>.</p>
684
+ * @public
685
685
  */
686
686
  reason?: BadRequestReason;
687
687
  /**
688
- * @public
689
688
  * <p>Provides further details for the reason behind the bad request. For reason type <code>CODE_ERROR</code>, the
690
689
  * detail will contain a list of code errors.</p>
690
+ * @public
691
691
  */
692
692
  detail?: BadRequestDetail;
693
693
  /**
@@ -696,8 +696,8 @@ export declare class BadRequestException extends __BaseException {
696
696
  constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
697
697
  }
698
698
  /**
699
- * @public
700
699
  * <p>An internal AppSync error occurred. Try your request again.</p>
700
+ * @public
701
701
  */
702
702
  export declare class InternalFailureException extends __BaseException {
703
703
  readonly name: "InternalFailureException";
@@ -708,8 +708,8 @@ export declare class InternalFailureException extends __BaseException {
708
708
  constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
709
709
  }
710
710
  /**
711
- * @public
712
711
  * <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
712
+ * @public
713
713
  */
714
714
  export declare class NotFoundException extends __BaseException {
715
715
  readonly name: "NotFoundException";
@@ -732,18 +732,18 @@ export declare const MergeType: {
732
732
  */
733
733
  export type MergeType = (typeof MergeType)[keyof typeof MergeType];
734
734
  /**
735
- * @public
736
735
  * <p>Describes properties used to specify configurations related to a source API.</p>
736
+ * @public
737
737
  */
738
738
  export interface SourceApiAssociationConfig {
739
739
  /**
740
- * @public
741
740
  * <p>The property that indicates which merging option is enabled in the source API association.</p>
742
741
  * <p>Valid merge types are <code>MANUAL_MERGE</code> (default) and <code>AUTO_MERGE</code>. Manual merges are the
743
742
  * default behavior and require the user to trigger any changes from the source APIs to the merged API manually.
744
743
  * Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the
745
744
  * source APIs are also made to the merged API. Auto merges use <code>MergedApiExecutionRoleArn</code> to perform
746
745
  * merge operations.</p>
746
+ * @public
747
747
  */
748
748
  mergeType?: MergeType;
749
749
  }
@@ -752,27 +752,27 @@ export interface SourceApiAssociationConfig {
752
752
  */
753
753
  export interface AssociateMergedGraphqlApiRequest {
754
754
  /**
755
- * @public
756
755
  * <p>The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source
757
756
  * APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs
758
757
  * from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.</p>
758
+ * @public
759
759
  */
760
760
  sourceApiIdentifier: string | undefined;
761
761
  /**
762
- * @public
763
762
  * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
764
763
  * APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs
765
764
  * in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
765
+ * @public
766
766
  */
767
767
  mergedApiIdentifier: string | undefined;
768
768
  /**
769
- * @public
770
769
  * <p>The description field.</p>
770
+ * @public
771
771
  */
772
772
  description?: string;
773
773
  /**
774
- * @public
775
774
  * <p>The <code>SourceApiAssociationConfig</code> object data.</p>
775
+ * @public
776
776
  */
777
777
  sourceApiAssociationConfig?: SourceApiAssociationConfig;
778
778
  }
@@ -795,7 +795,6 @@ export declare const SourceApiAssociationStatus: {
795
795
  */
796
796
  export type SourceApiAssociationStatus = (typeof SourceApiAssociationStatus)[keyof typeof SourceApiAssociationStatus];
797
797
  /**
798
- * @public
799
798
  * <p>Describes the configuration of a source API. A source API is a GraphQL API that is linked to a merged API.
800
799
  * There can be multiple source APIs attached to each merged API. When linked to a merged API, the source API's
801
800
  * schema, data sources, and resolvers will be combined with other linked source API data to form a new, singular
@@ -803,62 +802,63 @@ export type SourceApiAssociationStatus = (typeof SourceApiAssociationStatus)[key
803
802
  * <p>Source APIs can originate from your account or from other accounts via Amazon Web Services Resource Access
804
803
  * 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
805
804
  * Access Manager?</a> in the <i>Amazon Web Services Resource Access Manager</i> guide.</p>
805
+ * @public
806
806
  */
807
807
  export interface SourceApiAssociation {
808
808
  /**
809
- * @public
810
809
  * <p>The ID generated by the AppSync service for the source API association.</p>
810
+ * @public
811
811
  */
812
812
  associationId?: string;
813
813
  /**
814
- * @public
815
814
  * <p>The Amazon Resource Name (ARN) of the source API association.</p>
815
+ * @public
816
816
  */
817
817
  associationArn?: string;
818
818
  /**
819
- * @public
820
819
  * <p>The ID of the AppSync source API.</p>
820
+ * @public
821
821
  */
822
822
  sourceApiId?: string;
823
823
  /**
824
- * @public
825
824
  * <p>The Amazon Resource Name (ARN) of the AppSync source API.</p>
825
+ * @public
826
826
  */
827
827
  sourceApiArn?: string;
828
828
  /**
829
- * @public
830
829
  * <p>The Amazon Resource Name (ARN) of the AppSync Merged API.</p>
830
+ * @public
831
831
  */
832
832
  mergedApiArn?: string;
833
833
  /**
834
- * @public
835
834
  * <p>The ID of the AppSync Merged API.</p>
835
+ * @public
836
836
  */
837
837
  mergedApiId?: string;
838
838
  /**
839
- * @public
840
839
  * <p>The description field.</p>
840
+ * @public
841
841
  */
842
842
  description?: string;
843
843
  /**
844
- * @public
845
844
  * <p>The <code>SourceApiAssociationConfig</code> object data.</p>
845
+ * @public
846
846
  */
847
847
  sourceApiAssociationConfig?: SourceApiAssociationConfig;
848
848
  /**
849
- * @public
850
849
  * <p>The state of the source API association.</p>
850
+ * @public
851
851
  */
852
852
  sourceApiAssociationStatus?: SourceApiAssociationStatus;
853
853
  /**
854
- * @public
855
854
  * <p>The detailed message related to the current state of the source API association.</p>
855
+ * @public
856
856
  */
857
857
  sourceApiAssociationStatusDetail?: string;
858
858
  /**
859
- * @public
860
859
  * <p>The datetime value of the last successful merge of the source API association. The result will be in UTC
861
860
  * format and your local time zone.</p>
861
+ * @public
862
862
  */
863
863
  lastSuccessfulMergeDate?: Date;
864
864
  }
@@ -867,15 +867,15 @@ export interface SourceApiAssociation {
867
867
  */
868
868
  export interface AssociateMergedGraphqlApiResponse {
869
869
  /**
870
- * @public
871
870
  * <p>The <code>SourceApiAssociation</code> object data.</p>
871
+ * @public
872
872
  */
873
873
  sourceApiAssociation?: SourceApiAssociation;
874
874
  }
875
875
  /**
876
- * @public
877
876
  * <p>Another modification is in progress at this time and it must complete before you can make your
878
877
  * change.</p>
878
+ * @public
879
879
  */
880
880
  export declare class ConcurrentModificationException extends __BaseException {
881
881
  readonly name: "ConcurrentModificationException";
@@ -886,8 +886,8 @@ export declare class ConcurrentModificationException extends __BaseException {
886
886
  constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
887
887
  }
888
888
  /**
889
- * @public
890
889
  * <p>The request exceeded a limit. Try your request again.</p>
890
+ * @public
891
891
  */
892
892
  export declare class LimitExceededException extends __BaseException {
893
893
  readonly name: "LimitExceededException";
@@ -898,8 +898,8 @@ export declare class LimitExceededException extends __BaseException {
898
898
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
899
899
  }
900
900
  /**
901
- * @public
902
901
  * <p>You aren't authorized to perform this operation.</p>
902
+ * @public
903
903
  */
904
904
  export declare class UnauthorizedException extends __BaseException {
905
905
  readonly name: "UnauthorizedException";
@@ -914,27 +914,27 @@ export declare class UnauthorizedException extends __BaseException {
914
914
  */
915
915
  export interface AssociateSourceGraphqlApiRequest {
916
916
  /**
917
- * @public
918
917
  * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
919
918
  * APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs
920
919
  * in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
920
+ * @public
921
921
  */
922
922
  mergedApiIdentifier: string | undefined;
923
923
  /**
924
- * @public
925
924
  * <p>The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source
926
925
  * APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs
927
926
  * from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.</p>
927
+ * @public
928
928
  */
929
929
  sourceApiIdentifier: string | undefined;
930
930
  /**
931
- * @public
932
931
  * <p>The description field.</p>
932
+ * @public
933
933
  */
934
934
  description?: string;
935
935
  /**
936
- * @public
937
936
  * <p>The <code>SourceApiAssociationConfig</code> object data.</p>
937
+ * @public
938
938
  */
939
939
  sourceApiAssociationConfig?: SourceApiAssociationConfig;
940
940
  }
@@ -943,8 +943,8 @@ export interface AssociateSourceGraphqlApiRequest {
943
943
  */
944
944
  export interface AssociateSourceGraphqlApiResponse {
945
945
  /**
946
- * @public
947
946
  * <p>The <code>SourceApiAssociation</code> object data.</p>
947
+ * @public
948
948
  */
949
949
  sourceApiAssociation?: SourceApiAssociation;
950
950
  }
@@ -960,28 +960,27 @@ export declare const AuthorizationType: {
960
960
  */
961
961
  export type AuthorizationType = (typeof AuthorizationType)[keyof typeof AuthorizationType];
962
962
  /**
963
- * @public
964
963
  * <p>The Identity and Access Management (IAM) configuration.</p>
964
+ * @public
965
965
  */
966
966
  export interface AwsIamConfig {
967
967
  /**
968
- * @public
969
968
  * <p>The signing Amazon Web Services Region for IAM authorization.</p>
969
+ * @public
970
970
  */
971
971
  signingRegion?: string;
972
972
  /**
973
- * @public
974
973
  * <p>The signing service name for IAM authorization.</p>
974
+ * @public
975
975
  */
976
976
  signingServiceName?: string;
977
977
  }
978
978
  /**
979
- * @public
980
979
  * <p>The authorization configuration in case the HTTP endpoint requires authorization.</p>
980
+ * @public
981
981
  */
982
982
  export interface AuthorizationConfig {
983
983
  /**
984
- * @public
985
984
  * <p>The authorization type that the HTTP endpoint requires.</p>
986
985
  * <ul>
987
986
  * <li>
@@ -990,42 +989,42 @@ export interface AuthorizationConfig {
990
989
  * (SigV4).</p>
991
990
  * </li>
992
991
  * </ul>
992
+ * @public
993
993
  */
994
994
  authorizationType: AuthorizationType | undefined;
995
995
  /**
996
- * @public
997
996
  * <p>The Identity and Access Management (IAM) settings.</p>
997
+ * @public
998
998
  */
999
999
  awsIamConfig?: AwsIamConfig;
1000
1000
  }
1001
1001
  /**
1002
- * @public
1003
1002
  * <p>Represents the input of a <code>CreateApiCache</code> operation.</p>
1003
+ * @public
1004
1004
  */
1005
1005
  export interface CreateApiCacheRequest {
1006
1006
  /**
1007
- * @public
1008
1007
  * <p>The GraphQL API ID.</p>
1008
+ * @public
1009
1009
  */
1010
1010
  apiId: string | undefined;
1011
1011
  /**
1012
- * @public
1013
1012
  * <p>TTL in seconds for cache entries.</p>
1014
1013
  * <p>Valid values are 1–3,600 seconds.</p>
1014
+ * @public
1015
1015
  */
1016
1016
  ttl: number | undefined;
1017
1017
  /**
1018
- * @public
1019
1018
  * <p>Transit encryption flag when connecting to cache. You cannot update this setting after creation.</p>
1019
+ * @public
1020
1020
  */
1021
1021
  transitEncryptionEnabled?: boolean;
1022
1022
  /**
1023
- * @public
1024
1023
  * <p>At-rest encryption flag for cache. You cannot update this setting after creation.</p>
1024
+ * @public
1025
1025
  */
1026
1026
  atRestEncryptionEnabled?: boolean;
1027
1027
  /**
1028
- * @public
1029
1028
  * <p>Caching behavior.</p>
1030
1029
  * <ul>
1031
1030
  * <li>
@@ -1038,10 +1037,10 @@ export interface CreateApiCacheRequest {
1038
1037
  * cached.</p>
1039
1038
  * </li>
1040
1039
  * </ul>
1040
+ * @public
1041
1041
  */
1042
1042
  apiCachingBehavior: ApiCachingBehavior | undefined;
1043
1043
  /**
1044
- * @public
1045
1044
  * <p>The cache instance type. Valid values are </p>
1046
1045
  * <ul>
1047
1046
  * <li>
@@ -1116,10 +1115,10 @@ export interface CreateApiCacheRequest {
1116
1115
  * <b>R4_8XLARGE</b>: A r4.8xlarge instance type.</p>
1117
1116
  * </li>
1118
1117
  * </ul>
1118
+ * @public
1119
1119
  */
1120
1120
  type: ApiCacheType | undefined;
1121
1121
  /**
1122
- * @public
1123
1122
  * <p>Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:</p>
1124
1123
  * <ul>
1125
1124
  * <li>
@@ -1134,17 +1133,18 @@ export interface CreateApiCacheRequest {
1134
1133
  * </ul>
1135
1134
  * <p>Metrics will be recorded by API ID. You can set the value to <code>ENABLED</code> or
1136
1135
  * <code>DISABLED</code>.</p>
1136
+ * @public
1137
1137
  */
1138
1138
  healthMetricsConfig?: CacheHealthMetricsConfig;
1139
1139
  }
1140
1140
  /**
1141
- * @public
1142
1141
  * <p>Represents the output of a <code>CreateApiCache</code> operation.</p>
1142
+ * @public
1143
1143
  */
1144
1144
  export interface CreateApiCacheResponse {
1145
1145
  /**
1146
- * @public
1147
1146
  * <p>The <code>ApiCache</code> object.</p>
1147
+ * @public
1148
1148
  */
1149
1149
  apiCache?: ApiCache;
1150
1150
  }
@@ -1153,20 +1153,20 @@ export interface CreateApiCacheResponse {
1153
1153
  */
1154
1154
  export interface CreateApiKeyRequest {
1155
1155
  /**
1156
- * @public
1157
1156
  * <p>The ID for your GraphQL API.</p>
1157
+ * @public
1158
1158
  */
1159
1159
  apiId: string | undefined;
1160
1160
  /**
1161
- * @public
1162
1161
  * <p>A description of the purpose of the API key.</p>
1162
+ * @public
1163
1163
  */
1164
1164
  description?: string;
1165
1165
  /**
1166
- * @public
1167
1166
  * <p>From the creation time, the time after which the API key expires. The date is represented as seconds since
1168
1167
  * the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time.
1169
1168
  * For more information, see .</p>
1169
+ * @public
1170
1170
  */
1171
1171
  expires?: number;
1172
1172
  }
@@ -1175,119 +1175,119 @@ export interface CreateApiKeyRequest {
1175
1175
  */
1176
1176
  export interface CreateApiKeyResponse {
1177
1177
  /**
1178
- * @public
1179
1178
  * <p>The API key.</p>
1179
+ * @public
1180
1180
  */
1181
1181
  apiKey?: ApiKey;
1182
1182
  }
1183
1183
  /**
1184
- * @public
1185
1184
  * <p>Describes a Delta Sync configuration.</p>
1185
+ * @public
1186
1186
  */
1187
1187
  export interface DeltaSyncConfig {
1188
1188
  /**
1189
- * @public
1190
1189
  * <p>The number of minutes that an Item is stored in the data source.</p>
1190
+ * @public
1191
1191
  */
1192
1192
  baseTableTTL?: number;
1193
1193
  /**
1194
- * @public
1195
1194
  * <p>The Delta Sync table name.</p>
1195
+ * @public
1196
1196
  */
1197
1197
  deltaSyncTableName?: string;
1198
1198
  /**
1199
- * @public
1200
1199
  * <p>The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.</p>
1200
+ * @public
1201
1201
  */
1202
1202
  deltaSyncTableTTL?: number;
1203
1203
  }
1204
1204
  /**
1205
- * @public
1206
1205
  * <p>Describes an Amazon DynamoDB data source configuration.</p>
1206
+ * @public
1207
1207
  */
1208
1208
  export interface DynamodbDataSourceConfig {
1209
1209
  /**
1210
- * @public
1211
1210
  * <p>The table name.</p>
1211
+ * @public
1212
1212
  */
1213
1213
  tableName: string | undefined;
1214
1214
  /**
1215
- * @public
1216
1215
  * <p>The Amazon Web Services Region.</p>
1216
+ * @public
1217
1217
  */
1218
1218
  awsRegion: string | undefined;
1219
1219
  /**
1220
- * @public
1221
1220
  * <p>Set to TRUE to use Amazon Cognito credentials with this data source.</p>
1221
+ * @public
1222
1222
  */
1223
1223
  useCallerCredentials?: boolean;
1224
1224
  /**
1225
- * @public
1226
1225
  * <p>The <code>DeltaSyncConfig</code> for a versioned data source.</p>
1226
+ * @public
1227
1227
  */
1228
1228
  deltaSyncConfig?: DeltaSyncConfig;
1229
1229
  /**
1230
- * @public
1231
1230
  * <p>Set to TRUE to use Conflict Detection and Resolution with this data source.</p>
1231
+ * @public
1232
1232
  */
1233
1233
  versioned?: boolean;
1234
1234
  }
1235
1235
  /**
1236
- * @public
1237
1236
  * <p>Describes an OpenSearch data source configuration.</p>
1238
1237
  * <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is
1239
1238
  * deprecated. For new data sources, use <a>OpenSearchServiceDataSourceConfig</a> to specify an OpenSearch data source.</p>
1239
+ * @public
1240
1240
  */
1241
1241
  export interface ElasticsearchDataSourceConfig {
1242
1242
  /**
1243
- * @public
1244
1243
  * <p>The endpoint.</p>
1244
+ * @public
1245
1245
  */
1246
1246
  endpoint: string | undefined;
1247
1247
  /**
1248
- * @public
1249
1248
  * <p>The Amazon Web Services Region.</p>
1249
+ * @public
1250
1250
  */
1251
1251
  awsRegion: string | undefined;
1252
1252
  }
1253
1253
  /**
1254
- * @public
1255
1254
  * <p>Describes an Amazon EventBridge bus data source configuration.</p>
1255
+ * @public
1256
1256
  */
1257
1257
  export interface EventBridgeDataSourceConfig {
1258
1258
  /**
1259
- * @public
1260
1259
  * <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
1261
1260
  * buses</a>.</p>
1261
+ * @public
1262
1262
  */
1263
1263
  eventBusArn: string | undefined;
1264
1264
  }
1265
1265
  /**
1266
- * @public
1267
1266
  * <p>Describes an HTTP data source configuration.</p>
1267
+ * @public
1268
1268
  */
1269
1269
  export interface HttpDataSourceConfig {
1270
1270
  /**
1271
- * @public
1272
1271
  * <p>The HTTP URL endpoint. You can specify either the domain name or IP, and port combination, and the URL
1273
1272
  * scheme must be HTTP or HTTPS. If you don't specify the port, AppSync uses the default port 80
1274
1273
  * for the HTTP endpoint and port 443 for HTTPS endpoints.</p>
1274
+ * @public
1275
1275
  */
1276
1276
  endpoint?: string;
1277
1277
  /**
1278
- * @public
1279
1278
  * <p>The authorization configuration in case the HTTP endpoint requires authorization.</p>
1279
+ * @public
1280
1280
  */
1281
1281
  authorizationConfig?: AuthorizationConfig;
1282
1282
  }
1283
1283
  /**
1284
- * @public
1285
1284
  * <p>Describes an Lambda data source configuration.</p>
1285
+ * @public
1286
1286
  */
1287
1287
  export interface LambdaDataSourceConfig {
1288
1288
  /**
1289
- * @public
1290
1289
  * <p>The Amazon Resource Name (ARN) for the Lambda function.</p>
1290
+ * @public
1291
1291
  */
1292
1292
  lambdaFunctionArn: string | undefined;
1293
1293
  }
@@ -1304,49 +1304,49 @@ export declare const DataSourceLevelMetricsConfig: {
1304
1304
  */
1305
1305
  export type DataSourceLevelMetricsConfig = (typeof DataSourceLevelMetricsConfig)[keyof typeof DataSourceLevelMetricsConfig];
1306
1306
  /**
1307
- * @public
1308
1307
  * <p>Describes an OpenSearch data source configuration.</p>
1308
+ * @public
1309
1309
  */
1310
1310
  export interface OpenSearchServiceDataSourceConfig {
1311
1311
  /**
1312
- * @public
1313
1312
  * <p>The endpoint.</p>
1313
+ * @public
1314
1314
  */
1315
1315
  endpoint: string | undefined;
1316
1316
  /**
1317
- * @public
1318
1317
  * <p>The Amazon Web Services Region.</p>
1318
+ * @public
1319
1319
  */
1320
1320
  awsRegion: string | undefined;
1321
1321
  }
1322
1322
  /**
1323
- * @public
1324
1323
  * <p>The Amazon Relational Database Service (Amazon RDS) HTTP endpoint configuration.</p>
1324
+ * @public
1325
1325
  */
1326
1326
  export interface RdsHttpEndpointConfig {
1327
1327
  /**
1328
- * @public
1329
1328
  * <p>Amazon Web Services Region for Amazon RDS HTTP endpoint.</p>
1329
+ * @public
1330
1330
  */
1331
1331
  awsRegion?: string;
1332
1332
  /**
1333
- * @public
1334
1333
  * <p>Amazon RDS cluster Amazon Resource Name (ARN).</p>
1334
+ * @public
1335
1335
  */
1336
1336
  dbClusterIdentifier?: string;
1337
1337
  /**
1338
- * @public
1339
1338
  * <p>Logical database name.</p>
1339
+ * @public
1340
1340
  */
1341
1341
  databaseName?: string;
1342
1342
  /**
1343
- * @public
1344
1343
  * <p>Logical schema name.</p>
1344
+ * @public
1345
1345
  */
1346
1346
  schema?: string;
1347
1347
  /**
1348
- * @public
1349
1348
  * <p>Amazon Web Services secret store Amazon Resource Name (ARN) for database credentials.</p>
1349
+ * @public
1350
1350
  */
1351
1351
  awsSecretStoreArn?: string;
1352
1352
  }
@@ -1362,12 +1362,11 @@ export declare const RelationalDatabaseSourceType: {
1362
1362
  */
1363
1363
  export type RelationalDatabaseSourceType = (typeof RelationalDatabaseSourceType)[keyof typeof RelationalDatabaseSourceType];
1364
1364
  /**
1365
- * @public
1366
1365
  * <p>Describes a relational database data source configuration.</p>
1366
+ * @public
1367
1367
  */
1368
1368
  export interface RelationalDatabaseDataSourceConfig {
1369
1369
  /**
1370
- * @public
1371
1370
  * <p>Source type for the relational database.</p>
1372
1371
  * <ul>
1373
1372
  * <li>
@@ -1376,11 +1375,12 @@ export interface RelationalDatabaseDataSourceConfig {
1376
1375
  * Amazon Relational Database Service (Amazon RDS) HTTP endpoint.</p>
1377
1376
  * </li>
1378
1377
  * </ul>
1378
+ * @public
1379
1379
  */
1380
1380
  relationalDatabaseSourceType?: RelationalDatabaseSourceType;
1381
1381
  /**
1382
- * @public
1383
1382
  * <p>Amazon RDS HTTP endpoint settings.</p>
1383
+ * @public
1384
1384
  */
1385
1385
  rdsHttpEndpointConfig?: RdsHttpEndpointConfig;
1386
1386
  }
@@ -1407,71 +1407,70 @@ export type DataSourceType = (typeof DataSourceType)[keyof typeof DataSourceType
1407
1407
  */
1408
1408
  export interface CreateDataSourceRequest {
1409
1409
  /**
1410
- * @public
1411
1410
  * <p>The API ID for the GraphQL API for the <code>DataSource</code>.</p>
1411
+ * @public
1412
1412
  */
1413
1413
  apiId: string | undefined;
1414
1414
  /**
1415
- * @public
1416
1415
  * <p>A user-supplied name for the <code>DataSource</code>.</p>
1416
+ * @public
1417
1417
  */
1418
1418
  name: string | undefined;
1419
1419
  /**
1420
- * @public
1421
1420
  * <p>A description of the <code>DataSource</code>.</p>
1421
+ * @public
1422
1422
  */
1423
1423
  description?: string;
1424
1424
  /**
1425
- * @public
1426
1425
  * <p>The type of the <code>DataSource</code>.</p>
1426
+ * @public
1427
1427
  */
1428
1428
  type: DataSourceType | undefined;
1429
1429
  /**
1430
- * @public
1431
1430
  * <p>The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.
1432
1431
  * The system assumes this role when accessing the data source.</p>
1432
+ * @public
1433
1433
  */
1434
1434
  serviceRoleArn?: string;
1435
1435
  /**
1436
- * @public
1437
1436
  * <p>Amazon DynamoDB settings.</p>
1437
+ * @public
1438
1438
  */
1439
1439
  dynamodbConfig?: DynamodbDataSourceConfig;
1440
1440
  /**
1441
- * @public
1442
1441
  * <p>Lambda settings.</p>
1442
+ * @public
1443
1443
  */
1444
1444
  lambdaConfig?: LambdaDataSourceConfig;
1445
1445
  /**
1446
- * @public
1447
1446
  * <p>Amazon OpenSearch Service settings.</p>
1448
1447
  * <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is
1449
1448
  * deprecated. For new data sources, use <a>CreateDataSourceRequest$openSearchServiceConfig</a> to
1450
1449
  * create an OpenSearch data source.</p>
1450
+ * @public
1451
1451
  */
1452
1452
  elasticsearchConfig?: ElasticsearchDataSourceConfig;
1453
1453
  /**
1454
- * @public
1455
1454
  * <p>Amazon OpenSearch Service settings.</p>
1455
+ * @public
1456
1456
  */
1457
1457
  openSearchServiceConfig?: OpenSearchServiceDataSourceConfig;
1458
1458
  /**
1459
- * @public
1460
1459
  * <p>HTTP endpoint settings.</p>
1460
+ * @public
1461
1461
  */
1462
1462
  httpConfig?: HttpDataSourceConfig;
1463
1463
  /**
1464
- * @public
1465
1464
  * <p>Relational database settings.</p>
1465
+ * @public
1466
1466
  */
1467
1467
  relationalDatabaseConfig?: RelationalDatabaseDataSourceConfig;
1468
1468
  /**
1469
- * @public
1470
1469
  * <p>Amazon EventBridge settings.</p>
1470
+ * @public
1471
1471
  */
1472
1472
  eventBridgeConfig?: EventBridgeDataSourceConfig;
1473
1473
  /**
1474
- * @public
1475
1474
  * <p>Enables or disables enhanced data source metrics for specified data sources. Note that
1476
1475
  * <code>metricsConfig</code> won't be used unless the <code>dataSourceLevelMetricsBehavior</code> value is set
1477
1476
  * to <code>PER_DATA_SOURCE_METRICS</code>. If the <code>dataSourceLevelMetricsBehavior</code> is set to
@@ -1479,31 +1478,31 @@ export interface CreateDataSourceRequest {
1479
1478
  * you can still set its value.</p>
1480
1479
  * <p>
1481
1480
  * <code>metricsConfig</code> can be <code>ENABLED</code> or <code>DISABLED</code>.</p>
1481
+ * @public
1482
1482
  */
1483
1483
  metricsConfig?: DataSourceLevelMetricsConfig;
1484
1484
  }
1485
1485
  /**
1486
- * @public
1487
1486
  * <p>Describes a data source.</p>
1487
+ * @public
1488
1488
  */
1489
1489
  export interface DataSource {
1490
1490
  /**
1491
- * @public
1492
1491
  * <p>The data source Amazon Resource Name (ARN).</p>
1492
+ * @public
1493
1493
  */
1494
1494
  dataSourceArn?: string;
1495
1495
  /**
1496
- * @public
1497
1496
  * <p>The name of the data source.</p>
1497
+ * @public
1498
1498
  */
1499
1499
  name?: string;
1500
1500
  /**
1501
- * @public
1502
1501
  * <p>The description of the data source.</p>
1502
+ * @public
1503
1503
  */
1504
1504
  description?: string;
1505
1505
  /**
1506
- * @public
1507
1506
  * <p>The type of the data source.</p>
1508
1507
  * <ul>
1509
1508
  * <li>
@@ -1546,51 +1545,51 @@ export interface DataSource {
1546
1545
  * database.</p>
1547
1546
  * </li>
1548
1547
  * </ul>
1548
+ * @public
1549
1549
  */
1550
1550
  type?: DataSourceType;
1551
1551
  /**
1552
- * @public
1553
1552
  * <p>The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.
1554
1553
  * The system assumes this role when accessing the data source.</p>
1554
+ * @public
1555
1555
  */
1556
1556
  serviceRoleArn?: string;
1557
1557
  /**
1558
- * @public
1559
1558
  * <p>DynamoDB settings.</p>
1559
+ * @public
1560
1560
  */
1561
1561
  dynamodbConfig?: DynamodbDataSourceConfig;
1562
1562
  /**
1563
- * @public
1564
1563
  * <p>Lambda settings.</p>
1564
+ * @public
1565
1565
  */
1566
1566
  lambdaConfig?: LambdaDataSourceConfig;
1567
1567
  /**
1568
- * @public
1569
1568
  * <p>Amazon OpenSearch Service settings.</p>
1569
+ * @public
1570
1570
  */
1571
1571
  elasticsearchConfig?: ElasticsearchDataSourceConfig;
1572
1572
  /**
1573
- * @public
1574
1573
  * <p>Amazon OpenSearch Service settings.</p>
1574
+ * @public
1575
1575
  */
1576
1576
  openSearchServiceConfig?: OpenSearchServiceDataSourceConfig;
1577
1577
  /**
1578
- * @public
1579
1578
  * <p>HTTP endpoint settings.</p>
1579
+ * @public
1580
1580
  */
1581
1581
  httpConfig?: HttpDataSourceConfig;
1582
1582
  /**
1583
- * @public
1584
1583
  * <p>Relational database settings.</p>
1584
+ * @public
1585
1585
  */
1586
1586
  relationalDatabaseConfig?: RelationalDatabaseDataSourceConfig;
1587
1587
  /**
1588
- * @public
1589
1588
  * <p>Amazon EventBridge settings.</p>
1589
+ * @public
1590
1590
  */
1591
1591
  eventBridgeConfig?: EventBridgeDataSourceConfig;
1592
1592
  /**
1593
- * @public
1594
1593
  * <p>Enables or disables enhanced data source metrics for specified data sources. Note that
1595
1594
  * <code>metricsConfig</code> won't be used unless the <code>dataSourceLevelMetricsBehavior</code> value is set
1596
1595
  * to <code>PER_DATA_SOURCE_METRICS</code>. If the <code>dataSourceLevelMetricsBehavior</code> is set to
@@ -1598,6 +1597,7 @@ export interface DataSource {
1598
1597
  * you can still set its value.</p>
1599
1598
  * <p>
1600
1599
  * <code>metricsConfig</code> can be <code>ENABLED</code> or <code>DISABLED</code>.</p>
1600
+ * @public
1601
1601
  */
1602
1602
  metricsConfig?: DataSourceLevelMetricsConfig;
1603
1603
  }
@@ -1606,8 +1606,8 @@ export interface DataSource {
1606
1606
  */
1607
1607
  export interface CreateDataSourceResponse {
1608
1608
  /**
1609
- * @public
1610
1609
  * <p>The <code>DataSource</code> object.</p>
1610
+ * @public
1611
1611
  */
1612
1612
  dataSource?: DataSource;
1613
1613
  }
@@ -1616,49 +1616,49 @@ export interface CreateDataSourceResponse {
1616
1616
  */
1617
1617
  export interface CreateDomainNameRequest {
1618
1618
  /**
1619
- * @public
1620
1619
  * <p>The domain name.</p>
1620
+ * @public
1621
1621
  */
1622
1622
  domainName: string | undefined;
1623
1623
  /**
1624
- * @public
1625
1624
  * <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>
1625
+ * @public
1626
1626
  */
1627
1627
  certificateArn: string | undefined;
1628
1628
  /**
1629
- * @public
1630
1629
  * <p>A description of the <code>DomainName</code>.</p>
1630
+ * @public
1631
1631
  */
1632
1632
  description?: string;
1633
1633
  }
1634
1634
  /**
1635
- * @public
1636
1635
  * <p>Describes a configuration for a custom domain.</p>
1636
+ * @public
1637
1637
  */
1638
1638
  export interface DomainNameConfig {
1639
1639
  /**
1640
- * @public
1641
1640
  * <p>The domain name.</p>
1641
+ * @public
1642
1642
  */
1643
1643
  domainName?: string;
1644
1644
  /**
1645
- * @public
1646
1645
  * <p>A description of the <code>DomainName</code> configuration.</p>
1646
+ * @public
1647
1647
  */
1648
1648
  description?: string;
1649
1649
  /**
1650
- * @public
1651
1650
  * <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>
1651
+ * @public
1652
1652
  */
1653
1653
  certificateArn?: string;
1654
1654
  /**
1655
- * @public
1656
1655
  * <p>The domain name that AppSync provides.</p>
1656
+ * @public
1657
1657
  */
1658
1658
  appsyncDomainName?: string;
1659
1659
  /**
1660
- * @public
1661
1660
  * <p>The ID of your Amazon Route 53 hosted zone.</p>
1661
+ * @public
1662
1662
  */
1663
1663
  hostedZoneId?: string;
1664
1664
  }
@@ -1667,8 +1667,8 @@ export interface DomainNameConfig {
1667
1667
  */
1668
1668
  export interface CreateDomainNameResponse {
1669
1669
  /**
1670
- * @public
1671
1670
  * <p>The configuration for the <code>DomainName</code>.</p>
1671
+ * @public
1672
1672
  */
1673
1673
  domainNameConfig?: DomainNameConfig;
1674
1674
  }
@@ -1699,26 +1699,25 @@ export declare const ConflictHandlerType: {
1699
1699
  */
1700
1700
  export type ConflictHandlerType = (typeof ConflictHandlerType)[keyof typeof ConflictHandlerType];
1701
1701
  /**
1702
- * @public
1703
1702
  * <p>The <code>LambdaConflictHandlerConfig</code> object when configuring <code>LAMBDA</code> as the Conflict
1704
1703
  * Handler.</p>
1704
+ * @public
1705
1705
  */
1706
1706
  export interface LambdaConflictHandlerConfig {
1707
1707
  /**
1708
- * @public
1709
1708
  * <p>The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.</p>
1709
+ * @public
1710
1710
  */
1711
1711
  lambdaConflictHandlerArn?: string;
1712
1712
  }
1713
1713
  /**
1714
- * @public
1715
1714
  * <p>Describes a Sync configuration for a resolver.</p>
1716
1715
  * <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is
1717
1716
  * invoked.</p>
1717
+ * @public
1718
1718
  */
1719
1719
  export interface SyncConfig {
1720
1720
  /**
1721
- * @public
1722
1721
  * <p>The Conflict Resolution strategy to perform in the event of a conflict.</p>
1723
1722
  * <ul>
1724
1723
  * <li>
@@ -1737,10 +1736,10 @@ export interface SyncConfig {
1737
1736
  * supplied in the <code>LambdaConflictHandlerConfig</code>.</p>
1738
1737
  * </li>
1739
1738
  * </ul>
1739
+ * @public
1740
1740
  */
1741
1741
  conflictHandler?: ConflictHandlerType;
1742
1742
  /**
1743
- * @public
1744
1743
  * <p>The Conflict Detection strategy to use.</p>
1745
1744
  * <ul>
1746
1745
  * <li>
@@ -1754,12 +1753,13 @@ export interface SyncConfig {
1754
1753
  * resolver.</p>
1755
1754
  * </li>
1756
1755
  * </ul>
1756
+ * @public
1757
1757
  */
1758
1758
  conflictDetection?: ConflictDetectionType;
1759
1759
  /**
1760
- * @public
1761
1760
  * <p>The <code>LambdaConflictHandlerConfig</code> when configuring <code>LAMBDA</code> as the Conflict
1762
1761
  * Handler.</p>
1762
+ * @public
1763
1763
  */
1764
1764
  lambdaConflictHandlerConfig?: LambdaConflictHandlerConfig;
1765
1765
  }
@@ -1768,139 +1768,139 @@ export interface SyncConfig {
1768
1768
  */
1769
1769
  export interface CreateFunctionRequest {
1770
1770
  /**
1771
- * @public
1772
1771
  * <p>The GraphQL API ID.</p>
1772
+ * @public
1773
1773
  */
1774
1774
  apiId: string | undefined;
1775
1775
  /**
1776
- * @public
1777
1776
  * <p>The <code>Function</code> name. The function name does not have to be unique.</p>
1777
+ * @public
1778
1778
  */
1779
1779
  name: string | undefined;
1780
1780
  /**
1781
- * @public
1782
1781
  * <p>The <code>Function</code> description.</p>
1782
+ * @public
1783
1783
  */
1784
1784
  description?: string;
1785
1785
  /**
1786
- * @public
1787
1786
  * <p>The <code>Function</code>
1788
1787
  * <code>DataSource</code> name.</p>
1788
+ * @public
1789
1789
  */
1790
1790
  dataSourceName: string | undefined;
1791
1791
  /**
1792
- * @public
1793
1792
  * <p>The <code>Function</code> request mapping template. Functions support only the 2018-05-29 version of the
1794
1793
  * request mapping template.</p>
1794
+ * @public
1795
1795
  */
1796
1796
  requestMappingTemplate?: string;
1797
1797
  /**
1798
- * @public
1799
1798
  * <p>The <code>Function</code> response mapping template.</p>
1799
+ * @public
1800
1800
  */
1801
1801
  responseMappingTemplate?: string;
1802
1802
  /**
1803
- * @public
1804
1803
  * <p>The <code>version</code> of the request mapping template. Currently, the supported value is 2018-05-29. Note
1805
1804
  * that when using VTL and mapping templates, the <code>functionVersion</code> is required.</p>
1805
+ * @public
1806
1806
  */
1807
1807
  functionVersion?: string;
1808
1808
  /**
1809
- * @public
1810
1809
  * <p>Describes a Sync configuration for a resolver.</p>
1811
1810
  * <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is
1812
1811
  * invoked.</p>
1812
+ * @public
1813
1813
  */
1814
1814
  syncConfig?: SyncConfig;
1815
1815
  /**
1816
- * @public
1817
1816
  * <p>The maximum batching size for a resolver.</p>
1817
+ * @public
1818
1818
  */
1819
1819
  maxBatchSize?: number;
1820
1820
  /**
1821
- * @public
1822
1821
  * <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
1823
1822
  * function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must
1824
1823
  * also be specified.</p>
1824
+ * @public
1825
1825
  */
1826
1826
  runtime?: AppSyncRuntime;
1827
1827
  /**
1828
- * @public
1829
1828
  * <p>The <code>function</code> code that contains the request and response functions. When code is used, the
1830
1829
  * <code>runtime</code> is required. The <code>runtime</code> value must be <code>APPSYNC_JS</code>.</p>
1830
+ * @public
1831
1831
  */
1832
1832
  code?: string;
1833
1833
  }
1834
1834
  /**
1835
- * @public
1836
1835
  * <p>A function is a reusable entity. You can use multiple functions to compose the resolver logic.</p>
1836
+ * @public
1837
1837
  */
1838
1838
  export interface FunctionConfiguration {
1839
1839
  /**
1840
- * @public
1841
1840
  * <p>A unique ID representing the <code>Function</code> object.</p>
1841
+ * @public
1842
1842
  */
1843
1843
  functionId?: string;
1844
1844
  /**
1845
- * @public
1846
1845
  * <p>The Amazon Resource Name (ARN) of the <code>Function</code> object.</p>
1846
+ * @public
1847
1847
  */
1848
1848
  functionArn?: string;
1849
1849
  /**
1850
- * @public
1851
1850
  * <p>The name of the <code>Function</code> object.</p>
1851
+ * @public
1852
1852
  */
1853
1853
  name?: string;
1854
1854
  /**
1855
- * @public
1856
1855
  * <p>The <code>Function</code> description.</p>
1856
+ * @public
1857
1857
  */
1858
1858
  description?: string;
1859
1859
  /**
1860
- * @public
1861
1860
  * <p>The name of the <code>DataSource</code>.</p>
1861
+ * @public
1862
1862
  */
1863
1863
  dataSourceName?: string;
1864
1864
  /**
1865
- * @public
1866
1865
  * <p>The <code>Function</code> request mapping template. Functions support only the 2018-05-29 version of the
1867
1866
  * request mapping template.</p>
1867
+ * @public
1868
1868
  */
1869
1869
  requestMappingTemplate?: string;
1870
1870
  /**
1871
- * @public
1872
1871
  * <p>The <code>Function</code> response mapping template.</p>
1872
+ * @public
1873
1873
  */
1874
1874
  responseMappingTemplate?: string;
1875
1875
  /**
1876
- * @public
1877
1876
  * <p>The version of the request mapping template. Currently, only the 2018-05-29 version of the template is
1878
1877
  * supported.</p>
1878
+ * @public
1879
1879
  */
1880
1880
  functionVersion?: string;
1881
1881
  /**
1882
- * @public
1883
1882
  * <p>Describes a Sync configuration for a resolver.</p>
1884
1883
  * <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is
1885
1884
  * invoked.</p>
1885
+ * @public
1886
1886
  */
1887
1887
  syncConfig?: SyncConfig;
1888
1888
  /**
1889
- * @public
1890
1889
  * <p>The maximum batching size for a resolver.</p>
1890
+ * @public
1891
1891
  */
1892
1892
  maxBatchSize?: number;
1893
1893
  /**
1894
- * @public
1895
1894
  * <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
1896
1895
  * function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must
1897
1896
  * also be specified.</p>
1897
+ * @public
1898
1898
  */
1899
1899
  runtime?: AppSyncRuntime;
1900
1900
  /**
1901
- * @public
1902
1901
  * <p>The <code>function</code> code that contains the request and response functions. When code is used, the
1903
1902
  * <code>runtime</code> is required. The <code>runtime</code> value must be <code>APPSYNC_JS</code>.</p>
1903
+ * @public
1904
1904
  */
1905
1905
  code?: string;
1906
1906
  }
@@ -1909,8 +1909,8 @@ export interface FunctionConfiguration {
1909
1909
  */
1910
1910
  export interface CreateFunctionResponse {
1911
1911
  /**
1912
- * @public
1913
1912
  * <p>The <code>Function</code> object.</p>
1913
+ * @public
1914
1914
  */
1915
1915
  functionConfiguration?: FunctionConfiguration;
1916
1916
  }
@@ -1963,7 +1963,6 @@ export declare const ResolverLevelMetricsBehavior: {
1963
1963
  */
1964
1964
  export type ResolverLevelMetricsBehavior = (typeof ResolverLevelMetricsBehavior)[keyof typeof ResolverLevelMetricsBehavior];
1965
1965
  /**
1966
- * @public
1967
1966
  * <p>Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and
1968
1967
  * performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data
1969
1968
  * is sent to your CloudWatch account, and you can configure the types of data that will be sent. </p>
@@ -2056,10 +2055,10 @@ export type ResolverLevelMetricsBehavior = (typeof ResolverLevelMetricsBehavior)
2056
2055
  * or <code>DISABLED</code>.</p>
2057
2056
  * </li>
2058
2057
  * </ol>
2058
+ * @public
2059
2059
  */
2060
2060
  export interface EnhancedMetricsConfig {
2061
2061
  /**
2062
- * @public
2063
2062
  * <p>Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:</p>
2064
2063
  * <ul>
2065
2064
  * <li>
@@ -2093,10 +2092,10 @@ export interface EnhancedMetricsConfig {
2093
2092
  * <code>metricsConfig</code> value set to <code>ENABLED</code>.</p>
2094
2093
  * </li>
2095
2094
  * </ul>
2095
+ * @public
2096
2096
  */
2097
2097
  resolverLevelMetricsBehavior: ResolverLevelMetricsBehavior | undefined;
2098
2098
  /**
2099
- * @public
2100
2099
  * <p>Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:</p>
2101
2100
  * <ul>
2102
2101
  * <li>
@@ -2124,10 +2123,10 @@ export interface EnhancedMetricsConfig {
2124
2123
  * <code>metricsConfig</code> value set to <code>ENABLED</code>.</p>
2125
2124
  * </li>
2126
2125
  * </ul>
2126
+ * @public
2127
2127
  */
2128
2128
  dataSourceLevelMetricsBehavior: DataSourceLevelMetricsBehavior | undefined;
2129
2129
  /**
2130
- * @public
2131
2130
  * <p> Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:</p>
2132
2131
  * <ul>
2133
2132
  * <li>
@@ -2140,6 +2139,7 @@ export interface EnhancedMetricsConfig {
2140
2139
  * </ul>
2141
2140
  * <p>Metrics will be recorded by API ID and operation name. You can set the value to <code>ENABLED</code> or
2142
2141
  * <code>DISABLED</code>.</p>
2142
+ * @public
2143
2143
  */
2144
2144
  operationLevelMetricsConfig: OperationLevelMetricsConfig | undefined;
2145
2145
  }
@@ -2169,12 +2169,11 @@ export declare const FieldLogLevel: {
2169
2169
  */
2170
2170
  export type FieldLogLevel = (typeof FieldLogLevel)[keyof typeof FieldLogLevel];
2171
2171
  /**
2172
- * @public
2173
2172
  * <p>The Amazon CloudWatch Logs configuration.</p>
2173
+ * @public
2174
2174
  */
2175
2175
  export interface LogConfig {
2176
2176
  /**
2177
- * @public
2178
2177
  * <p>The field logging level. Values can be NONE, ERROR, or ALL.</p>
2179
2178
  * <ul>
2180
2179
  * <li>
@@ -2211,18 +2210,19 @@ export interface LogConfig {
2211
2210
  * </ul>
2212
2211
  * </li>
2213
2212
  * </ul>
2213
+ * @public
2214
2214
  */
2215
2215
  fieldLogLevel: FieldLogLevel | undefined;
2216
2216
  /**
2217
- * @public
2218
2217
  * <p>The service role that AppSync assumes to publish to CloudWatch logs in your
2219
2218
  * account.</p>
2219
+ * @public
2220
2220
  */
2221
2221
  cloudWatchLogsRoleArn: string | undefined;
2222
2222
  /**
2223
- * @public
2224
2223
  * <p>Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping
2225
2224
  * templates, regardless of logging level.</p>
2225
+ * @public
2226
2226
  */
2227
2227
  excludeVerboseContent?: boolean;
2228
2228
  }
@@ -2239,30 +2239,30 @@ export declare const DefaultAction: {
2239
2239
  */
2240
2240
  export type DefaultAction = (typeof DefaultAction)[keyof typeof DefaultAction];
2241
2241
  /**
2242
- * @public
2243
2242
  * <p>Describes an Amazon Cognito user pool configuration.</p>
2243
+ * @public
2244
2244
  */
2245
2245
  export interface UserPoolConfig {
2246
2246
  /**
2247
- * @public
2248
2247
  * <p>The user pool ID.</p>
2248
+ * @public
2249
2249
  */
2250
2250
  userPoolId: string | undefined;
2251
2251
  /**
2252
- * @public
2253
2252
  * <p>The Amazon Web Services Region in which the user pool was created.</p>
2253
+ * @public
2254
2254
  */
2255
2255
  awsRegion: string | undefined;
2256
2256
  /**
2257
- * @public
2258
2257
  * <p>The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool
2259
2258
  * authentication doesn't match the Amazon Cognito user pool configuration.</p>
2259
+ * @public
2260
2260
  */
2261
2261
  defaultAction: DefaultAction | undefined;
2262
2262
  /**
2263
- * @public
2264
2263
  * <p>A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value
2265
2264
  * isn't set, no filtering is applied.</p>
2265
+ * @public
2266
2266
  */
2267
2267
  appIdClientRegex?: string;
2268
2268
  }
@@ -2283,249 +2283,249 @@ export type GraphQLApiVisibility = (typeof GraphQLApiVisibility)[keyof typeof Gr
2283
2283
  */
2284
2284
  export interface CreateGraphqlApiRequest {
2285
2285
  /**
2286
- * @public
2287
2286
  * <p>A user-supplied name for the <code>GraphqlApi</code>.</p>
2287
+ * @public
2288
2288
  */
2289
2289
  name: string | undefined;
2290
2290
  /**
2291
- * @public
2292
2291
  * <p>The Amazon CloudWatch Logs configuration.</p>
2292
+ * @public
2293
2293
  */
2294
2294
  logConfig?: LogConfig;
2295
2295
  /**
2296
- * @public
2297
2296
  * <p>The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC),
2298
2297
  * Amazon Cognito user pools, or Lambda.</p>
2298
+ * @public
2299
2299
  */
2300
2300
  authenticationType: AuthenticationType | undefined;
2301
2301
  /**
2302
- * @public
2303
2302
  * <p>The Amazon Cognito user pool configuration.</p>
2303
+ * @public
2304
2304
  */
2305
2305
  userPoolConfig?: UserPoolConfig;
2306
2306
  /**
2307
- * @public
2308
2307
  * <p>The OIDC configuration.</p>
2308
+ * @public
2309
2309
  */
2310
2310
  openIDConnectConfig?: OpenIDConnectConfig;
2311
2311
  /**
2312
- * @public
2313
2312
  * <p>A <code>TagMap</code> object.</p>
2313
+ * @public
2314
2314
  */
2315
2315
  tags?: Record<string, string>;
2316
2316
  /**
2317
- * @public
2318
2317
  * <p>A list of additional authentication providers for the <code>GraphqlApi</code> API.</p>
2318
+ * @public
2319
2319
  */
2320
2320
  additionalAuthenticationProviders?: AdditionalAuthenticationProvider[];
2321
2321
  /**
2322
- * @public
2323
2322
  * <p>A flag indicating whether to use X-Ray tracing for the <code>GraphqlApi</code>.</p>
2323
+ * @public
2324
2324
  */
2325
2325
  xrayEnabled?: boolean;
2326
2326
  /**
2327
- * @public
2328
2327
  * <p>Configuration for Lambda function authorization.</p>
2328
+ * @public
2329
2329
  */
2330
2330
  lambdaAuthorizerConfig?: LambdaAuthorizerConfig;
2331
2331
  /**
2332
- * @public
2333
2332
  * <p>Sets the value of the GraphQL API to public (<code>GLOBAL</code>) or private (<code>PRIVATE</code>). If no
2334
2333
  * value is provided, the visibility will be set to <code>GLOBAL</code> by default. This value cannot be changed
2335
2334
  * once the API has been created.</p>
2335
+ * @public
2336
2336
  */
2337
2337
  visibility?: GraphQLApiVisibility;
2338
2338
  /**
2339
- * @public
2340
2339
  * <p>The value that indicates whether the GraphQL API is a standard API (<code>GRAPHQL</code>) or merged API
2341
2340
  * (<code>MERGED</code>).</p>
2341
+ * @public
2342
2342
  */
2343
2343
  apiType?: GraphQLApiType;
2344
2344
  /**
2345
- * @public
2346
2345
  * <p>The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role
2347
2346
  * on behalf of the Merged API to validate access to source APIs at runtime and to prompt the
2348
2347
  * <code>AUTO_MERGE</code> to update the merged API endpoint with the source API changes automatically.</p>
2348
+ * @public
2349
2349
  */
2350
2350
  mergedApiExecutionRoleArn?: string;
2351
2351
  /**
2352
- * @public
2353
2352
  * <p>The owner contact information for an API resource.</p>
2354
2353
  * <p>This field accepts any string input with a length of 0 - 256 characters.</p>
2354
+ * @public
2355
2355
  */
2356
2356
  ownerContact?: string;
2357
2357
  /**
2358
- * @public
2359
2358
  * <p>Sets the value of the GraphQL API to enable (<code>ENABLED</code>) or disable (<code>DISABLED</code>)
2360
2359
  * introspection. If no value is provided, the introspection configuration will be set to <code>ENABLED</code> by
2361
2360
  * default. This field will produce an error if the operation attempts to use the introspection feature while this
2362
2361
  * field is disabled.</p>
2363
2362
  * <p>For more information about introspection, see <a href="https://graphql.org/learn/introspection/">GraphQL
2364
2363
  * introspection</a>.</p>
2364
+ * @public
2365
2365
  */
2366
2366
  introspectionConfig?: GraphQLApiIntrospectionConfig;
2367
2367
  /**
2368
- * @public
2369
2368
  * <p>The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed
2370
2369
  * in the body of query. The default value is <code>0</code> (or unspecified), which indicates there's no depth
2371
2370
  * limit. If you set a limit, it can be between <code>1</code> and <code>75</code> nested levels. This field will
2372
2371
  * produce a limit error if the operation falls out of bounds.</p>
2373
2372
  * <p>Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error,
2374
2373
  * the error will be thrown upwards to the first nullable field available.</p>
2374
+ * @public
2375
2375
  */
2376
2376
  queryDepthLimit?: number;
2377
2377
  /**
2378
- * @public
2379
2378
  * <p>The maximum number of resolvers that can be invoked in a single request. The default value is <code>0</code>
2380
2379
  * (or unspecified), which will set the limit to <code>10000</code>. When specified, the limit value can be
2381
2380
  * between <code>1</code> and <code>10000</code>. This field will produce a limit error if the operation falls out
2382
2381
  * of bounds.</p>
2382
+ * @public
2383
2383
  */
2384
2384
  resolverCountLimit?: number;
2385
2385
  /**
2386
- * @public
2387
2386
  * <p>The <code>enhancedMetricsConfig</code> object.</p>
2387
+ * @public
2388
2388
  */
2389
2389
  enhancedMetricsConfig?: EnhancedMetricsConfig;
2390
2390
  }
2391
2391
  /**
2392
- * @public
2393
2392
  * <p>Describes a GraphQL API.</p>
2393
+ * @public
2394
2394
  */
2395
2395
  export interface GraphqlApi {
2396
2396
  /**
2397
- * @public
2398
2397
  * <p>The API name.</p>
2398
+ * @public
2399
2399
  */
2400
2400
  name?: string;
2401
2401
  /**
2402
- * @public
2403
2402
  * <p>The API ID.</p>
2403
+ * @public
2404
2404
  */
2405
2405
  apiId?: string;
2406
2406
  /**
2407
- * @public
2408
2407
  * <p>The authentication type.</p>
2408
+ * @public
2409
2409
  */
2410
2410
  authenticationType?: AuthenticationType;
2411
2411
  /**
2412
- * @public
2413
2412
  * <p>The Amazon CloudWatch Logs configuration.</p>
2413
+ * @public
2414
2414
  */
2415
2415
  logConfig?: LogConfig;
2416
2416
  /**
2417
- * @public
2418
2417
  * <p>The Amazon Cognito user pool configuration.</p>
2418
+ * @public
2419
2419
  */
2420
2420
  userPoolConfig?: UserPoolConfig;
2421
2421
  /**
2422
- * @public
2423
2422
  * <p>The OpenID Connect configuration.</p>
2423
+ * @public
2424
2424
  */
2425
2425
  openIDConnectConfig?: OpenIDConnectConfig;
2426
2426
  /**
2427
- * @public
2428
2427
  * <p>The Amazon Resource Name (ARN).</p>
2428
+ * @public
2429
2429
  */
2430
2430
  arn?: string;
2431
2431
  /**
2432
- * @public
2433
2432
  * <p>The URIs.</p>
2433
+ * @public
2434
2434
  */
2435
2435
  uris?: Record<string, string>;
2436
2436
  /**
2437
- * @public
2438
2437
  * <p>The tags.</p>
2438
+ * @public
2439
2439
  */
2440
2440
  tags?: Record<string, string>;
2441
2441
  /**
2442
- * @public
2443
2442
  * <p>A list of additional authentication providers for the <code>GraphqlApi</code> API.</p>
2443
+ * @public
2444
2444
  */
2445
2445
  additionalAuthenticationProviders?: AdditionalAuthenticationProvider[];
2446
2446
  /**
2447
- * @public
2448
2447
  * <p>A flag indicating whether to use X-Ray tracing for this <code>GraphqlApi</code>.</p>
2448
+ * @public
2449
2449
  */
2450
2450
  xrayEnabled?: boolean;
2451
2451
  /**
2452
- * @public
2453
2452
  * <p>The ARN of the WAF access control list (ACL) associated with this
2454
2453
  * <code>GraphqlApi</code>, if one exists.</p>
2454
+ * @public
2455
2455
  */
2456
2456
  wafWebAclArn?: string;
2457
2457
  /**
2458
- * @public
2459
2458
  * <p>Configuration for Lambda function authorization.</p>
2459
+ * @public
2460
2460
  */
2461
2461
  lambdaAuthorizerConfig?: LambdaAuthorizerConfig;
2462
2462
  /**
2463
- * @public
2464
2463
  * <p>The DNS records for the API.</p>
2464
+ * @public
2465
2465
  */
2466
2466
  dns?: Record<string, string>;
2467
2467
  /**
2468
- * @public
2469
2468
  * <p>Sets the value of the GraphQL API to public (<code>GLOBAL</code>) or private (<code>PRIVATE</code>). If no
2470
2469
  * value is provided, the visibility will be set to <code>GLOBAL</code> by default. This value cannot be changed
2471
2470
  * once the API has been created.</p>
2471
+ * @public
2472
2472
  */
2473
2473
  visibility?: GraphQLApiVisibility;
2474
2474
  /**
2475
- * @public
2476
2475
  * <p>The value that indicates whether the GraphQL API is a standard API (<code>GRAPHQL</code>) or merged API
2477
2476
  * (<code>MERGED</code>).</p>
2477
+ * @public
2478
2478
  */
2479
2479
  apiType?: GraphQLApiType;
2480
2480
  /**
2481
- * @public
2482
2481
  * <p>The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role
2483
2482
  * on behalf of the Merged API to validate access to source APIs at runtime and to prompt the
2484
2483
  * <code>AUTO_MERGE</code> to update the merged API endpoint with the source API changes automatically.</p>
2484
+ * @public
2485
2485
  */
2486
2486
  mergedApiExecutionRoleArn?: string;
2487
2487
  /**
2488
- * @public
2489
2488
  * <p>The account owner of the GraphQL API.</p>
2489
+ * @public
2490
2490
  */
2491
2491
  owner?: string;
2492
2492
  /**
2493
- * @public
2494
2493
  * <p>The owner contact information for an API resource.</p>
2495
2494
  * <p>This field accepts any string input with a length of 0 - 256 characters.</p>
2495
+ * @public
2496
2496
  */
2497
2497
  ownerContact?: string;
2498
2498
  /**
2499
- * @public
2500
2499
  * <p>Sets the value of the GraphQL API to enable (<code>ENABLED</code>) or disable (<code>DISABLED</code>)
2501
2500
  * introspection. If no value is provided, the introspection configuration will be set to <code>ENABLED</code> by
2502
2501
  * default. This field will produce an error if the operation attempts to use the introspection feature while this
2503
2502
  * field is disabled.</p>
2504
2503
  * <p>For more information about introspection, see <a href="https://graphql.org/learn/introspection/">GraphQL
2505
2504
  * introspection</a>.</p>
2505
+ * @public
2506
2506
  */
2507
2507
  introspectionConfig?: GraphQLApiIntrospectionConfig;
2508
2508
  /**
2509
- * @public
2510
2509
  * <p>The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed
2511
2510
  * in the body of query. The default value is <code>0</code> (or unspecified), which indicates there's no depth
2512
2511
  * limit. If you set a limit, it can be between <code>1</code> and <code>75</code> nested levels. This field will
2513
2512
  * produce a limit error if the operation falls out of bounds.</p>
2514
2513
  * <p>Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error,
2515
2514
  * the error will be thrown upwards to the first nullable field available.</p>
2515
+ * @public
2516
2516
  */
2517
2517
  queryDepthLimit?: number;
2518
2518
  /**
2519
- * @public
2520
2519
  * <p>The maximum number of resolvers that can be invoked in a single request. The default value is <code>0</code>
2521
2520
  * (or unspecified), which will set the limit to <code>10000</code>. When specified, the limit value can be
2522
2521
  * between <code>1</code> and <code>10000</code>. This field will produce a limit error if the operation falls out
2523
2522
  * of bounds.</p>
2523
+ * @public
2524
2524
  */
2525
2525
  resolverCountLimit?: number;
2526
2526
  /**
2527
- * @public
2528
2527
  * <p>The <code>enhancedMetricsConfig</code> object.</p>
2528
+ * @public
2529
2529
  */
2530
2530
  enhancedMetricsConfig?: EnhancedMetricsConfig;
2531
2531
  }
@@ -2534,27 +2534,27 @@ export interface GraphqlApi {
2534
2534
  */
2535
2535
  export interface CreateGraphqlApiResponse {
2536
2536
  /**
2537
- * @public
2538
2537
  * <p>The <code>GraphqlApi</code>.</p>
2538
+ * @public
2539
2539
  */
2540
2540
  graphqlApi?: GraphqlApi;
2541
2541
  }
2542
2542
  /**
2543
- * @public
2544
2543
  * <p>The caching configuration for a resolver that has caching activated.</p>
2544
+ * @public
2545
2545
  */
2546
2546
  export interface CachingConfig {
2547
2547
  /**
2548
- * @public
2549
2548
  * <p>The TTL in seconds for a resolver that has caching activated.</p>
2550
2549
  * <p>Valid values are 1–3,600 seconds.</p>
2550
+ * @public
2551
2551
  */
2552
2552
  ttl: number | undefined;
2553
2553
  /**
2554
- * @public
2555
2554
  * <p>The caching keys for a resolver that has caching activated.</p>
2556
2555
  * <p>Valid values are entries from the <code>$context.arguments</code>, <code>$context.source</code>, and
2557
2556
  * <code>$context.identity</code> maps.</p>
2557
+ * @public
2558
2558
  */
2559
2559
  cachingKeys?: string[];
2560
2560
  }
@@ -2583,13 +2583,13 @@ export declare const ResolverLevelMetricsConfig: {
2583
2583
  */
2584
2584
  export type ResolverLevelMetricsConfig = (typeof ResolverLevelMetricsConfig)[keyof typeof ResolverLevelMetricsConfig];
2585
2585
  /**
2586
- * @public
2587
2586
  * <p>The pipeline configuration for a resolver of kind <code>PIPELINE</code>.</p>
2587
+ * @public
2588
2588
  */
2589
2589
  export interface PipelineConfig {
2590
2590
  /**
2591
- * @public
2592
2591
  * <p>A list of <code>Function</code> objects.</p>
2592
+ * @public
2593
2593
  */
2594
2594
  functions?: string[];
2595
2595
  }
@@ -2598,41 +2598,40 @@ export interface PipelineConfig {
2598
2598
  */
2599
2599
  export interface CreateResolverRequest {
2600
2600
  /**
2601
- * @public
2602
2601
  * <p>The ID for the GraphQL API for which the resolver is being created.</p>
2602
+ * @public
2603
2603
  */
2604
2604
  apiId: string | undefined;
2605
2605
  /**
2606
- * @public
2607
2606
  * <p>The name of the <code>Type</code>.</p>
2607
+ * @public
2608
2608
  */
2609
2609
  typeName: string | undefined;
2610
2610
  /**
2611
- * @public
2612
2611
  * <p>The name of the field to attach the resolver to.</p>
2612
+ * @public
2613
2613
  */
2614
2614
  fieldName: string | undefined;
2615
2615
  /**
2616
- * @public
2617
2616
  * <p>The name of the data source for which the resolver is being created.</p>
2617
+ * @public
2618
2618
  */
2619
2619
  dataSourceName?: string;
2620
2620
  /**
2621
- * @public
2622
2621
  * <p>The mapping template to use for requests.</p>
2623
2622
  * <p>A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source
2624
2623
  * can understand. Mapping templates are written in Apache Velocity Template Language (VTL).</p>
2625
2624
  * <p>VTL request mapping templates are optional when using an Lambda data source. For all other
2626
2625
  * data sources, VTL request and response mapping templates are required.</p>
2626
+ * @public
2627
2627
  */
2628
2628
  requestMappingTemplate?: string;
2629
2629
  /**
2630
- * @public
2631
2630
  * <p>The mapping template to use for responses from the data source.</p>
2631
+ * @public
2632
2632
  */
2633
2633
  responseMappingTemplate?: string;
2634
2634
  /**
2635
- * @public
2636
2635
  * <p>The resolver type.</p>
2637
2636
  * <ul>
2638
2637
  * <li>
@@ -2647,43 +2646,43 @@ export interface CreateResolverRequest {
2647
2646
  * resolver to run a GraphQL query against multiple data sources.</p>
2648
2647
  * </li>
2649
2648
  * </ul>
2649
+ * @public
2650
2650
  */
2651
2651
  kind?: ResolverKind;
2652
2652
  /**
2653
- * @public
2654
2653
  * <p>The <code>PipelineConfig</code>.</p>
2654
+ * @public
2655
2655
  */
2656
2656
  pipelineConfig?: PipelineConfig;
2657
2657
  /**
2658
- * @public
2659
2658
  * <p>The <code>SyncConfig</code> for a resolver attached to a versioned data source.</p>
2659
+ * @public
2660
2660
  */
2661
2661
  syncConfig?: SyncConfig;
2662
2662
  /**
2663
- * @public
2664
2663
  * <p>The caching configuration for the resolver.</p>
2664
+ * @public
2665
2665
  */
2666
2666
  cachingConfig?: CachingConfig;
2667
2667
  /**
2668
- * @public
2669
2668
  * <p>The maximum batching size for a resolver.</p>
2669
+ * @public
2670
2670
  */
2671
2671
  maxBatchSize?: number;
2672
2672
  /**
2673
- * @public
2674
2673
  * <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
2675
2674
  * function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must
2676
2675
  * also be specified.</p>
2676
+ * @public
2677
2677
  */
2678
2678
  runtime?: AppSyncRuntime;
2679
2679
  /**
2680
- * @public
2681
2680
  * <p>The <code>resolver</code> code that contains the request and response functions. When code is used, the
2682
2681
  * <code>runtime</code> is required. The <code>runtime</code> value must be <code>APPSYNC_JS</code>.</p>
2682
+ * @public
2683
2683
  */
2684
2684
  code?: string;
2685
2685
  /**
2686
- * @public
2687
2686
  * <p>Enables or disables enhanced resolver metrics for specified resolvers. Note that <code>metricsConfig</code>
2688
2687
  * won't be used unless the <code>resolverLevelMetricsBehavior</code> value is set to
2689
2688
  * <code>PER_RESOLVER_METRICS</code>. If the <code>resolverLevelMetricsBehavior</code> is set to
@@ -2691,46 +2690,46 @@ export interface CreateResolverRequest {
2691
2690
  * can still set its value.</p>
2692
2691
  * <p>
2693
2692
  * <code>metricsConfig</code> can be <code>ENABLED</code> or <code>DISABLED</code>.</p>
2693
+ * @public
2694
2694
  */
2695
2695
  metricsConfig?: ResolverLevelMetricsConfig;
2696
2696
  }
2697
2697
  /**
2698
- * @public
2699
2698
  * <p>Describes a resolver.</p>
2699
+ * @public
2700
2700
  */
2701
2701
  export interface Resolver {
2702
2702
  /**
2703
- * @public
2704
2703
  * <p>The resolver type name.</p>
2704
+ * @public
2705
2705
  */
2706
2706
  typeName?: string;
2707
2707
  /**
2708
- * @public
2709
2708
  * <p>The resolver field name.</p>
2709
+ * @public
2710
2710
  */
2711
2711
  fieldName?: string;
2712
2712
  /**
2713
- * @public
2714
2713
  * <p>The resolver data source name.</p>
2714
+ * @public
2715
2715
  */
2716
2716
  dataSourceName?: string;
2717
2717
  /**
2718
- * @public
2719
2718
  * <p>The resolver Amazon Resource Name (ARN).</p>
2719
+ * @public
2720
2720
  */
2721
2721
  resolverArn?: string;
2722
2722
  /**
2723
- * @public
2724
2723
  * <p>The request mapping template.</p>
2724
+ * @public
2725
2725
  */
2726
2726
  requestMappingTemplate?: string;
2727
2727
  /**
2728
- * @public
2729
2728
  * <p>The response mapping template.</p>
2729
+ * @public
2730
2730
  */
2731
2731
  responseMappingTemplate?: string;
2732
2732
  /**
2733
- * @public
2734
2733
  * <p>The resolver type.</p>
2735
2734
  * <ul>
2736
2735
  * <li>
@@ -2745,43 +2744,43 @@ export interface Resolver {
2745
2744
  * resolver to run a GraphQL query against multiple data sources.</p>
2746
2745
  * </li>
2747
2746
  * </ul>
2747
+ * @public
2748
2748
  */
2749
2749
  kind?: ResolverKind;
2750
2750
  /**
2751
- * @public
2752
2751
  * <p>The <code>PipelineConfig</code>.</p>
2752
+ * @public
2753
2753
  */
2754
2754
  pipelineConfig?: PipelineConfig;
2755
2755
  /**
2756
- * @public
2757
2756
  * <p>The <code>SyncConfig</code> for a resolver attached to a versioned data source.</p>
2757
+ * @public
2758
2758
  */
2759
2759
  syncConfig?: SyncConfig;
2760
2760
  /**
2761
- * @public
2762
2761
  * <p>The caching configuration for the resolver.</p>
2762
+ * @public
2763
2763
  */
2764
2764
  cachingConfig?: CachingConfig;
2765
2765
  /**
2766
- * @public
2767
2766
  * <p>The maximum batching size for a resolver.</p>
2767
+ * @public
2768
2768
  */
2769
2769
  maxBatchSize?: number;
2770
2770
  /**
2771
- * @public
2772
2771
  * <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
2773
2772
  * function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must
2774
2773
  * also be specified.</p>
2774
+ * @public
2775
2775
  */
2776
2776
  runtime?: AppSyncRuntime;
2777
2777
  /**
2778
- * @public
2779
2778
  * <p>The <code>resolver</code> code that contains the request and response functions. When code is used, the
2780
2779
  * <code>runtime</code> is required. The <code>runtime</code> value must be <code>APPSYNC_JS</code>.</p>
2780
+ * @public
2781
2781
  */
2782
2782
  code?: string;
2783
2783
  /**
2784
- * @public
2785
2784
  * <p>Enables or disables enhanced resolver metrics for specified resolvers. Note that <code>metricsConfig</code>
2786
2785
  * won't be used unless the <code>resolverLevelMetricsBehavior</code> value is set to
2787
2786
  * <code>PER_RESOLVER_METRICS</code>. If the <code>resolverLevelMetricsBehavior</code> is set to
@@ -2789,6 +2788,7 @@ export interface Resolver {
2789
2788
  * can still set its value.</p>
2790
2789
  * <p>
2791
2790
  * <code>metricsConfig</code> can be <code>ENABLED</code> or <code>DISABLED</code>.</p>
2791
+ * @public
2792
2792
  */
2793
2793
  metricsConfig?: ResolverLevelMetricsConfig;
2794
2794
  }
@@ -2797,8 +2797,8 @@ export interface Resolver {
2797
2797
  */
2798
2798
  export interface CreateResolverResponse {
2799
2799
  /**
2800
- * @public
2801
2800
  * <p>The <code>Resolver</code> object.</p>
2801
+ * @public
2802
2802
  */
2803
2803
  resolver?: Resolver;
2804
2804
  }
@@ -2819,51 +2819,51 @@ export type TypeDefinitionFormat = (typeof TypeDefinitionFormat)[keyof typeof Ty
2819
2819
  */
2820
2820
  export interface CreateTypeRequest {
2821
2821
  /**
2822
- * @public
2823
2822
  * <p>The API ID.</p>
2823
+ * @public
2824
2824
  */
2825
2825
  apiId: string | undefined;
2826
2826
  /**
2827
- * @public
2828
2827
  * <p>The type definition, in GraphQL Schema Definition Language (SDL) format.</p>
2829
2828
  * <p>For more information, see the <a href="http://graphql.org/learn/schema/">GraphQL SDL
2830
2829
  * documentation</a>.</p>
2830
+ * @public
2831
2831
  */
2832
2832
  definition: string | undefined;
2833
2833
  /**
2834
- * @public
2835
2834
  * <p>The type format: SDL or JSON.</p>
2835
+ * @public
2836
2836
  */
2837
2837
  format: TypeDefinitionFormat | undefined;
2838
2838
  }
2839
2839
  /**
2840
- * @public
2841
2840
  * <p>Describes a type.</p>
2841
+ * @public
2842
2842
  */
2843
2843
  export interface Type {
2844
2844
  /**
2845
- * @public
2846
2845
  * <p>The type name.</p>
2846
+ * @public
2847
2847
  */
2848
2848
  name?: string;
2849
2849
  /**
2850
- * @public
2851
2850
  * <p>The type description.</p>
2851
+ * @public
2852
2852
  */
2853
2853
  description?: string;
2854
2854
  /**
2855
- * @public
2856
2855
  * <p>The type Amazon Resource Name (ARN).</p>
2856
+ * @public
2857
2857
  */
2858
2858
  arn?: string;
2859
2859
  /**
2860
- * @public
2861
2860
  * <p>The type definition.</p>
2861
+ * @public
2862
2862
  */
2863
2863
  definition?: string;
2864
2864
  /**
2865
- * @public
2866
2865
  * <p>The type format: SDL or JSON.</p>
2866
+ * @public
2867
2867
  */
2868
2868
  format?: TypeDefinitionFormat;
2869
2869
  }
@@ -2872,25 +2872,25 @@ export interface Type {
2872
2872
  */
2873
2873
  export interface CreateTypeResponse {
2874
2874
  /**
2875
- * @public
2876
2875
  * <p>The <code>Type</code> object.</p>
2876
+ * @public
2877
2877
  */
2878
2878
  type?: Type;
2879
2879
  }
2880
2880
  /**
2881
- * @public
2882
2881
  * <p>Represents the input of a <code>DeleteApiCache</code> operation.</p>
2882
+ * @public
2883
2883
  */
2884
2884
  export interface DeleteApiCacheRequest {
2885
2885
  /**
2886
- * @public
2887
2886
  * <p>The API ID.</p>
2887
+ * @public
2888
2888
  */
2889
2889
  apiId: string | undefined;
2890
2890
  }
2891
2891
  /**
2892
- * @public
2893
2892
  * <p>Represents the output of a <code>DeleteApiCache</code> operation.</p>
2893
+ * @public
2894
2894
  */
2895
2895
  export interface DeleteApiCacheResponse {
2896
2896
  }
@@ -2899,13 +2899,13 @@ export interface DeleteApiCacheResponse {
2899
2899
  */
2900
2900
  export interface DeleteApiKeyRequest {
2901
2901
  /**
2902
- * @public
2903
2902
  * <p>The API ID.</p>
2903
+ * @public
2904
2904
  */
2905
2905
  apiId: string | undefined;
2906
2906
  /**
2907
- * @public
2908
2907
  * <p>The ID for the API key.</p>
2908
+ * @public
2909
2909
  */
2910
2910
  id: string | undefined;
2911
2911
  }
@@ -2919,13 +2919,13 @@ export interface DeleteApiKeyResponse {
2919
2919
  */
2920
2920
  export interface DeleteDataSourceRequest {
2921
2921
  /**
2922
- * @public
2923
2922
  * <p>The API ID.</p>
2923
+ * @public
2924
2924
  */
2925
2925
  apiId: string | undefined;
2926
2926
  /**
2927
- * @public
2928
2927
  * <p>The name of the data source.</p>
2928
+ * @public
2929
2929
  */
2930
2930
  name: string | undefined;
2931
2931
  }
@@ -2939,8 +2939,8 @@ export interface DeleteDataSourceResponse {
2939
2939
  */
2940
2940
  export interface DeleteDomainNameRequest {
2941
2941
  /**
2942
- * @public
2943
2942
  * <p>The domain name.</p>
2943
+ * @public
2944
2944
  */
2945
2945
  domainName: string | undefined;
2946
2946
  }
@@ -2954,13 +2954,13 @@ export interface DeleteDomainNameResponse {
2954
2954
  */
2955
2955
  export interface DeleteFunctionRequest {
2956
2956
  /**
2957
- * @public
2958
2957
  * <p>The GraphQL API ID.</p>
2958
+ * @public
2959
2959
  */
2960
2960
  apiId: string | undefined;
2961
2961
  /**
2962
- * @public
2963
2962
  * <p>The <code>Function</code> ID.</p>
2963
+ * @public
2964
2964
  */
2965
2965
  functionId: string | undefined;
2966
2966
  }
@@ -2974,8 +2974,8 @@ export interface DeleteFunctionResponse {
2974
2974
  */
2975
2975
  export interface DeleteGraphqlApiRequest {
2976
2976
  /**
2977
- * @public
2978
2977
  * <p>The API ID.</p>
2978
+ * @public
2979
2979
  */
2980
2980
  apiId: string | undefined;
2981
2981
  }
@@ -2989,18 +2989,18 @@ export interface DeleteGraphqlApiResponse {
2989
2989
  */
2990
2990
  export interface DeleteResolverRequest {
2991
2991
  /**
2992
- * @public
2993
2992
  * <p>The API ID.</p>
2993
+ * @public
2994
2994
  */
2995
2995
  apiId: string | undefined;
2996
2996
  /**
2997
- * @public
2998
2997
  * <p>The name of the resolver type.</p>
2998
+ * @public
2999
2999
  */
3000
3000
  typeName: string | undefined;
3001
3001
  /**
3002
- * @public
3003
3002
  * <p>The resolver field name.</p>
3003
+ * @public
3004
3004
  */
3005
3005
  fieldName: string | undefined;
3006
3006
  }
@@ -3014,13 +3014,13 @@ export interface DeleteResolverResponse {
3014
3014
  */
3015
3015
  export interface DeleteTypeRequest {
3016
3016
  /**
3017
- * @public
3018
3017
  * <p>The API ID.</p>
3018
+ * @public
3019
3019
  */
3020
3020
  apiId: string | undefined;
3021
3021
  /**
3022
- * @public
3023
3022
  * <p>The type name.</p>
3023
+ * @public
3024
3024
  */
3025
3025
  typeName: string | undefined;
3026
3026
  }
@@ -3034,8 +3034,8 @@ export interface DeleteTypeResponse {
3034
3034
  */
3035
3035
  export interface DisassociateApiRequest {
3036
3036
  /**
3037
- * @public
3038
3037
  * <p>The domain name.</p>
3038
+ * @public
3039
3039
  */
3040
3040
  domainName: string | undefined;
3041
3041
  }
@@ -3049,15 +3049,15 @@ export interface DisassociateApiResponse {
3049
3049
  */
3050
3050
  export interface DisassociateMergedGraphqlApiRequest {
3051
3051
  /**
3052
- * @public
3053
3052
  * <p>The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source
3054
3053
  * APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs
3055
3054
  * from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.</p>
3055
+ * @public
3056
3056
  */
3057
3057
  sourceApiIdentifier: string | undefined;
3058
3058
  /**
3059
- * @public
3060
3059
  * <p>The ID generated by the AppSync service for the source API association.</p>
3060
+ * @public
3061
3061
  */
3062
3062
  associationId: string | undefined;
3063
3063
  }
@@ -3066,8 +3066,8 @@ export interface DisassociateMergedGraphqlApiRequest {
3066
3066
  */
3067
3067
  export interface DisassociateMergedGraphqlApiResponse {
3068
3068
  /**
3069
- * @public
3070
3069
  * <p>The state of the source API association.</p>
3070
+ * @public
3071
3071
  */
3072
3072
  sourceApiAssociationStatus?: SourceApiAssociationStatus;
3073
3073
  }
@@ -3076,15 +3076,15 @@ export interface DisassociateMergedGraphqlApiResponse {
3076
3076
  */
3077
3077
  export interface DisassociateSourceGraphqlApiRequest {
3078
3078
  /**
3079
- * @public
3080
3079
  * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
3081
3080
  * APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs
3082
3081
  * in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
3082
+ * @public
3083
3083
  */
3084
3084
  mergedApiIdentifier: string | undefined;
3085
3085
  /**
3086
- * @public
3087
3086
  * <p>The ID generated by the AppSync service for the source API association.</p>
3087
+ * @public
3088
3088
  */
3089
3089
  associationId: string | undefined;
3090
3090
  }
@@ -3093,8 +3093,8 @@ export interface DisassociateSourceGraphqlApiRequest {
3093
3093
  */
3094
3094
  export interface DisassociateSourceGraphqlApiResponse {
3095
3095
  /**
3096
- * @public
3097
3096
  * <p>The state of the source API association.</p>
3097
+ * @public
3098
3098
  */
3099
3099
  sourceApiAssociationStatus?: SourceApiAssociationStatus;
3100
3100
  }
@@ -3103,43 +3103,43 @@ export interface DisassociateSourceGraphqlApiResponse {
3103
3103
  */
3104
3104
  export interface EvaluateCodeRequest {
3105
3105
  /**
3106
- * @public
3107
3106
  * <p>The runtime to be used when evaluating the code. Currently, only the <code>APPSYNC_JS</code> runtime is
3108
3107
  * supported.</p>
3108
+ * @public
3109
3109
  */
3110
3110
  runtime: AppSyncRuntime | undefined;
3111
3111
  /**
3112
- * @public
3113
3112
  * <p>The code definition to be evaluated. Note that <code>code</code> and <code>runtime</code> are both required
3114
3113
  * for this action. The <code>runtime</code> value must be <code>APPSYNC_JS</code>.</p>
3114
+ * @public
3115
3115
  */
3116
3116
  code: string | undefined;
3117
3117
  /**
3118
- * @public
3119
3118
  * <p>The map that holds all of the contextual information for your resolver invocation. A <code>context</code> is
3120
3119
  * required for this action.</p>
3120
+ * @public
3121
3121
  */
3122
3122
  context: string | undefined;
3123
3123
  /**
3124
- * @public
3125
3124
  * <p>The function within the code to be evaluated. If provided, the valid values are <code>request</code> and
3126
3125
  * <code>response</code>.</p>
3126
+ * @public
3127
3127
  */
3128
3128
  function?: string;
3129
3129
  }
3130
3130
  /**
3131
- * @public
3132
3131
  * <p>Contains the list of errors from a code evaluation response.</p>
3132
+ * @public
3133
3133
  */
3134
3134
  export interface EvaluateCodeErrorDetail {
3135
3135
  /**
3136
- * @public
3137
3136
  * <p>The error payload.</p>
3137
+ * @public
3138
3138
  */
3139
3139
  message?: string;
3140
3140
  /**
3141
- * @public
3142
3141
  * <p>Contains the list of <code>CodeError</code> objects.</p>
3142
+ * @public
3143
3143
  */
3144
3144
  codeErrors?: CodeError[];
3145
3145
  }
@@ -3148,19 +3148,19 @@ export interface EvaluateCodeErrorDetail {
3148
3148
  */
3149
3149
  export interface EvaluateCodeResponse {
3150
3150
  /**
3151
- * @public
3152
3151
  * <p>The result of the evaluation operation.</p>
3152
+ * @public
3153
3153
  */
3154
3154
  evaluationResult?: string;
3155
3155
  /**
3156
- * @public
3157
3156
  * <p>Contains the payload of the response error.</p>
3157
+ * @public
3158
3158
  */
3159
3159
  error?: EvaluateCodeErrorDetail;
3160
3160
  /**
3161
- * @public
3162
3161
  * <p>A list of logs that were generated by calls to <code>util.log.info</code> and <code>util.log.error</code> in
3163
3162
  * the evaluated code.</p>
3163
+ * @public
3164
3164
  */
3165
3165
  logs?: string[];
3166
3166
  }
@@ -3169,27 +3169,27 @@ export interface EvaluateCodeResponse {
3169
3169
  */
3170
3170
  export interface EvaluateMappingTemplateRequest {
3171
3171
  /**
3172
- * @public
3173
3172
  * <p>The mapping template; this can be a request or response template. A <code>template</code> is required for
3174
3173
  * this action.</p>
3174
+ * @public
3175
3175
  */
3176
3176
  template: string | undefined;
3177
3177
  /**
3178
- * @public
3179
3178
  * <p>The map that holds all of the contextual information for your resolver invocation. A <code>context</code> is
3180
3179
  * required for this action.</p>
3180
+ * @public
3181
3181
  */
3182
3182
  context: string | undefined;
3183
3183
  }
3184
3184
  /**
3185
- * @public
3186
3185
  * <p>Contains the list of errors generated. When using JavaScript, this will apply to the request or response
3187
3186
  * function evaluation.</p>
3187
+ * @public
3188
3188
  */
3189
3189
  export interface ErrorDetail {
3190
3190
  /**
3191
- * @public
3192
3191
  * <p>The error payload.</p>
3192
+ * @public
3193
3193
  */
3194
3194
  message?: string;
3195
3195
  }
@@ -3198,36 +3198,36 @@ export interface ErrorDetail {
3198
3198
  */
3199
3199
  export interface EvaluateMappingTemplateResponse {
3200
3200
  /**
3201
- * @public
3202
3201
  * <p>The mapping template; this can be a request or response template.</p>
3202
+ * @public
3203
3203
  */
3204
3204
  evaluationResult?: string;
3205
3205
  /**
3206
- * @public
3207
3206
  * <p>The <code>ErrorDetail</code> object.</p>
3207
+ * @public
3208
3208
  */
3209
3209
  error?: ErrorDetail;
3210
3210
  /**
3211
- * @public
3212
3211
  * <p>A list of logs that were generated by calls to <code>util.log.info</code> and <code>util.log.error</code> in
3213
3212
  * the evaluated code.</p>
3213
+ * @public
3214
3214
  */
3215
3215
  logs?: string[];
3216
3216
  }
3217
3217
  /**
3218
- * @public
3219
3218
  * <p>Represents the input of a <code>FlushApiCache</code> operation.</p>
3219
+ * @public
3220
3220
  */
3221
3221
  export interface FlushApiCacheRequest {
3222
3222
  /**
3223
- * @public
3224
3223
  * <p>The API ID.</p>
3224
+ * @public
3225
3225
  */
3226
3226
  apiId: string | undefined;
3227
3227
  }
3228
3228
  /**
3229
- * @public
3230
3229
  * <p>Represents the output of a <code>FlushApiCache</code> operation.</p>
3230
+ * @public
3231
3231
  */
3232
3232
  export interface FlushApiCacheResponse {
3233
3233
  }
@@ -3236,8 +3236,8 @@ export interface FlushApiCacheResponse {
3236
3236
  */
3237
3237
  export interface GetApiAssociationRequest {
3238
3238
  /**
3239
- * @public
3240
3239
  * <p>The domain name.</p>
3240
+ * @public
3241
3241
  */
3242
3242
  domainName: string | undefined;
3243
3243
  }
@@ -3246,30 +3246,30 @@ export interface GetApiAssociationRequest {
3246
3246
  */
3247
3247
  export interface GetApiAssociationResponse {
3248
3248
  /**
3249
- * @public
3250
3249
  * <p>The <code>ApiAssociation</code> object.</p>
3250
+ * @public
3251
3251
  */
3252
3252
  apiAssociation?: ApiAssociation;
3253
3253
  }
3254
3254
  /**
3255
- * @public
3256
3255
  * <p>Represents the input of a <code>GetApiCache</code> operation.</p>
3256
+ * @public
3257
3257
  */
3258
3258
  export interface GetApiCacheRequest {
3259
3259
  /**
3260
- * @public
3261
3260
  * <p>The API ID.</p>
3261
+ * @public
3262
3262
  */
3263
3263
  apiId: string | undefined;
3264
3264
  }
3265
3265
  /**
3266
- * @public
3267
3266
  * <p>Represents the output of a <code>GetApiCache</code> operation.</p>
3267
+ * @public
3268
3268
  */
3269
3269
  export interface GetApiCacheResponse {
3270
3270
  /**
3271
- * @public
3272
3271
  * <p>The <code>ApiCache</code> object.</p>
3272
+ * @public
3273
3273
  */
3274
3274
  apiCache?: ApiCache;
3275
3275
  }
@@ -3278,13 +3278,13 @@ export interface GetApiCacheResponse {
3278
3278
  */
3279
3279
  export interface GetDataSourceRequest {
3280
3280
  /**
3281
- * @public
3282
3281
  * <p>The API ID.</p>
3282
+ * @public
3283
3283
  */
3284
3284
  apiId: string | undefined;
3285
3285
  /**
3286
- * @public
3287
3286
  * <p>The name of the data source.</p>
3287
+ * @public
3288
3288
  */
3289
3289
  name: string | undefined;
3290
3290
  }
@@ -3293,8 +3293,8 @@ export interface GetDataSourceRequest {
3293
3293
  */
3294
3294
  export interface GetDataSourceResponse {
3295
3295
  /**
3296
- * @public
3297
3296
  * <p>The <code>DataSource</code> object.</p>
3297
+ * @public
3298
3298
  */
3299
3299
  dataSource?: DataSource;
3300
3300
  }
@@ -3303,43 +3303,43 @@ export interface GetDataSourceResponse {
3303
3303
  */
3304
3304
  export interface GetDataSourceIntrospectionRequest {
3305
3305
  /**
3306
- * @public
3307
3306
  * <p>The introspection ID. Each introspection contains a unique ID that can be used to reference the
3308
3307
  * instrospection record.</p>
3308
+ * @public
3309
3309
  */
3310
3310
  introspectionId: string | undefined;
3311
3311
  /**
3312
- * @public
3313
3312
  * <p>A boolean flag that determines whether SDL should be generated for introspected types or not. If set to
3314
3313
  * <code>true</code>, each model will contain an <code>sdl</code> property that contains the SDL for that type.
3315
3314
  * The SDL only contains the type data and no additional metadata or directives. </p>
3315
+ * @public
3316
3316
  */
3317
3317
  includeModelsSDL?: boolean;
3318
3318
  /**
3319
- * @public
3320
3319
  * <p>Determines the number of types to be returned in a single response before paginating. This value is
3321
3320
  * typically taken from <code>nextToken</code> value from the previous response.</p>
3321
+ * @public
3322
3322
  */
3323
3323
  nextToken?: string;
3324
3324
  /**
3325
- * @public
3326
3325
  * <p>The maximum number of introspected types that will be returned in a single response.</p>
3326
+ * @public
3327
3327
  */
3328
3328
  maxResults?: number;
3329
3329
  }
3330
3330
  /**
3331
- * @public
3332
3331
  * <p>The index that was retrieved from the introspected data.</p>
3332
+ * @public
3333
3333
  */
3334
3334
  export interface DataSourceIntrospectionModelIndex {
3335
3335
  /**
3336
- * @public
3337
3336
  * <p>The name of the index.</p>
3337
+ * @public
3338
3338
  */
3339
3339
  name?: string;
3340
3340
  /**
3341
- * @public
3342
3341
  * <p>The fields of the index.</p>
3342
+ * @public
3343
3343
  */
3344
3344
  fields?: string[];
3345
3345
  }
@@ -3361,8 +3361,8 @@ export type DataSourceIntrospectionStatus = (typeof DataSourceIntrospectionStatu
3361
3361
  */
3362
3362
  export interface GetDomainNameRequest {
3363
3363
  /**
3364
- * @public
3365
3364
  * <p>The domain name.</p>
3365
+ * @public
3366
3366
  */
3367
3367
  domainName: string | undefined;
3368
3368
  }
@@ -3371,8 +3371,8 @@ export interface GetDomainNameRequest {
3371
3371
  */
3372
3372
  export interface GetDomainNameResponse {
3373
3373
  /**
3374
- * @public
3375
3374
  * <p>The configuration for the <code>DomainName</code>.</p>
3375
+ * @public
3376
3376
  */
3377
3377
  domainNameConfig?: DomainNameConfig;
3378
3378
  }
@@ -3381,13 +3381,13 @@ export interface GetDomainNameResponse {
3381
3381
  */
3382
3382
  export interface GetFunctionRequest {
3383
3383
  /**
3384
- * @public
3385
3384
  * <p>The GraphQL API ID.</p>
3385
+ * @public
3386
3386
  */
3387
3387
  apiId: string | undefined;
3388
3388
  /**
3389
- * @public
3390
3389
  * <p>The <code>Function</code> ID.</p>
3390
+ * @public
3391
3391
  */
3392
3392
  functionId: string | undefined;
3393
3393
  }
@@ -3396,8 +3396,8 @@ export interface GetFunctionRequest {
3396
3396
  */
3397
3397
  export interface GetFunctionResponse {
3398
3398
  /**
3399
- * @public
3400
3399
  * <p>The <code>Function</code> object.</p>
3400
+ * @public
3401
3401
  */
3402
3402
  functionConfiguration?: FunctionConfiguration;
3403
3403
  }
@@ -3406,8 +3406,8 @@ export interface GetFunctionResponse {
3406
3406
  */
3407
3407
  export interface GetGraphqlApiRequest {
3408
3408
  /**
3409
- * @public
3410
3409
  * <p>The API ID for the GraphQL API.</p>
3410
+ * @public
3411
3411
  */
3412
3412
  apiId: string | undefined;
3413
3413
  }
@@ -3416,8 +3416,8 @@ export interface GetGraphqlApiRequest {
3416
3416
  */
3417
3417
  export interface GetGraphqlApiResponse {
3418
3418
  /**
3419
- * @public
3420
3419
  * <p>The <code>GraphqlApi</code> object.</p>
3420
+ * @public
3421
3421
  */
3422
3422
  graphqlApi?: GraphqlApi;
3423
3423
  }
@@ -3426,8 +3426,8 @@ export interface GetGraphqlApiResponse {
3426
3426
  */
3427
3427
  export interface GetGraphqlApiEnvironmentVariablesRequest {
3428
3428
  /**
3429
- * @public
3430
3429
  * <p>The ID of the API from which the environmental variable list will be retrieved.</p>
3430
+ * @public
3431
3431
  */
3432
3432
  apiId: string | undefined;
3433
3433
  }
@@ -3436,8 +3436,8 @@ export interface GetGraphqlApiEnvironmentVariablesRequest {
3436
3436
  */
3437
3437
  export interface GetGraphqlApiEnvironmentVariablesResponse {
3438
3438
  /**
3439
- * @public
3440
3439
  * <p>The payload containing each environmental variable in the <code>"key" : "value"</code> format.</p>
3440
+ * @public
3441
3441
  */
3442
3442
  environmentVariables?: Record<string, string>;
3443
3443
  }
@@ -3458,18 +3458,18 @@ export type OutputType = (typeof OutputType)[keyof typeof OutputType];
3458
3458
  */
3459
3459
  export interface GetIntrospectionSchemaRequest {
3460
3460
  /**
3461
- * @public
3462
3461
  * <p>The API ID.</p>
3462
+ * @public
3463
3463
  */
3464
3464
  apiId: string | undefined;
3465
3465
  /**
3466
- * @public
3467
3466
  * <p>The schema format: SDL or JSON.</p>
3467
+ * @public
3468
3468
  */
3469
3469
  format: OutputType | undefined;
3470
3470
  /**
3471
- * @public
3472
3471
  * <p>A flag that specifies whether the schema introspection should contain directives.</p>
3472
+ * @public
3473
3473
  */
3474
3474
  includeDirectives?: boolean;
3475
3475
  }
@@ -3478,16 +3478,16 @@ export interface GetIntrospectionSchemaRequest {
3478
3478
  */
3479
3479
  export interface GetIntrospectionSchemaResponse {
3480
3480
  /**
3481
- * @public
3482
3481
  * <p>The schema, in GraphQL Schema Definition Language (SDL) format.</p>
3483
3482
  * <p>For more information, see the <a href="http://graphql.org/learn/schema/">GraphQL SDL
3484
3483
  * documentation</a>.</p>
3484
+ * @public
3485
3485
  */
3486
3486
  schema?: Uint8Array;
3487
3487
  }
3488
3488
  /**
3489
- * @public
3490
3489
  * <p>The GraphQL schema is not valid.</p>
3490
+ * @public
3491
3491
  */
3492
3492
  export declare class GraphQLSchemaException extends __BaseException {
3493
3493
  readonly name: "GraphQLSchemaException";
@@ -3502,18 +3502,18 @@ export declare class GraphQLSchemaException extends __BaseException {
3502
3502
  */
3503
3503
  export interface GetResolverRequest {
3504
3504
  /**
3505
- * @public
3506
3505
  * <p>The API ID.</p>
3506
+ * @public
3507
3507
  */
3508
3508
  apiId: string | undefined;
3509
3509
  /**
3510
- * @public
3511
3510
  * <p>The resolver type name.</p>
3511
+ * @public
3512
3512
  */
3513
3513
  typeName: string | undefined;
3514
3514
  /**
3515
- * @public
3516
3515
  * <p>The resolver field name.</p>
3516
+ * @public
3517
3517
  */
3518
3518
  fieldName: string | undefined;
3519
3519
  }
@@ -3522,8 +3522,8 @@ export interface GetResolverRequest {
3522
3522
  */
3523
3523
  export interface GetResolverResponse {
3524
3524
  /**
3525
- * @public
3526
3525
  * <p>The <code>Resolver</code> object.</p>
3526
+ * @public
3527
3527
  */
3528
3528
  resolver?: Resolver;
3529
3529
  }
@@ -3532,8 +3532,8 @@ export interface GetResolverResponse {
3532
3532
  */
3533
3533
  export interface GetSchemaCreationStatusRequest {
3534
3534
  /**
3535
- * @public
3536
3535
  * <p>The API ID.</p>
3536
+ * @public
3537
3537
  */
3538
3538
  apiId: string | undefined;
3539
3539
  }
@@ -3558,14 +3558,14 @@ export type SchemaStatus = (typeof SchemaStatus)[keyof typeof SchemaStatus];
3558
3558
  */
3559
3559
  export interface GetSchemaCreationStatusResponse {
3560
3560
  /**
3561
- * @public
3562
3561
  * <p>The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the
3563
3562
  * ACTIVE state, you can add data.</p>
3563
+ * @public
3564
3564
  */
3565
3565
  status?: SchemaStatus;
3566
3566
  /**
3567
- * @public
3568
3567
  * <p>Detailed information about the status of the schema creation operation.</p>
3568
+ * @public
3569
3569
  */
3570
3570
  details?: string;
3571
3571
  }
@@ -3574,15 +3574,15 @@ export interface GetSchemaCreationStatusResponse {
3574
3574
  */
3575
3575
  export interface GetSourceApiAssociationRequest {
3576
3576
  /**
3577
- * @public
3578
3577
  * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
3579
3578
  * APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs
3580
3579
  * in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
3580
+ * @public
3581
3581
  */
3582
3582
  mergedApiIdentifier: string | undefined;
3583
3583
  /**
3584
- * @public
3585
3584
  * <p>The ID generated by the AppSync service for the source API association.</p>
3585
+ * @public
3586
3586
  */
3587
3587
  associationId: string | undefined;
3588
3588
  }
@@ -3591,8 +3591,8 @@ export interface GetSourceApiAssociationRequest {
3591
3591
  */
3592
3592
  export interface GetSourceApiAssociationResponse {
3593
3593
  /**
3594
- * @public
3595
3594
  * <p>The <code>SourceApiAssociation</code> object data.</p>
3595
+ * @public
3596
3596
  */
3597
3597
  sourceApiAssociation?: SourceApiAssociation;
3598
3598
  }
@@ -3601,18 +3601,18 @@ export interface GetSourceApiAssociationResponse {
3601
3601
  */
3602
3602
  export interface GetTypeRequest {
3603
3603
  /**
3604
- * @public
3605
3604
  * <p>The API ID.</p>
3605
+ * @public
3606
3606
  */
3607
3607
  apiId: string | undefined;
3608
3608
  /**
3609
- * @public
3610
3609
  * <p>The type name.</p>
3610
+ * @public
3611
3611
  */
3612
3612
  typeName: string | undefined;
3613
3613
  /**
3614
- * @public
3615
3614
  * <p>The type format: SDL or JSON.</p>
3615
+ * @public
3616
3616
  */
3617
3617
  format: TypeDefinitionFormat | undefined;
3618
3618
  }
@@ -3621,8 +3621,8 @@ export interface GetTypeRequest {
3621
3621
  */
3622
3622
  export interface GetTypeResponse {
3623
3623
  /**
3624
- * @public
3625
3624
  * <p>The <code>Type</code> object.</p>
3625
+ * @public
3626
3626
  */
3627
3627
  type?: Type;
3628
3628
  }
@@ -3631,19 +3631,19 @@ export interface GetTypeResponse {
3631
3631
  */
3632
3632
  export interface ListApiKeysRequest {
3633
3633
  /**
3634
- * @public
3635
3634
  * <p>The API ID.</p>
3635
+ * @public
3636
3636
  */
3637
3637
  apiId: string | undefined;
3638
3638
  /**
3639
- * @public
3640
3639
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
3641
3640
  * next set of items in the list.</p>
3641
+ * @public
3642
3642
  */
3643
3643
  nextToken?: string;
3644
3644
  /**
3645
- * @public
3646
3645
  * <p>The maximum number of results that you want the request to return.</p>
3646
+ * @public
3647
3647
  */
3648
3648
  maxResults?: number;
3649
3649
  }
@@ -3652,14 +3652,14 @@ export interface ListApiKeysRequest {
3652
3652
  */
3653
3653
  export interface ListApiKeysResponse {
3654
3654
  /**
3655
- * @public
3656
3655
  * <p>The <code>ApiKey</code> objects.</p>
3656
+ * @public
3657
3657
  */
3658
3658
  apiKeys?: ApiKey[];
3659
3659
  /**
3660
- * @public
3661
3660
  * <p>An identifier to pass in the next request to this operation to return the next set of items in the
3662
3661
  * list.</p>
3662
+ * @public
3663
3663
  */
3664
3664
  nextToken?: string;
3665
3665
  }
@@ -3668,19 +3668,19 @@ export interface ListApiKeysResponse {
3668
3668
  */
3669
3669
  export interface ListDataSourcesRequest {
3670
3670
  /**
3671
- * @public
3672
3671
  * <p>The API ID.</p>
3672
+ * @public
3673
3673
  */
3674
3674
  apiId: string | undefined;
3675
3675
  /**
3676
- * @public
3677
3676
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
3678
3677
  * next set of items in the list.</p>
3678
+ * @public
3679
3679
  */
3680
3680
  nextToken?: string;
3681
3681
  /**
3682
- * @public
3683
3682
  * <p>The maximum number of results that you want the request to return.</p>
3683
+ * @public
3684
3684
  */
3685
3685
  maxResults?: number;
3686
3686
  }
@@ -3689,14 +3689,14 @@ export interface ListDataSourcesRequest {
3689
3689
  */
3690
3690
  export interface ListDataSourcesResponse {
3691
3691
  /**
3692
- * @public
3693
3692
  * <p>The <code>DataSource</code> objects.</p>
3693
+ * @public
3694
3694
  */
3695
3695
  dataSources?: DataSource[];
3696
3696
  /**
3697
- * @public
3698
3697
  * <p>An identifier to pass in the next request to this operation to return the next set of items in the
3699
3698
  * list.</p>
3699
+ * @public
3700
3700
  */
3701
3701
  nextToken?: string;
3702
3702
  }
@@ -3705,14 +3705,14 @@ export interface ListDataSourcesResponse {
3705
3705
  */
3706
3706
  export interface ListDomainNamesRequest {
3707
3707
  /**
3708
- * @public
3709
3708
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
3710
3709
  * next set of items in the list.</p>
3710
+ * @public
3711
3711
  */
3712
3712
  nextToken?: string;
3713
3713
  /**
3714
- * @public
3715
3714
  * <p>The maximum number of results that you want the request to return.</p>
3715
+ * @public
3716
3716
  */
3717
3717
  maxResults?: number;
3718
3718
  }
@@ -3721,14 +3721,14 @@ export interface ListDomainNamesRequest {
3721
3721
  */
3722
3722
  export interface ListDomainNamesResponse {
3723
3723
  /**
3724
- * @public
3725
3724
  * <p>Lists configurations for multiple domain names.</p>
3725
+ * @public
3726
3726
  */
3727
3727
  domainNameConfigs?: DomainNameConfig[];
3728
3728
  /**
3729
- * @public
3730
3729
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
3731
3730
  * next set of items in the list.</p>
3731
+ * @public
3732
3732
  */
3733
3733
  nextToken?: string;
3734
3734
  }
@@ -3737,19 +3737,19 @@ export interface ListDomainNamesResponse {
3737
3737
  */
3738
3738
  export interface ListFunctionsRequest {
3739
3739
  /**
3740
- * @public
3741
3740
  * <p>The GraphQL API ID.</p>
3741
+ * @public
3742
3742
  */
3743
3743
  apiId: string | undefined;
3744
3744
  /**
3745
- * @public
3746
3745
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
3747
3746
  * next set of items in the list.</p>
3747
+ * @public
3748
3748
  */
3749
3749
  nextToken?: string;
3750
3750
  /**
3751
- * @public
3752
3751
  * <p>The maximum number of results that you want the request to return.</p>
3752
+ * @public
3753
3753
  */
3754
3754
  maxResults?: number;
3755
3755
  }
@@ -3758,14 +3758,14 @@ export interface ListFunctionsRequest {
3758
3758
  */
3759
3759
  export interface ListFunctionsResponse {
3760
3760
  /**
3761
- * @public
3762
3761
  * <p>A list of <code>Function</code> objects.</p>
3762
+ * @public
3763
3763
  */
3764
3764
  functions?: FunctionConfiguration[];
3765
3765
  /**
3766
- * @public
3767
3766
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
3768
3767
  * next set of items in the list.</p>
3768
+ * @public
3769
3769
  */
3770
3770
  nextToken?: string;
3771
3771
  }
@@ -3786,25 +3786,25 @@ export type Ownership = (typeof Ownership)[keyof typeof Ownership];
3786
3786
  */
3787
3787
  export interface ListGraphqlApisRequest {
3788
3788
  /**
3789
- * @public
3790
3789
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
3791
3790
  * next set of items in the list.</p>
3791
+ * @public
3792
3792
  */
3793
3793
  nextToken?: string;
3794
3794
  /**
3795
- * @public
3796
3795
  * <p>The maximum number of results that you want the request to return.</p>
3796
+ * @public
3797
3797
  */
3798
3798
  maxResults?: number;
3799
3799
  /**
3800
- * @public
3801
3800
  * <p>The value that indicates whether the GraphQL API is a standard API (<code>GRAPHQL</code>) or merged API
3802
3801
  * (<code>MERGED</code>).</p>
3802
+ * @public
3803
3803
  */
3804
3804
  apiType?: GraphQLApiType;
3805
3805
  /**
3806
- * @public
3807
3806
  * <p>The account owner of the GraphQL API.</p>
3807
+ * @public
3808
3808
  */
3809
3809
  owner?: Ownership;
3810
3810
  }
@@ -3813,14 +3813,14 @@ export interface ListGraphqlApisRequest {
3813
3813
  */
3814
3814
  export interface ListGraphqlApisResponse {
3815
3815
  /**
3816
- * @public
3817
3816
  * <p>The <code>GraphqlApi</code> objects.</p>
3817
+ * @public
3818
3818
  */
3819
3819
  graphqlApis?: GraphqlApi[];
3820
3820
  /**
3821
- * @public
3822
3821
  * <p>An identifier to pass in the next request to this operation to return the next set of items in the
3823
3822
  * list.</p>
3823
+ * @public
3824
3824
  */
3825
3825
  nextToken?: string;
3826
3826
  }
@@ -3829,24 +3829,24 @@ export interface ListGraphqlApisResponse {
3829
3829
  */
3830
3830
  export interface ListResolversRequest {
3831
3831
  /**
3832
- * @public
3833
3832
  * <p>The API ID.</p>
3833
+ * @public
3834
3834
  */
3835
3835
  apiId: string | undefined;
3836
3836
  /**
3837
- * @public
3838
3837
  * <p>The type name.</p>
3838
+ * @public
3839
3839
  */
3840
3840
  typeName: string | undefined;
3841
3841
  /**
3842
- * @public
3843
3842
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
3844
3843
  * next set of items in the list.</p>
3844
+ * @public
3845
3845
  */
3846
3846
  nextToken?: string;
3847
3847
  /**
3848
- * @public
3849
3848
  * <p>The maximum number of results that you want the request to return.</p>
3849
+ * @public
3850
3850
  */
3851
3851
  maxResults?: number;
3852
3852
  }
@@ -3855,14 +3855,14 @@ export interface ListResolversRequest {
3855
3855
  */
3856
3856
  export interface ListResolversResponse {
3857
3857
  /**
3858
- * @public
3859
3858
  * <p>The <code>Resolver</code> objects.</p>
3859
+ * @public
3860
3860
  */
3861
3861
  resolvers?: Resolver[];
3862
3862
  /**
3863
- * @public
3864
3863
  * <p>An identifier to pass in the next request to this operation to return the next set of items in the
3865
3864
  * list.</p>
3865
+ * @public
3866
3866
  */
3867
3867
  nextToken?: string;
3868
3868
  }
@@ -3871,24 +3871,24 @@ export interface ListResolversResponse {
3871
3871
  */
3872
3872
  export interface ListResolversByFunctionRequest {
3873
3873
  /**
3874
- * @public
3875
3874
  * <p>The API ID.</p>
3875
+ * @public
3876
3876
  */
3877
3877
  apiId: string | undefined;
3878
3878
  /**
3879
- * @public
3880
3879
  * <p>The function ID.</p>
3880
+ * @public
3881
3881
  */
3882
3882
  functionId: string | undefined;
3883
3883
  /**
3884
- * @public
3885
3884
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
3886
3885
  * next set of items in the list.</p>
3886
+ * @public
3887
3887
  */
3888
3888
  nextToken?: string;
3889
3889
  /**
3890
- * @public
3891
3890
  * <p>The maximum number of results that you want the request to return.</p>
3891
+ * @public
3892
3892
  */
3893
3893
  maxResults?: number;
3894
3894
  }
@@ -3897,13 +3897,13 @@ export interface ListResolversByFunctionRequest {
3897
3897
  */
3898
3898
  export interface ListResolversByFunctionResponse {
3899
3899
  /**
3900
- * @public
3901
3900
  * <p>The list of resolvers.</p>
3901
+ * @public
3902
3902
  */
3903
3903
  resolvers?: Resolver[];
3904
3904
  /**
3905
- * @public
3906
3905
  * <p>An identifier that you can use to return the next set of items in the list.</p>
3906
+ * @public
3907
3907
  */
3908
3908
  nextToken?: string;
3909
3909
  }
@@ -3912,60 +3912,60 @@ export interface ListResolversByFunctionResponse {
3912
3912
  */
3913
3913
  export interface ListSourceApiAssociationsRequest {
3914
3914
  /**
3915
- * @public
3916
3915
  * <p>The API ID.</p>
3916
+ * @public
3917
3917
  */
3918
3918
  apiId: string | undefined;
3919
3919
  /**
3920
- * @public
3921
3920
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
3922
3921
  * next set of items in the list.</p>
3922
+ * @public
3923
3923
  */
3924
3924
  nextToken?: string;
3925
3925
  /**
3926
- * @public
3927
3926
  * <p>The maximum number of results that you want the request to return.</p>
3927
+ * @public
3928
3928
  */
3929
3929
  maxResults?: number;
3930
3930
  }
3931
3931
  /**
3932
- * @public
3933
3932
  * <p>Describes the ARNs and IDs of associations, Merged APIs, and source APIs.</p>
3933
+ * @public
3934
3934
  */
3935
3935
  export interface SourceApiAssociationSummary {
3936
3936
  /**
3937
- * @public
3938
3937
  * <p>The ID generated by the AppSync service for the source API association.</p>
3938
+ * @public
3939
3939
  */
3940
3940
  associationId?: string;
3941
3941
  /**
3942
- * @public
3943
3942
  * <p>The Amazon Resource Name (ARN) of the source API association.</p>
3943
+ * @public
3944
3944
  */
3945
3945
  associationArn?: string;
3946
3946
  /**
3947
- * @public
3948
3947
  * <p>The ID of the AppSync source API.</p>
3948
+ * @public
3949
3949
  */
3950
3950
  sourceApiId?: string;
3951
3951
  /**
3952
- * @public
3953
3952
  * <p>The Amazon Resource Name (ARN) of the AppSync Source API.</p>
3953
+ * @public
3954
3954
  */
3955
3955
  sourceApiArn?: string;
3956
3956
  /**
3957
- * @public
3958
3957
  * <p>The ID of the AppSync Merged API.</p>
3958
+ * @public
3959
3959
  */
3960
3960
  mergedApiId?: string;
3961
3961
  /**
3962
- * @public
3963
3962
  * <p>The Amazon Resource Name (ARN) of the AppSync Merged API.</p>
3963
+ * @public
3964
3964
  */
3965
3965
  mergedApiArn?: string;
3966
3966
  /**
3967
- * @public
3968
3967
  * <p>The description field.</p>
3968
+ * @public
3969
3969
  */
3970
3970
  description?: string;
3971
3971
  }
@@ -3974,14 +3974,14 @@ export interface SourceApiAssociationSummary {
3974
3974
  */
3975
3975
  export interface ListSourceApiAssociationsResponse {
3976
3976
  /**
3977
- * @public
3978
3977
  * <p>The <code>SourceApiAssociationSummary</code> object data.</p>
3978
+ * @public
3979
3979
  */
3980
3980
  sourceApiAssociationSummaries?: SourceApiAssociationSummary[];
3981
3981
  /**
3982
- * @public
3983
3982
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
3984
3983
  * next set of items in the list.</p>
3984
+ * @public
3985
3985
  */
3986
3986
  nextToken?: string;
3987
3987
  }
@@ -3990,8 +3990,8 @@ export interface ListSourceApiAssociationsResponse {
3990
3990
  */
3991
3991
  export interface ListTagsForResourceRequest {
3992
3992
  /**
3993
- * @public
3994
3993
  * <p>The <code>GraphqlApi</code> Amazon Resource Name (ARN).</p>
3994
+ * @public
3995
3995
  */
3996
3996
  resourceArn: string | undefined;
3997
3997
  }
@@ -4000,8 +4000,8 @@ export interface ListTagsForResourceRequest {
4000
4000
  */
4001
4001
  export interface ListTagsForResourceResponse {
4002
4002
  /**
4003
- * @public
4004
4003
  * <p>A <code>TagMap</code> object.</p>
4004
+ * @public
4005
4005
  */
4006
4006
  tags?: Record<string, string>;
4007
4007
  }
@@ -4010,24 +4010,24 @@ export interface ListTagsForResourceResponse {
4010
4010
  */
4011
4011
  export interface ListTypesRequest {
4012
4012
  /**
4013
- * @public
4014
4013
  * <p>The API ID.</p>
4014
+ * @public
4015
4015
  */
4016
4016
  apiId: string | undefined;
4017
4017
  /**
4018
- * @public
4019
4018
  * <p>The type format: SDL or JSON.</p>
4019
+ * @public
4020
4020
  */
4021
4021
  format: TypeDefinitionFormat | undefined;
4022
4022
  /**
4023
- * @public
4024
4023
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
4025
4024
  * next set of items in the list.</p>
4025
+ * @public
4026
4026
  */
4027
4027
  nextToken?: string;
4028
4028
  /**
4029
- * @public
4030
4029
  * <p>The maximum number of results that you want the request to return.</p>
4030
+ * @public
4031
4031
  */
4032
4032
  maxResults?: number;
4033
4033
  }
@@ -4036,14 +4036,14 @@ export interface ListTypesRequest {
4036
4036
  */
4037
4037
  export interface ListTypesResponse {
4038
4038
  /**
4039
- * @public
4040
4039
  * <p>The <code>Type</code> objects.</p>
4040
+ * @public
4041
4041
  */
4042
4042
  types?: Type[];
4043
4043
  /**
4044
- * @public
4045
4044
  * <p>An identifier to pass in the next request to this operation to return the next set of items in the
4046
4045
  * list.</p>
4046
+ * @public
4047
4047
  */
4048
4048
  nextToken?: string;
4049
4049
  }
@@ -4052,31 +4052,31 @@ export interface ListTypesResponse {
4052
4052
  */
4053
4053
  export interface ListTypesByAssociationRequest {
4054
4054
  /**
4055
- * @public
4056
4055
  * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
4057
4056
  * APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs
4058
4057
  * in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
4058
+ * @public
4059
4059
  */
4060
4060
  mergedApiIdentifier: string | undefined;
4061
4061
  /**
4062
- * @public
4063
4062
  * <p>The ID generated by the AppSync service for the source API association.</p>
4063
+ * @public
4064
4064
  */
4065
4065
  associationId: string | undefined;
4066
4066
  /**
4067
- * @public
4068
4067
  * <p>The format type.</p>
4068
+ * @public
4069
4069
  */
4070
4070
  format: TypeDefinitionFormat | undefined;
4071
4071
  /**
4072
- * @public
4073
4072
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
4074
4073
  * next set of items in the list.</p>
4074
+ * @public
4075
4075
  */
4076
4076
  nextToken?: string;
4077
4077
  /**
4078
- * @public
4079
4078
  * <p>The maximum number of results that you want the request to return.</p>
4079
+ * @public
4080
4080
  */
4081
4081
  maxResults?: number;
4082
4082
  }
@@ -4085,14 +4085,14 @@ export interface ListTypesByAssociationRequest {
4085
4085
  */
4086
4086
  export interface ListTypesByAssociationResponse {
4087
4087
  /**
4088
- * @public
4089
4088
  * <p>The <code>Type</code> objects.</p>
4089
+ * @public
4090
4090
  */
4091
4091
  types?: Type[];
4092
4092
  /**
4093
- * @public
4094
4093
  * <p>An identifier that was returned from the previous call to this operation, which you can use to return the
4095
4094
  * next set of items in the list.</p>
4095
+ * @public
4096
4096
  */
4097
4097
  nextToken?: string;
4098
4098
  }
@@ -4101,12 +4101,11 @@ export interface ListTypesByAssociationResponse {
4101
4101
  */
4102
4102
  export interface PutGraphqlApiEnvironmentVariablesRequest {
4103
4103
  /**
4104
- * @public
4105
4104
  * <p>The ID of the API to which the environmental variable list will be written.</p>
4105
+ * @public
4106
4106
  */
4107
4107
  apiId: string | undefined;
4108
4108
  /**
4109
- * @public
4110
4109
  * <p>The list of environmental variables to add to the API.</p>
4111
4110
  * <p>When creating an environmental variable key-value pair, it must follow the additional constraints
4112
4111
  * below:</p>
@@ -4133,6 +4132,7 @@ export interface PutGraphqlApiEnvironmentVariablesRequest {
4133
4132
  * environmental variable list of that API. This means the existing environmental variables will be lost. To avoid
4134
4133
  * this, you must include all existing and new environmental variables in the list each time you call this
4135
4134
  * action.</p>
4135
+ * @public
4136
4136
  */
4137
4137
  environmentVariables: Record<string, string> | undefined;
4138
4138
  }
@@ -4141,32 +4141,32 @@ export interface PutGraphqlApiEnvironmentVariablesRequest {
4141
4141
  */
4142
4142
  export interface PutGraphqlApiEnvironmentVariablesResponse {
4143
4143
  /**
4144
- * @public
4145
4144
  * <p>The payload containing each environmental variable in the <code>"key" : "value"</code> format.</p>
4145
+ * @public
4146
4146
  */
4147
4147
  environmentVariables?: Record<string, string>;
4148
4148
  }
4149
4149
  /**
4150
- * @public
4151
4150
  * <p>Contains the metadata required to introspect the RDS cluster.</p>
4151
+ * @public
4152
4152
  */
4153
4153
  export interface RdsDataApiConfig {
4154
4154
  /**
4155
- * @public
4156
4155
  * <p>The resource ARN of the RDS cluster.</p>
4156
+ * @public
4157
4157
  */
4158
4158
  resourceArn: string | undefined;
4159
4159
  /**
4160
- * @public
4161
4160
  * <p>The secret's ARN that was obtained from Secrets Manager. A secret consists of secret information, the secret
4162
4161
  * value, plus metadata about the secret. A secret value can be a string or binary. It typically includes the ARN,
4163
4162
  * secret name and description, policies, tags, encryption key from the Key Management Service, and key rotation
4164
4163
  * data.</p>
4164
+ * @public
4165
4165
  */
4166
4166
  secretArn: string | undefined;
4167
4167
  /**
4168
- * @public
4169
4168
  * <p>The name of the database in the cluster.</p>
4169
+ * @public
4170
4170
  */
4171
4171
  databaseName: string | undefined;
4172
4172
  }
@@ -4175,8 +4175,8 @@ export interface RdsDataApiConfig {
4175
4175
  */
4176
4176
  export interface StartDataSourceIntrospectionRequest {
4177
4177
  /**
4178
- * @public
4179
4178
  * <p>The <code>rdsDataApiConfig</code> object data.</p>
4179
+ * @public
4180
4180
  */
4181
4181
  rdsDataApiConfig?: RdsDataApiConfig;
4182
4182
  }
@@ -4185,24 +4185,24 @@ export interface StartDataSourceIntrospectionRequest {
4185
4185
  */
4186
4186
  export interface StartDataSourceIntrospectionResponse {
4187
4187
  /**
4188
- * @public
4189
4188
  * <p>The introspection ID. Each introspection contains a unique ID that can be used to reference the
4190
4189
  * instrospection record.</p>
4190
+ * @public
4191
4191
  */
4192
4192
  introspectionId?: string;
4193
4193
  /**
4194
- * @public
4195
4194
  * <p>The status of the introspection during creation. By default, when a new instrospection has been created, the
4196
4195
  * status will be set to <code>PROCESSING</code>. Once the operation has been completed, the status will change to
4197
4196
  * <code>SUCCESS</code> or <code>FAILED</code> depending on how the data was parsed. A <code>FAILED</code>
4198
4197
  * operation will return an error and its details as an <code>introspectionStatusDetail</code>.</p>
4198
+ * @public
4199
4199
  */
4200
4200
  introspectionStatus?: DataSourceIntrospectionStatus;
4201
4201
  /**
4202
- * @public
4203
4202
  * <p>The error detail field. When a <code>FAILED</code>
4204
4203
  * <code>introspectionStatus</code> is returned, the <code>introspectionStatusDetail</code> will also return the
4205
4204
  * exact error that was generated during the operation.</p>
4205
+ * @public
4206
4206
  */
4207
4207
  introspectionStatusDetail?: string;
4208
4208
  }
@@ -4211,13 +4211,13 @@ export interface StartDataSourceIntrospectionResponse {
4211
4211
  */
4212
4212
  export interface StartSchemaCreationRequest {
4213
4213
  /**
4214
- * @public
4215
4214
  * <p>The API ID.</p>
4215
+ * @public
4216
4216
  */
4217
4217
  apiId: string | undefined;
4218
4218
  /**
4219
- * @public
4220
4219
  * <p>The schema definition, in GraphQL schema language format.</p>
4220
+ * @public
4221
4221
  */
4222
4222
  definition: Uint8Array | undefined;
4223
4223
  }
@@ -4226,9 +4226,9 @@ export interface StartSchemaCreationRequest {
4226
4226
  */
4227
4227
  export interface StartSchemaCreationResponse {
4228
4228
  /**
4229
- * @public
4230
4229
  * <p>The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the
4231
4230
  * ACTIVE state, you can add data.</p>
4231
+ * @public
4232
4232
  */
4233
4233
  status?: SchemaStatus;
4234
4234
  }
@@ -4237,15 +4237,15 @@ export interface StartSchemaCreationResponse {
4237
4237
  */
4238
4238
  export interface StartSchemaMergeRequest {
4239
4239
  /**
4240
- * @public
4241
4240
  * <p>The ID generated by the AppSync service for the source API association.</p>
4241
+ * @public
4242
4242
  */
4243
4243
  associationId: string | undefined;
4244
4244
  /**
4245
- * @public
4246
4245
  * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
4247
4246
  * APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs
4248
4247
  * in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
4248
+ * @public
4249
4249
  */
4250
4250
  mergedApiIdentifier: string | undefined;
4251
4251
  }
@@ -4254,8 +4254,8 @@ export interface StartSchemaMergeRequest {
4254
4254
  */
4255
4255
  export interface StartSchemaMergeResponse {
4256
4256
  /**
4257
- * @public
4258
4257
  * <p>The state of the source API association.</p>
4258
+ * @public
4259
4259
  */
4260
4260
  sourceApiAssociationStatus?: SourceApiAssociationStatus;
4261
4261
  }
@@ -4264,13 +4264,13 @@ export interface StartSchemaMergeResponse {
4264
4264
  */
4265
4265
  export interface TagResourceRequest {
4266
4266
  /**
4267
- * @public
4268
4267
  * <p>The <code>GraphqlApi</code> Amazon Resource Name (ARN).</p>
4268
+ * @public
4269
4269
  */
4270
4270
  resourceArn: string | undefined;
4271
4271
  /**
4272
- * @public
4273
4272
  * <p>A <code>TagMap</code> object.</p>
4273
+ * @public
4274
4274
  */
4275
4275
  tags: Record<string, string> | undefined;
4276
4276
  }
@@ -4284,13 +4284,13 @@ export interface TagResourceResponse {
4284
4284
  */
4285
4285
  export interface UntagResourceRequest {
4286
4286
  /**
4287
- * @public
4288
4287
  * <p>The <code>GraphqlApi</code> Amazon Resource Name (ARN).</p>
4288
+ * @public
4289
4289
  */
4290
4290
  resourceArn: string | undefined;
4291
4291
  /**
4292
- * @public
4293
4292
  * <p>A list of <code>TagKey</code> objects.</p>
4293
+ * @public
4294
4294
  */
4295
4295
  tagKeys: string[] | undefined;
4296
4296
  }
@@ -4300,23 +4300,22 @@ export interface UntagResourceRequest {
4300
4300
  export interface UntagResourceResponse {
4301
4301
  }
4302
4302
  /**
4303
- * @public
4304
4303
  * <p>Represents the input of a <code>UpdateApiCache</code> operation.</p>
4304
+ * @public
4305
4305
  */
4306
4306
  export interface UpdateApiCacheRequest {
4307
4307
  /**
4308
- * @public
4309
4308
  * <p>The GraphQL API ID.</p>
4309
+ * @public
4310
4310
  */
4311
4311
  apiId: string | undefined;
4312
4312
  /**
4313
- * @public
4314
4313
  * <p>TTL in seconds for cache entries.</p>
4315
4314
  * <p>Valid values are 1–3,600 seconds.</p>
4315
+ * @public
4316
4316
  */
4317
4317
  ttl: number | undefined;
4318
4318
  /**
4319
- * @public
4320
4319
  * <p>Caching behavior.</p>
4321
4320
  * <ul>
4322
4321
  * <li>
@@ -4329,10 +4328,10 @@ export interface UpdateApiCacheRequest {
4329
4328
  * cached.</p>
4330
4329
  * </li>
4331
4330
  * </ul>
4331
+ * @public
4332
4332
  */
4333
4333
  apiCachingBehavior: ApiCachingBehavior | undefined;
4334
4334
  /**
4335
- * @public
4336
4335
  * <p>The cache instance type. Valid values are </p>
4337
4336
  * <ul>
4338
4337
  * <li>
@@ -4407,10 +4406,10 @@ export interface UpdateApiCacheRequest {
4407
4406
  * <b>R4_8XLARGE</b>: A r4.8xlarge instance type.</p>
4408
4407
  * </li>
4409
4408
  * </ul>
4409
+ * @public
4410
4410
  */
4411
4411
  type: ApiCacheType | undefined;
4412
4412
  /**
4413
- * @public
4414
4413
  * <p>Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:</p>
4415
4414
  * <ul>
4416
4415
  * <li>
@@ -4425,17 +4424,18 @@ export interface UpdateApiCacheRequest {
4425
4424
  * </ul>
4426
4425
  * <p>Metrics will be recorded by API ID. You can set the value to <code>ENABLED</code> or
4427
4426
  * <code>DISABLED</code>.</p>
4427
+ * @public
4428
4428
  */
4429
4429
  healthMetricsConfig?: CacheHealthMetricsConfig;
4430
4430
  }
4431
4431
  /**
4432
- * @public
4433
4432
  * <p>Represents the output of a <code>UpdateApiCache</code> operation.</p>
4433
+ * @public
4434
4434
  */
4435
4435
  export interface UpdateApiCacheResponse {
4436
4436
  /**
4437
- * @public
4438
4437
  * <p>The <code>ApiCache</code> object.</p>
4438
+ * @public
4439
4439
  */
4440
4440
  apiCache?: ApiCache;
4441
4441
  }
@@ -4444,24 +4444,24 @@ export interface UpdateApiCacheResponse {
4444
4444
  */
4445
4445
  export interface UpdateApiKeyRequest {
4446
4446
  /**
4447
- * @public
4448
4447
  * <p>The ID for the GraphQL API.</p>
4448
+ * @public
4449
4449
  */
4450
4450
  apiId: string | undefined;
4451
4451
  /**
4452
- * @public
4453
4452
  * <p>The API key ID.</p>
4453
+ * @public
4454
4454
  */
4455
4455
  id: string | undefined;
4456
4456
  /**
4457
- * @public
4458
4457
  * <p>A description of the purpose of the API key.</p>
4458
+ * @public
4459
4459
  */
4460
4460
  description?: string;
4461
4461
  /**
4462
- * @public
4463
4462
  * <p>From the update time, the time after which the API key expires. The date is represented as seconds since the
4464
4463
  * epoch. For more information, see .</p>
4464
+ * @public
4465
4465
  */
4466
4466
  expires?: number;
4467
4467
  }
@@ -4470,8 +4470,8 @@ export interface UpdateApiKeyRequest {
4470
4470
  */
4471
4471
  export interface UpdateApiKeyResponse {
4472
4472
  /**
4473
- * @public
4474
4473
  * <p>The API key.</p>
4474
+ * @public
4475
4475
  */
4476
4476
  apiKey?: ApiKey;
4477
4477
  }
@@ -4480,69 +4480,68 @@ export interface UpdateApiKeyResponse {
4480
4480
  */
4481
4481
  export interface UpdateDataSourceRequest {
4482
4482
  /**
4483
- * @public
4484
4483
  * <p>The API ID.</p>
4484
+ * @public
4485
4485
  */
4486
4486
  apiId: string | undefined;
4487
4487
  /**
4488
- * @public
4489
4488
  * <p>The new name for the data source.</p>
4489
+ * @public
4490
4490
  */
4491
4491
  name: string | undefined;
4492
4492
  /**
4493
- * @public
4494
4493
  * <p>The new description for the data source.</p>
4494
+ * @public
4495
4495
  */
4496
4496
  description?: string;
4497
4497
  /**
4498
- * @public
4499
4498
  * <p>The new data source type.</p>
4499
+ * @public
4500
4500
  */
4501
4501
  type: DataSourceType | undefined;
4502
4502
  /**
4503
- * @public
4504
4503
  * <p>The new service role Amazon Resource Name (ARN) for the data source.</p>
4504
+ * @public
4505
4505
  */
4506
4506
  serviceRoleArn?: string;
4507
4507
  /**
4508
- * @public
4509
4508
  * <p>The new Amazon DynamoDB configuration.</p>
4509
+ * @public
4510
4510
  */
4511
4511
  dynamodbConfig?: DynamodbDataSourceConfig;
4512
4512
  /**
4513
- * @public
4514
4513
  * <p>The new Lambda configuration.</p>
4514
+ * @public
4515
4515
  */
4516
4516
  lambdaConfig?: LambdaDataSourceConfig;
4517
4517
  /**
4518
- * @public
4519
4518
  * <p>The new OpenSearch configuration.</p>
4520
4519
  * <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is
4521
4520
  * deprecated. Instead, use <a>UpdateDataSourceRequest$openSearchServiceConfig</a> to update an OpenSearch data source.</p>
4521
+ * @public
4522
4522
  */
4523
4523
  elasticsearchConfig?: ElasticsearchDataSourceConfig;
4524
4524
  /**
4525
- * @public
4526
4525
  * <p>The new OpenSearch configuration.</p>
4526
+ * @public
4527
4527
  */
4528
4528
  openSearchServiceConfig?: OpenSearchServiceDataSourceConfig;
4529
4529
  /**
4530
- * @public
4531
4530
  * <p>The new HTTP endpoint configuration.</p>
4531
+ * @public
4532
4532
  */
4533
4533
  httpConfig?: HttpDataSourceConfig;
4534
4534
  /**
4535
- * @public
4536
4535
  * <p>The new relational database configuration.</p>
4536
+ * @public
4537
4537
  */
4538
4538
  relationalDatabaseConfig?: RelationalDatabaseDataSourceConfig;
4539
4539
  /**
4540
- * @public
4541
4540
  * <p>The new Amazon EventBridge settings.</p>
4541
+ * @public
4542
4542
  */
4543
4543
  eventBridgeConfig?: EventBridgeDataSourceConfig;
4544
4544
  /**
4545
- * @public
4546
4545
  * <p>Enables or disables enhanced data source metrics for specified data sources. Note that
4547
4546
  * <code>metricsConfig</code> won't be used unless the <code>dataSourceLevelMetricsBehavior</code> value is set
4548
4547
  * to <code>PER_DATA_SOURCE_METRICS</code>. If the <code>dataSourceLevelMetricsBehavior</code> is set to
@@ -4550,6 +4549,7 @@ export interface UpdateDataSourceRequest {
4550
4549
  * you can still set its value.</p>
4551
4550
  * <p>
4552
4551
  * <code>metricsConfig</code> can be <code>ENABLED</code> or <code>DISABLED</code>.</p>
4552
+ * @public
4553
4553
  */
4554
4554
  metricsConfig?: DataSourceLevelMetricsConfig;
4555
4555
  }
@@ -4558,8 +4558,8 @@ export interface UpdateDataSourceRequest {
4558
4558
  */
4559
4559
  export interface UpdateDataSourceResponse {
4560
4560
  /**
4561
- * @public
4562
4561
  * <p>The updated <code>DataSource</code> object.</p>
4562
+ * @public
4563
4563
  */
4564
4564
  dataSource?: DataSource;
4565
4565
  }
@@ -4568,13 +4568,13 @@ export interface UpdateDataSourceResponse {
4568
4568
  */
4569
4569
  export interface UpdateDomainNameRequest {
4570
4570
  /**
4571
- * @public
4572
4571
  * <p>The domain name.</p>
4572
+ * @public
4573
4573
  */
4574
4574
  domainName: string | undefined;
4575
4575
  /**
4576
- * @public
4577
4576
  * <p>A description of the <code>DomainName</code>.</p>
4577
+ * @public
4578
4578
  */
4579
4579
  description?: string;
4580
4580
  }
@@ -4583,8 +4583,8 @@ export interface UpdateDomainNameRequest {
4583
4583
  */
4584
4584
  export interface UpdateDomainNameResponse {
4585
4585
  /**
4586
- * @public
4587
4586
  * <p>The configuration for the <code>DomainName</code>.</p>
4587
+ * @public
4588
4588
  */
4589
4589
  domainNameConfig?: DomainNameConfig;
4590
4590
  }
@@ -4593,71 +4593,71 @@ export interface UpdateDomainNameResponse {
4593
4593
  */
4594
4594
  export interface UpdateFunctionRequest {
4595
4595
  /**
4596
- * @public
4597
4596
  * <p>The GraphQL API ID.</p>
4597
+ * @public
4598
4598
  */
4599
4599
  apiId: string | undefined;
4600
4600
  /**
4601
- * @public
4602
4601
  * <p>The <code>Function</code> name.</p>
4602
+ * @public
4603
4603
  */
4604
4604
  name: string | undefined;
4605
4605
  /**
4606
- * @public
4607
4606
  * <p>The <code>Function</code> description.</p>
4607
+ * @public
4608
4608
  */
4609
4609
  description?: string;
4610
4610
  /**
4611
- * @public
4612
4611
  * <p>The function ID.</p>
4612
+ * @public
4613
4613
  */
4614
4614
  functionId: string | undefined;
4615
4615
  /**
4616
- * @public
4617
4616
  * <p>The <code>Function</code>
4618
4617
  * <code>DataSource</code> name.</p>
4618
+ * @public
4619
4619
  */
4620
4620
  dataSourceName: string | undefined;
4621
4621
  /**
4622
- * @public
4623
4622
  * <p>The <code>Function</code> request mapping template. Functions support only the 2018-05-29 version of the
4624
4623
  * request mapping template.</p>
4624
+ * @public
4625
4625
  */
4626
4626
  requestMappingTemplate?: string;
4627
4627
  /**
4628
- * @public
4629
4628
  * <p>The <code>Function</code> request mapping template.</p>
4629
+ * @public
4630
4630
  */
4631
4631
  responseMappingTemplate?: string;
4632
4632
  /**
4633
- * @public
4634
4633
  * <p>The <code>version</code> of the request mapping template. Currently, the supported value is 2018-05-29. Note
4635
4634
  * that when using VTL and mapping templates, the <code>functionVersion</code> is required.</p>
4635
+ * @public
4636
4636
  */
4637
4637
  functionVersion?: string;
4638
4638
  /**
4639
- * @public
4640
4639
  * <p>Describes a Sync configuration for a resolver.</p>
4641
4640
  * <p>Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is
4642
4641
  * invoked.</p>
4642
+ * @public
4643
4643
  */
4644
4644
  syncConfig?: SyncConfig;
4645
4645
  /**
4646
- * @public
4647
4646
  * <p>The maximum batching size for a resolver.</p>
4647
+ * @public
4648
4648
  */
4649
4649
  maxBatchSize?: number;
4650
4650
  /**
4651
- * @public
4652
4651
  * <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
4653
4652
  * function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must
4654
4653
  * also be specified.</p>
4654
+ * @public
4655
4655
  */
4656
4656
  runtime?: AppSyncRuntime;
4657
4657
  /**
4658
- * @public
4659
4658
  * <p>The <code>function</code> code that contains the request and response functions. When code is used, the
4660
4659
  * <code>runtime</code> is required. The <code>runtime</code> value must be <code>APPSYNC_JS</code>.</p>
4660
+ * @public
4661
4661
  */
4662
4662
  code?: string;
4663
4663
  }
@@ -4666,8 +4666,8 @@ export interface UpdateFunctionRequest {
4666
4666
  */
4667
4667
  export interface UpdateFunctionResponse {
4668
4668
  /**
4669
- * @public
4670
4669
  * <p>The <code>Function</code> object.</p>
4670
+ * @public
4671
4671
  */
4672
4672
  functionConfiguration?: FunctionConfiguration;
4673
4673
  }
@@ -4676,94 +4676,94 @@ export interface UpdateFunctionResponse {
4676
4676
  */
4677
4677
  export interface UpdateGraphqlApiRequest {
4678
4678
  /**
4679
- * @public
4680
4679
  * <p>The API ID.</p>
4680
+ * @public
4681
4681
  */
4682
4682
  apiId: string | undefined;
4683
4683
  /**
4684
- * @public
4685
4684
  * <p>The new name for the <code>GraphqlApi</code> object.</p>
4685
+ * @public
4686
4686
  */
4687
4687
  name: string | undefined;
4688
4688
  /**
4689
- * @public
4690
4689
  * <p>The Amazon CloudWatch Logs configuration for the <code>GraphqlApi</code> object.</p>
4690
+ * @public
4691
4691
  */
4692
4692
  logConfig?: LogConfig;
4693
4693
  /**
4694
- * @public
4695
4694
  * <p>The new authentication type for the <code>GraphqlApi</code> object.</p>
4695
+ * @public
4696
4696
  */
4697
4697
  authenticationType?: AuthenticationType;
4698
4698
  /**
4699
- * @public
4700
4699
  * <p>The new Amazon Cognito user pool configuration for the <code>~GraphqlApi</code> object.</p>
4700
+ * @public
4701
4701
  */
4702
4702
  userPoolConfig?: UserPoolConfig;
4703
4703
  /**
4704
- * @public
4705
4704
  * <p>The OpenID Connect configuration for the <code>GraphqlApi</code> object.</p>
4705
+ * @public
4706
4706
  */
4707
4707
  openIDConnectConfig?: OpenIDConnectConfig;
4708
4708
  /**
4709
- * @public
4710
4709
  * <p>A list of additional authentication providers for the <code>GraphqlApi</code> API.</p>
4710
+ * @public
4711
4711
  */
4712
4712
  additionalAuthenticationProviders?: AdditionalAuthenticationProvider[];
4713
4713
  /**
4714
- * @public
4715
4714
  * <p>A flag indicating whether to use X-Ray tracing for the <code>GraphqlApi</code>.</p>
4715
+ * @public
4716
4716
  */
4717
4717
  xrayEnabled?: boolean;
4718
4718
  /**
4719
- * @public
4720
4719
  * <p>Configuration for Lambda function authorization.</p>
4720
+ * @public
4721
4721
  */
4722
4722
  lambdaAuthorizerConfig?: LambdaAuthorizerConfig;
4723
4723
  /**
4724
- * @public
4725
4724
  * <p>The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role
4726
4725
  * on behalf of the Merged API to validate access to source APIs at runtime and to prompt the
4727
4726
  * <code>AUTO_MERGE</code> to update the merged API endpoint with the source API changes automatically.</p>
4727
+ * @public
4728
4728
  */
4729
4729
  mergedApiExecutionRoleArn?: string;
4730
4730
  /**
4731
- * @public
4732
4731
  * <p>The owner contact information for an API resource.</p>
4733
4732
  * <p>This field accepts any string input with a length of 0 - 256 characters.</p>
4733
+ * @public
4734
4734
  */
4735
4735
  ownerContact?: string;
4736
4736
  /**
4737
- * @public
4738
4737
  * <p>Sets the value of the GraphQL API to enable (<code>ENABLED</code>) or disable (<code>DISABLED</code>)
4739
4738
  * introspection. If no value is provided, the introspection configuration will be set to <code>ENABLED</code> by
4740
4739
  * default. This field will produce an error if the operation attempts to use the introspection feature while this
4741
4740
  * field is disabled.</p>
4742
4741
  * <p>For more information about introspection, see <a href="https://graphql.org/learn/introspection/">GraphQL
4743
4742
  * introspection</a>.</p>
4743
+ * @public
4744
4744
  */
4745
4745
  introspectionConfig?: GraphQLApiIntrospectionConfig;
4746
4746
  /**
4747
- * @public
4748
4747
  * <p>The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed
4749
4748
  * in the body of query. The default value is <code>0</code> (or unspecified), which indicates there's no depth
4750
4749
  * limit. If you set a limit, it can be between <code>1</code> and <code>75</code> nested levels. This field will
4751
4750
  * produce a limit error if the operation falls out of bounds.</p>
4752
4751
  * <p>Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error,
4753
4752
  * the error will be thrown upwards to the first nullable field available.</p>
4753
+ * @public
4754
4754
  */
4755
4755
  queryDepthLimit?: number;
4756
4756
  /**
4757
- * @public
4758
4757
  * <p>The maximum number of resolvers that can be invoked in a single request. The default value is <code>0</code>
4759
4758
  * (or unspecified), which will set the limit to <code>10000</code>. When specified, the limit value can be
4760
4759
  * between <code>1</code> and <code>10000</code>. This field will produce a limit error if the operation falls out
4761
4760
  * of bounds.</p>
4761
+ * @public
4762
4762
  */
4763
4763
  resolverCountLimit?: number;
4764
4764
  /**
4765
- * @public
4766
4765
  * <p>The <code>enhancedMetricsConfig</code> object.</p>
4766
+ * @public
4767
4767
  */
4768
4768
  enhancedMetricsConfig?: EnhancedMetricsConfig;
4769
4769
  }
@@ -4772,8 +4772,8 @@ export interface UpdateGraphqlApiRequest {
4772
4772
  */
4773
4773
  export interface UpdateGraphqlApiResponse {
4774
4774
  /**
4775
- * @public
4776
4775
  * <p>The updated <code>GraphqlApi</code> object.</p>
4776
+ * @public
4777
4777
  */
4778
4778
  graphqlApi?: GraphqlApi;
4779
4779
  }
@@ -4782,41 +4782,40 @@ export interface UpdateGraphqlApiResponse {
4782
4782
  */
4783
4783
  export interface UpdateResolverRequest {
4784
4784
  /**
4785
- * @public
4786
4785
  * <p>The API ID.</p>
4786
+ * @public
4787
4787
  */
4788
4788
  apiId: string | undefined;
4789
4789
  /**
4790
- * @public
4791
4790
  * <p>The new type name.</p>
4791
+ * @public
4792
4792
  */
4793
4793
  typeName: string | undefined;
4794
4794
  /**
4795
- * @public
4796
4795
  * <p>The new field name.</p>
4796
+ * @public
4797
4797
  */
4798
4798
  fieldName: string | undefined;
4799
4799
  /**
4800
- * @public
4801
4800
  * <p>The new data source name.</p>
4801
+ * @public
4802
4802
  */
4803
4803
  dataSourceName?: string;
4804
4804
  /**
4805
- * @public
4806
4805
  * <p>The new request mapping template.</p>
4807
4806
  * <p>A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source
4808
4807
  * can understand. Mapping templates are written in Apache Velocity Template Language (VTL).</p>
4809
4808
  * <p>VTL request mapping templates are optional when using an Lambda data source. For all other
4810
4809
  * data sources, VTL request and response mapping templates are required.</p>
4810
+ * @public
4811
4811
  */
4812
4812
  requestMappingTemplate?: string;
4813
4813
  /**
4814
- * @public
4815
4814
  * <p>The new response mapping template.</p>
4815
+ * @public
4816
4816
  */
4817
4817
  responseMappingTemplate?: string;
4818
4818
  /**
4819
- * @public
4820
4819
  * <p>The resolver type.</p>
4821
4820
  * <ul>
4822
4821
  * <li>
@@ -4831,43 +4830,43 @@ export interface UpdateResolverRequest {
4831
4830
  * resolver to run a GraphQL query against multiple data sources.</p>
4832
4831
  * </li>
4833
4832
  * </ul>
4833
+ * @public
4834
4834
  */
4835
4835
  kind?: ResolverKind;
4836
4836
  /**
4837
- * @public
4838
4837
  * <p>The <code>PipelineConfig</code>.</p>
4838
+ * @public
4839
4839
  */
4840
4840
  pipelineConfig?: PipelineConfig;
4841
4841
  /**
4842
- * @public
4843
4842
  * <p>The <code>SyncConfig</code> for a resolver attached to a versioned data source.</p>
4843
+ * @public
4844
4844
  */
4845
4845
  syncConfig?: SyncConfig;
4846
4846
  /**
4847
- * @public
4848
4847
  * <p>The caching configuration for the resolver.</p>
4848
+ * @public
4849
4849
  */
4850
4850
  cachingConfig?: CachingConfig;
4851
4851
  /**
4852
- * @public
4853
4852
  * <p>The maximum batching size for a resolver.</p>
4853
+ * @public
4854
4854
  */
4855
4855
  maxBatchSize?: number;
4856
4856
  /**
4857
- * @public
4858
4857
  * <p>Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync
4859
4858
  * function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must
4860
4859
  * also be specified.</p>
4860
+ * @public
4861
4861
  */
4862
4862
  runtime?: AppSyncRuntime;
4863
4863
  /**
4864
- * @public
4865
4864
  * <p>The <code>resolver</code> code that contains the request and response functions. When code is used, the
4866
4865
  * <code>runtime</code> is required. The <code>runtime</code> value must be <code>APPSYNC_JS</code>.</p>
4866
+ * @public
4867
4867
  */
4868
4868
  code?: string;
4869
4869
  /**
4870
- * @public
4871
4870
  * <p>Enables or disables enhanced resolver metrics for specified resolvers. Note that <code>metricsConfig</code>
4872
4871
  * won't be used unless the <code>resolverLevelMetricsBehavior</code> value is set to
4873
4872
  * <code>PER_RESOLVER_METRICS</code>. If the <code>resolverLevelMetricsBehavior</code> is set to
@@ -4875,6 +4874,7 @@ export interface UpdateResolverRequest {
4875
4874
  * can still set its value.</p>
4876
4875
  * <p>
4877
4876
  * <code>metricsConfig</code> can be <code>ENABLED</code> or <code>DISABLED</code>.</p>
4877
+ * @public
4878
4878
  */
4879
4879
  metricsConfig?: ResolverLevelMetricsConfig;
4880
4880
  }
@@ -4883,8 +4883,8 @@ export interface UpdateResolverRequest {
4883
4883
  */
4884
4884
  export interface UpdateResolverResponse {
4885
4885
  /**
4886
- * @public
4887
4886
  * <p>The updated <code>Resolver</code> object.</p>
4887
+ * @public
4888
4888
  */
4889
4889
  resolver?: Resolver;
4890
4890
  }
@@ -4893,25 +4893,25 @@ export interface UpdateResolverResponse {
4893
4893
  */
4894
4894
  export interface UpdateSourceApiAssociationRequest {
4895
4895
  /**
4896
- * @public
4897
4896
  * <p>The ID generated by the AppSync service for the source API association.</p>
4897
+ * @public
4898
4898
  */
4899
4899
  associationId: string | undefined;
4900
4900
  /**
4901
- * @public
4902
4901
  * <p>The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged
4903
4902
  * APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs
4904
4903
  * in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.</p>
4904
+ * @public
4905
4905
  */
4906
4906
  mergedApiIdentifier: string | undefined;
4907
4907
  /**
4908
- * @public
4909
4908
  * <p>The description field.</p>
4909
+ * @public
4910
4910
  */
4911
4911
  description?: string;
4912
4912
  /**
4913
- * @public
4914
4913
  * <p>The <code>SourceApiAssociationConfig</code> object data.</p>
4914
+ * @public
4915
4915
  */
4916
4916
  sourceApiAssociationConfig?: SourceApiAssociationConfig;
4917
4917
  }
@@ -4920,8 +4920,8 @@ export interface UpdateSourceApiAssociationRequest {
4920
4920
  */
4921
4921
  export interface UpdateSourceApiAssociationResponse {
4922
4922
  /**
4923
- * @public
4924
4923
  * <p>The <code>SourceApiAssociation</code> object data.</p>
4924
+ * @public
4925
4925
  */
4926
4926
  sourceApiAssociation?: SourceApiAssociation;
4927
4927
  }
@@ -4930,23 +4930,23 @@ export interface UpdateSourceApiAssociationResponse {
4930
4930
  */
4931
4931
  export interface UpdateTypeRequest {
4932
4932
  /**
4933
- * @public
4934
4933
  * <p>The API ID.</p>
4934
+ * @public
4935
4935
  */
4936
4936
  apiId: string | undefined;
4937
4937
  /**
4938
- * @public
4939
4938
  * <p>The new type name.</p>
4939
+ * @public
4940
4940
  */
4941
4941
  typeName: string | undefined;
4942
4942
  /**
4943
- * @public
4944
4943
  * <p>The new definition.</p>
4944
+ * @public
4945
4945
  */
4946
4946
  definition?: string;
4947
4947
  /**
4948
- * @public
4949
4948
  * <p>The new type format: SDL or JSON.</p>
4949
+ * @public
4950
4950
  */
4951
4951
  format: TypeDefinitionFormat | undefined;
4952
4952
  }
@@ -4955,18 +4955,17 @@ export interface UpdateTypeRequest {
4955
4955
  */
4956
4956
  export interface UpdateTypeResponse {
4957
4957
  /**
4958
- * @public
4959
4958
  * <p>The updated <code>Type</code> object.</p>
4959
+ * @public
4960
4960
  */
4961
4961
  type?: Type;
4962
4962
  }
4963
4963
  /**
4964
- * @public
4965
4964
  * <p>Represents the type data for each field retrieved from the introspection.</p>
4965
+ * @public
4966
4966
  */
4967
4967
  export interface DataSourceIntrospectionModelFieldType {
4968
4968
  /**
4969
- * @public
4970
4969
  * <p>Specifies the classification of data. For example, this could be set to values like <code>Scalar</code> or
4971
4970
  * <code>NonNull</code> to indicate a fundamental property of the field.</p>
4972
4971
  * <p>Valid values include:</p>
@@ -4984,99 +4983,100 @@ export interface DataSourceIntrospectionModelFieldType {
4984
4983
  * <code>List</code>: Indicates the field contains a list.</p>
4985
4984
  * </li>
4986
4985
  * </ul>
4986
+ * @public
4987
4987
  */
4988
4988
  kind?: string;
4989
4989
  /**
4990
- * @public
4991
4990
  * <p>The name of the data type that represents the field. For example, <code>String</code> is a valid
4992
4991
  * <code>name</code> value.</p>
4992
+ * @public
4993
4993
  */
4994
4994
  name?: string;
4995
4995
  /**
4996
- * @public
4997
4996
  * <p>The <code>DataSourceIntrospectionModelFieldType</code> object data. The <code>type</code> is only present if
4998
4997
  * <code>DataSourceIntrospectionModelFieldType.kind</code> is set to <code>NonNull</code> or <code>List</code>. </p>
4999
4998
  * <p>The <code>type</code> typically contains its own <code>kind</code> and <code>name</code> fields to represent
5000
4999
  * the actual type data. For instance, <code>type</code> could contain a <code>kind</code> value of
5001
5000
  * <code>Scalar</code> with a <code>name</code> value of <code>String</code>. The values <code>Scalar</code>
5002
5001
  * and <code>String</code> will be collectively stored in the <code>values</code> field.</p>
5002
+ * @public
5003
5003
  */
5004
5004
  type?: DataSourceIntrospectionModelFieldType;
5005
5005
  /**
5006
- * @public
5007
5006
  * <p>The values of the <code>type</code> field. This field represents the AppSync data type equivalent of the
5008
5007
  * introspected field.</p>
5008
+ * @public
5009
5009
  */
5010
5010
  values?: string[];
5011
5011
  }
5012
5012
  /**
5013
- * @public
5014
5013
  * <p>Represents the fields that were retrieved from the introspected data.</p>
5014
+ * @public
5015
5015
  */
5016
5016
  export interface DataSourceIntrospectionModelField {
5017
5017
  /**
5018
- * @public
5019
5018
  * <p>The name of the field that was retrieved from the introspected data.</p>
5019
+ * @public
5020
5020
  */
5021
5021
  name?: string;
5022
5022
  /**
5023
- * @public
5024
5023
  * <p>The <code>DataSourceIntrospectionModelFieldType</code> object data.</p>
5024
+ * @public
5025
5025
  */
5026
5026
  type?: DataSourceIntrospectionModelFieldType;
5027
5027
  /**
5028
- * @public
5029
5028
  * <p>The length value of the introspected field.</p>
5029
+ * @public
5030
5030
  */
5031
5031
  length?: number;
5032
5032
  }
5033
5033
  /**
5034
- * @public
5035
5034
  * <p>Contains the introspected data that was retrieved from the data source.</p>
5035
+ * @public
5036
5036
  */
5037
5037
  export interface DataSourceIntrospectionModel {
5038
5038
  /**
5039
- * @public
5040
5039
  * <p>The name of the model. For example, this could be the name of a single table in a database.</p>
5040
+ * @public
5041
5041
  */
5042
5042
  name?: string;
5043
5043
  /**
5044
- * @public
5045
5044
  * <p>The <code>DataSourceIntrospectionModelField</code> object data.</p>
5045
+ * @public
5046
5046
  */
5047
5047
  fields?: DataSourceIntrospectionModelField[];
5048
5048
  /**
5049
- * @public
5050
5049
  * <p>The primary key stored as a <code>DataSourceIntrospectionModelIndex</code> object.</p>
5050
+ * @public
5051
5051
  */
5052
5052
  primaryKey?: DataSourceIntrospectionModelIndex;
5053
5053
  /**
5054
- * @public
5055
5054
  * <p>The array of <code>DataSourceIntrospectionModelIndex</code> objects.</p>
5055
+ * @public
5056
5056
  */
5057
5057
  indexes?: DataSourceIntrospectionModelIndex[];
5058
5058
  /**
5059
- * @public
5060
5059
  * <p>Contains the output of the SDL that was generated from the introspected types. This is controlled by the
5061
5060
  * <code>includeModelsSDL</code> parameter of the <code>GetDataSourceIntrospection</code> operation.</p>
5061
+ * @public
5062
5062
  */
5063
5063
  sdl?: string;
5064
5064
  }
5065
5065
  /**
5066
- * @public
5067
5066
  * <p>Represents the output of a <code>DataSourceIntrospectionResult</code>. This is the populated result of a
5068
5067
  * <code>GetDataSourceIntrospection</code> operation.</p>
5068
+ * @public
5069
5069
  */
5070
5070
  export interface DataSourceIntrospectionResult {
5071
5071
  /**
5072
- * @public
5073
5072
  * <p>The array of <code>DataSourceIntrospectionModel</code> objects.</p>
5073
+ * @public
5074
5074
  */
5075
5075
  models?: DataSourceIntrospectionModel[];
5076
5076
  /**
5077
- * @public
5078
5077
  * <p>Determines the number of types to be returned in a single response before paginating. This value is
5079
5078
  * typically taken from <code>nextToken</code> value from the previous response.</p>
5079
+ * @public
5080
5080
  */
5081
5081
  nextToken?: string;
5082
5082
  }
@@ -5085,30 +5085,30 @@ export interface DataSourceIntrospectionResult {
5085
5085
  */
5086
5086
  export interface GetDataSourceIntrospectionResponse {
5087
5087
  /**
5088
- * @public
5089
5088
  * <p>The introspection ID. Each introspection contains a unique ID that can be used to reference the
5090
5089
  * instrospection record.</p>
5090
+ * @public
5091
5091
  */
5092
5092
  introspectionId?: string;
5093
5093
  /**
5094
- * @public
5095
5094
  * <p>The status of the introspection during retrieval. By default, when a new instrospection is being retrieved,
5096
5095
  * the status will be set to <code>PROCESSING</code>. Once the operation has been completed, the status will
5097
5096
  * change to <code>SUCCESS</code> or <code>FAILED</code> depending on how the data was parsed. A
5098
5097
  * <code>FAILED</code> operation will return an error and its details as an
5099
5098
  * <code>introspectionStatusDetail</code>.</p>
5099
+ * @public
5100
5100
  */
5101
5101
  introspectionStatus?: DataSourceIntrospectionStatus;
5102
5102
  /**
5103
- * @public
5104
5103
  * <p>The error detail field. When a <code>FAILED</code>
5105
5104
  * <code>introspectionStatus</code> is returned, the <code>introspectionStatusDetail</code> will also return the
5106
5105
  * exact error that was generated during the operation.</p>
5106
+ * @public
5107
5107
  */
5108
5108
  introspectionStatusDetail?: string;
5109
5109
  /**
5110
- * @public
5111
5110
  * <p>The <code>DataSourceIntrospectionResult</code> object data.</p>
5111
+ * @public
5112
5112
  */
5113
5113
  introspectionResult?: DataSourceIntrospectionResult;
5114
5114
  }