UNPKG

62.3 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class AppSync extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: AppSync.Types.ClientConfiguration)
13 config: Config & AppSync.Types.ClientConfiguration;
14 /**
15 * Creates a cache for the GraphQL API.
16 */
17 createApiCache(params: AppSync.Types.CreateApiCacheRequest, callback?: (err: AWSError, data: AppSync.Types.CreateApiCacheResponse) => void): Request<AppSync.Types.CreateApiCacheResponse, AWSError>;
18 /**
19 * Creates a cache for the GraphQL API.
20 */
21 createApiCache(callback?: (err: AWSError, data: AppSync.Types.CreateApiCacheResponse) => void): Request<AppSync.Types.CreateApiCacheResponse, AWSError>;
22 /**
23 * Creates a unique key that you can distribute to clients who are executing your API.
24 */
25 createApiKey(params: AppSync.Types.CreateApiKeyRequest, callback?: (err: AWSError, data: AppSync.Types.CreateApiKeyResponse) => void): Request<AppSync.Types.CreateApiKeyResponse, AWSError>;
26 /**
27 * Creates a unique key that you can distribute to clients who are executing your API.
28 */
29 createApiKey(callback?: (err: AWSError, data: AppSync.Types.CreateApiKeyResponse) => void): Request<AppSync.Types.CreateApiKeyResponse, AWSError>;
30 /**
31 * Creates a DataSource object.
32 */
33 createDataSource(params: AppSync.Types.CreateDataSourceRequest, callback?: (err: AWSError, data: AppSync.Types.CreateDataSourceResponse) => void): Request<AppSync.Types.CreateDataSourceResponse, AWSError>;
34 /**
35 * Creates a DataSource object.
36 */
37 createDataSource(callback?: (err: AWSError, data: AppSync.Types.CreateDataSourceResponse) => void): Request<AppSync.Types.CreateDataSourceResponse, AWSError>;
38 /**
39 * Creates a Function object. A function is a reusable entity. Multiple functions can be used to compose the resolver logic.
40 */
41 createFunction(params: AppSync.Types.CreateFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.CreateFunctionResponse) => void): Request<AppSync.Types.CreateFunctionResponse, AWSError>;
42 /**
43 * Creates a Function object. A function is a reusable entity. Multiple functions can be used to compose the resolver logic.
44 */
45 createFunction(callback?: (err: AWSError, data: AppSync.Types.CreateFunctionResponse) => void): Request<AppSync.Types.CreateFunctionResponse, AWSError>;
46 /**
47 * Creates a GraphqlApi object.
48 */
49 createGraphqlApi(params: AppSync.Types.CreateGraphqlApiRequest, callback?: (err: AWSError, data: AppSync.Types.CreateGraphqlApiResponse) => void): Request<AppSync.Types.CreateGraphqlApiResponse, AWSError>;
50 /**
51 * Creates a GraphqlApi object.
52 */
53 createGraphqlApi(callback?: (err: AWSError, data: AppSync.Types.CreateGraphqlApiResponse) => void): Request<AppSync.Types.CreateGraphqlApiResponse, AWSError>;
54 /**
55 * Creates a Resolver object. A resolver converts incoming requests into a format that a data source can understand and converts the data source's responses into GraphQL.
56 */
57 createResolver(params: AppSync.Types.CreateResolverRequest, callback?: (err: AWSError, data: AppSync.Types.CreateResolverResponse) => void): Request<AppSync.Types.CreateResolverResponse, AWSError>;
58 /**
59 * Creates a Resolver object. A resolver converts incoming requests into a format that a data source can understand and converts the data source's responses into GraphQL.
60 */
61 createResolver(callback?: (err: AWSError, data: AppSync.Types.CreateResolverResponse) => void): Request<AppSync.Types.CreateResolverResponse, AWSError>;
62 /**
63 * Creates a Type object.
64 */
65 createType(params: AppSync.Types.CreateTypeRequest, callback?: (err: AWSError, data: AppSync.Types.CreateTypeResponse) => void): Request<AppSync.Types.CreateTypeResponse, AWSError>;
66 /**
67 * Creates a Type object.
68 */
69 createType(callback?: (err: AWSError, data: AppSync.Types.CreateTypeResponse) => void): Request<AppSync.Types.CreateTypeResponse, AWSError>;
70 /**
71 * Deletes an ApiCache object.
72 */
73 deleteApiCache(params: AppSync.Types.DeleteApiCacheRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteApiCacheResponse) => void): Request<AppSync.Types.DeleteApiCacheResponse, AWSError>;
74 /**
75 * Deletes an ApiCache object.
76 */
77 deleteApiCache(callback?: (err: AWSError, data: AppSync.Types.DeleteApiCacheResponse) => void): Request<AppSync.Types.DeleteApiCacheResponse, AWSError>;
78 /**
79 * Deletes an API key.
80 */
81 deleteApiKey(params: AppSync.Types.DeleteApiKeyRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteApiKeyResponse) => void): Request<AppSync.Types.DeleteApiKeyResponse, AWSError>;
82 /**
83 * Deletes an API key.
84 */
85 deleteApiKey(callback?: (err: AWSError, data: AppSync.Types.DeleteApiKeyResponse) => void): Request<AppSync.Types.DeleteApiKeyResponse, AWSError>;
86 /**
87 * Deletes a DataSource object.
88 */
89 deleteDataSource(params: AppSync.Types.DeleteDataSourceRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteDataSourceResponse) => void): Request<AppSync.Types.DeleteDataSourceResponse, AWSError>;
90 /**
91 * Deletes a DataSource object.
92 */
93 deleteDataSource(callback?: (err: AWSError, data: AppSync.Types.DeleteDataSourceResponse) => void): Request<AppSync.Types.DeleteDataSourceResponse, AWSError>;
94 /**
95 * Deletes a Function.
96 */
97 deleteFunction(params: AppSync.Types.DeleteFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteFunctionResponse) => void): Request<AppSync.Types.DeleteFunctionResponse, AWSError>;
98 /**
99 * Deletes a Function.
100 */
101 deleteFunction(callback?: (err: AWSError, data: AppSync.Types.DeleteFunctionResponse) => void): Request<AppSync.Types.DeleteFunctionResponse, AWSError>;
102 /**
103 * Deletes a GraphqlApi object.
104 */
105 deleteGraphqlApi(params: AppSync.Types.DeleteGraphqlApiRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteGraphqlApiResponse) => void): Request<AppSync.Types.DeleteGraphqlApiResponse, AWSError>;
106 /**
107 * Deletes a GraphqlApi object.
108 */
109 deleteGraphqlApi(callback?: (err: AWSError, data: AppSync.Types.DeleteGraphqlApiResponse) => void): Request<AppSync.Types.DeleteGraphqlApiResponse, AWSError>;
110 /**
111 * Deletes a Resolver object.
112 */
113 deleteResolver(params: AppSync.Types.DeleteResolverRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteResolverResponse) => void): Request<AppSync.Types.DeleteResolverResponse, AWSError>;
114 /**
115 * Deletes a Resolver object.
116 */
117 deleteResolver(callback?: (err: AWSError, data: AppSync.Types.DeleteResolverResponse) => void): Request<AppSync.Types.DeleteResolverResponse, AWSError>;
118 /**
119 * Deletes a Type object.
120 */
121 deleteType(params: AppSync.Types.DeleteTypeRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteTypeResponse) => void): Request<AppSync.Types.DeleteTypeResponse, AWSError>;
122 /**
123 * Deletes a Type object.
124 */
125 deleteType(callback?: (err: AWSError, data: AppSync.Types.DeleteTypeResponse) => void): Request<AppSync.Types.DeleteTypeResponse, AWSError>;
126 /**
127 * Flushes an ApiCache object.
128 */
129 flushApiCache(params: AppSync.Types.FlushApiCacheRequest, callback?: (err: AWSError, data: AppSync.Types.FlushApiCacheResponse) => void): Request<AppSync.Types.FlushApiCacheResponse, AWSError>;
130 /**
131 * Flushes an ApiCache object.
132 */
133 flushApiCache(callback?: (err: AWSError, data: AppSync.Types.FlushApiCacheResponse) => void): Request<AppSync.Types.FlushApiCacheResponse, AWSError>;
134 /**
135 * Retrieves an ApiCache object.
136 */
137 getApiCache(params: AppSync.Types.GetApiCacheRequest, callback?: (err: AWSError, data: AppSync.Types.GetApiCacheResponse) => void): Request<AppSync.Types.GetApiCacheResponse, AWSError>;
138 /**
139 * Retrieves an ApiCache object.
140 */
141 getApiCache(callback?: (err: AWSError, data: AppSync.Types.GetApiCacheResponse) => void): Request<AppSync.Types.GetApiCacheResponse, AWSError>;
142 /**
143 * Retrieves a DataSource object.
144 */
145 getDataSource(params: AppSync.Types.GetDataSourceRequest, callback?: (err: AWSError, data: AppSync.Types.GetDataSourceResponse) => void): Request<AppSync.Types.GetDataSourceResponse, AWSError>;
146 /**
147 * Retrieves a DataSource object.
148 */
149 getDataSource(callback?: (err: AWSError, data: AppSync.Types.GetDataSourceResponse) => void): Request<AppSync.Types.GetDataSourceResponse, AWSError>;
150 /**
151 * Get a Function.
152 */
153 getFunction(params: AppSync.Types.GetFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.GetFunctionResponse) => void): Request<AppSync.Types.GetFunctionResponse, AWSError>;
154 /**
155 * Get a Function.
156 */
157 getFunction(callback?: (err: AWSError, data: AppSync.Types.GetFunctionResponse) => void): Request<AppSync.Types.GetFunctionResponse, AWSError>;
158 /**
159 * Retrieves a GraphqlApi object.
160 */
161 getGraphqlApi(params: AppSync.Types.GetGraphqlApiRequest, callback?: (err: AWSError, data: AppSync.Types.GetGraphqlApiResponse) => void): Request<AppSync.Types.GetGraphqlApiResponse, AWSError>;
162 /**
163 * Retrieves a GraphqlApi object.
164 */
165 getGraphqlApi(callback?: (err: AWSError, data: AppSync.Types.GetGraphqlApiResponse) => void): Request<AppSync.Types.GetGraphqlApiResponse, AWSError>;
166 /**
167 * Retrieves the introspection schema for a GraphQL API.
168 */
169 getIntrospectionSchema(params: AppSync.Types.GetIntrospectionSchemaRequest, callback?: (err: AWSError, data: AppSync.Types.GetIntrospectionSchemaResponse) => void): Request<AppSync.Types.GetIntrospectionSchemaResponse, AWSError>;
170 /**
171 * Retrieves the introspection schema for a GraphQL API.
172 */
173 getIntrospectionSchema(callback?: (err: AWSError, data: AppSync.Types.GetIntrospectionSchemaResponse) => void): Request<AppSync.Types.GetIntrospectionSchemaResponse, AWSError>;
174 /**
175 * Retrieves a Resolver object.
176 */
177 getResolver(params: AppSync.Types.GetResolverRequest, callback?: (err: AWSError, data: AppSync.Types.GetResolverResponse) => void): Request<AppSync.Types.GetResolverResponse, AWSError>;
178 /**
179 * Retrieves a Resolver object.
180 */
181 getResolver(callback?: (err: AWSError, data: AppSync.Types.GetResolverResponse) => void): Request<AppSync.Types.GetResolverResponse, AWSError>;
182 /**
183 * Retrieves the current status of a schema creation operation.
184 */
185 getSchemaCreationStatus(params: AppSync.Types.GetSchemaCreationStatusRequest, callback?: (err: AWSError, data: AppSync.Types.GetSchemaCreationStatusResponse) => void): Request<AppSync.Types.GetSchemaCreationStatusResponse, AWSError>;
186 /**
187 * Retrieves the current status of a schema creation operation.
188 */
189 getSchemaCreationStatus(callback?: (err: AWSError, data: AppSync.Types.GetSchemaCreationStatusResponse) => void): Request<AppSync.Types.GetSchemaCreationStatusResponse, AWSError>;
190 /**
191 * Retrieves a Type object.
192 */
193 getType(params: AppSync.Types.GetTypeRequest, callback?: (err: AWSError, data: AppSync.Types.GetTypeResponse) => void): Request<AppSync.Types.GetTypeResponse, AWSError>;
194 /**
195 * Retrieves a Type object.
196 */
197 getType(callback?: (err: AWSError, data: AppSync.Types.GetTypeResponse) => void): Request<AppSync.Types.GetTypeResponse, AWSError>;
198 /**
199 * Lists the API keys for a given API. API keys are deleted automatically sometime after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call DeleteApiKey to manually delete a key before it's automatically deleted.
200 */
201 listApiKeys(params: AppSync.Types.ListApiKeysRequest, callback?: (err: AWSError, data: AppSync.Types.ListApiKeysResponse) => void): Request<AppSync.Types.ListApiKeysResponse, AWSError>;
202 /**
203 * Lists the API keys for a given API. API keys are deleted automatically sometime after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call DeleteApiKey to manually delete a key before it's automatically deleted.
204 */
205 listApiKeys(callback?: (err: AWSError, data: AppSync.Types.ListApiKeysResponse) => void): Request<AppSync.Types.ListApiKeysResponse, AWSError>;
206 /**
207 * Lists the data sources for a given API.
208 */
209 listDataSources(params: AppSync.Types.ListDataSourcesRequest, callback?: (err: AWSError, data: AppSync.Types.ListDataSourcesResponse) => void): Request<AppSync.Types.ListDataSourcesResponse, AWSError>;
210 /**
211 * Lists the data sources for a given API.
212 */
213 listDataSources(callback?: (err: AWSError, data: AppSync.Types.ListDataSourcesResponse) => void): Request<AppSync.Types.ListDataSourcesResponse, AWSError>;
214 /**
215 * List multiple functions.
216 */
217 listFunctions(params: AppSync.Types.ListFunctionsRequest, callback?: (err: AWSError, data: AppSync.Types.ListFunctionsResponse) => void): Request<AppSync.Types.ListFunctionsResponse, AWSError>;
218 /**
219 * List multiple functions.
220 */
221 listFunctions(callback?: (err: AWSError, data: AppSync.Types.ListFunctionsResponse) => void): Request<AppSync.Types.ListFunctionsResponse, AWSError>;
222 /**
223 * Lists your GraphQL APIs.
224 */
225 listGraphqlApis(params: AppSync.Types.ListGraphqlApisRequest, callback?: (err: AWSError, data: AppSync.Types.ListGraphqlApisResponse) => void): Request<AppSync.Types.ListGraphqlApisResponse, AWSError>;
226 /**
227 * Lists your GraphQL APIs.
228 */
229 listGraphqlApis(callback?: (err: AWSError, data: AppSync.Types.ListGraphqlApisResponse) => void): Request<AppSync.Types.ListGraphqlApisResponse, AWSError>;
230 /**
231 * Lists the resolvers for a given API and type.
232 */
233 listResolvers(params: AppSync.Types.ListResolversRequest, callback?: (err: AWSError, data: AppSync.Types.ListResolversResponse) => void): Request<AppSync.Types.ListResolversResponse, AWSError>;
234 /**
235 * Lists the resolvers for a given API and type.
236 */
237 listResolvers(callback?: (err: AWSError, data: AppSync.Types.ListResolversResponse) => void): Request<AppSync.Types.ListResolversResponse, AWSError>;
238 /**
239 * List the resolvers that are associated with a specific function.
240 */
241 listResolversByFunction(params: AppSync.Types.ListResolversByFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.ListResolversByFunctionResponse) => void): Request<AppSync.Types.ListResolversByFunctionResponse, AWSError>;
242 /**
243 * List the resolvers that are associated with a specific function.
244 */
245 listResolversByFunction(callback?: (err: AWSError, data: AppSync.Types.ListResolversByFunctionResponse) => void): Request<AppSync.Types.ListResolversByFunctionResponse, AWSError>;
246 /**
247 * Lists the tags for a resource.
248 */
249 listTagsForResource(params: AppSync.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: AppSync.Types.ListTagsForResourceResponse) => void): Request<AppSync.Types.ListTagsForResourceResponse, AWSError>;
250 /**
251 * Lists the tags for a resource.
252 */
253 listTagsForResource(callback?: (err: AWSError, data: AppSync.Types.ListTagsForResourceResponse) => void): Request<AppSync.Types.ListTagsForResourceResponse, AWSError>;
254 /**
255 * Lists the types for a given API.
256 */
257 listTypes(params: AppSync.Types.ListTypesRequest, callback?: (err: AWSError, data: AppSync.Types.ListTypesResponse) => void): Request<AppSync.Types.ListTypesResponse, AWSError>;
258 /**
259 * Lists the types for a given API.
260 */
261 listTypes(callback?: (err: AWSError, data: AppSync.Types.ListTypesResponse) => void): Request<AppSync.Types.ListTypesResponse, AWSError>;
262 /**
263 * Adds a new schema to your GraphQL API. This operation is asynchronous. Use to determine when it has completed.
264 */
265 startSchemaCreation(params: AppSync.Types.StartSchemaCreationRequest, callback?: (err: AWSError, data: AppSync.Types.StartSchemaCreationResponse) => void): Request<AppSync.Types.StartSchemaCreationResponse, AWSError>;
266 /**
267 * Adds a new schema to your GraphQL API. This operation is asynchronous. Use to determine when it has completed.
268 */
269 startSchemaCreation(callback?: (err: AWSError, data: AppSync.Types.StartSchemaCreationResponse) => void): Request<AppSync.Types.StartSchemaCreationResponse, AWSError>;
270 /**
271 * Tags a resource with user-supplied tags.
272 */
273 tagResource(params: AppSync.Types.TagResourceRequest, callback?: (err: AWSError, data: AppSync.Types.TagResourceResponse) => void): Request<AppSync.Types.TagResourceResponse, AWSError>;
274 /**
275 * Tags a resource with user-supplied tags.
276 */
277 tagResource(callback?: (err: AWSError, data: AppSync.Types.TagResourceResponse) => void): Request<AppSync.Types.TagResourceResponse, AWSError>;
278 /**
279 * Untags a resource.
280 */
281 untagResource(params: AppSync.Types.UntagResourceRequest, callback?: (err: AWSError, data: AppSync.Types.UntagResourceResponse) => void): Request<AppSync.Types.UntagResourceResponse, AWSError>;
282 /**
283 * Untags a resource.
284 */
285 untagResource(callback?: (err: AWSError, data: AppSync.Types.UntagResourceResponse) => void): Request<AppSync.Types.UntagResourceResponse, AWSError>;
286 /**
287 * Updates the cache for the GraphQL API.
288 */
289 updateApiCache(params: AppSync.Types.UpdateApiCacheRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateApiCacheResponse) => void): Request<AppSync.Types.UpdateApiCacheResponse, AWSError>;
290 /**
291 * Updates the cache for the GraphQL API.
292 */
293 updateApiCache(callback?: (err: AWSError, data: AppSync.Types.UpdateApiCacheResponse) => void): Request<AppSync.Types.UpdateApiCacheResponse, AWSError>;
294 /**
295 * Updates an API key.
296 */
297 updateApiKey(params: AppSync.Types.UpdateApiKeyRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateApiKeyResponse) => void): Request<AppSync.Types.UpdateApiKeyResponse, AWSError>;
298 /**
299 * Updates an API key.
300 */
301 updateApiKey(callback?: (err: AWSError, data: AppSync.Types.UpdateApiKeyResponse) => void): Request<AppSync.Types.UpdateApiKeyResponse, AWSError>;
302 /**
303 * Updates a DataSource object.
304 */
305 updateDataSource(params: AppSync.Types.UpdateDataSourceRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateDataSourceResponse) => void): Request<AppSync.Types.UpdateDataSourceResponse, AWSError>;
306 /**
307 * Updates a DataSource object.
308 */
309 updateDataSource(callback?: (err: AWSError, data: AppSync.Types.UpdateDataSourceResponse) => void): Request<AppSync.Types.UpdateDataSourceResponse, AWSError>;
310 /**
311 * Updates a Function object.
312 */
313 updateFunction(params: AppSync.Types.UpdateFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateFunctionResponse) => void): Request<AppSync.Types.UpdateFunctionResponse, AWSError>;
314 /**
315 * Updates a Function object.
316 */
317 updateFunction(callback?: (err: AWSError, data: AppSync.Types.UpdateFunctionResponse) => void): Request<AppSync.Types.UpdateFunctionResponse, AWSError>;
318 /**
319 * Updates a GraphqlApi object.
320 */
321 updateGraphqlApi(params: AppSync.Types.UpdateGraphqlApiRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateGraphqlApiResponse) => void): Request<AppSync.Types.UpdateGraphqlApiResponse, AWSError>;
322 /**
323 * Updates a GraphqlApi object.
324 */
325 updateGraphqlApi(callback?: (err: AWSError, data: AppSync.Types.UpdateGraphqlApiResponse) => void): Request<AppSync.Types.UpdateGraphqlApiResponse, AWSError>;
326 /**
327 * Updates a Resolver object.
328 */
329 updateResolver(params: AppSync.Types.UpdateResolverRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateResolverResponse) => void): Request<AppSync.Types.UpdateResolverResponse, AWSError>;
330 /**
331 * Updates a Resolver object.
332 */
333 updateResolver(callback?: (err: AWSError, data: AppSync.Types.UpdateResolverResponse) => void): Request<AppSync.Types.UpdateResolverResponse, AWSError>;
334 /**
335 * Updates a Type object.
336 */
337 updateType(params: AppSync.Types.UpdateTypeRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateTypeResponse) => void): Request<AppSync.Types.UpdateTypeResponse, AWSError>;
338 /**
339 * Updates a Type object.
340 */
341 updateType(callback?: (err: AWSError, data: AppSync.Types.UpdateTypeResponse) => void): Request<AppSync.Types.UpdateTypeResponse, AWSError>;
342}
343declare namespace AppSync {
344 export interface AdditionalAuthenticationProvider {
345 /**
346 * The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
347 */
348 authenticationType?: AuthenticationType;
349 /**
350 * The OpenID Connect configuration.
351 */
352 openIDConnectConfig?: OpenIDConnectConfig;
353 /**
354 * The Amazon Cognito user pool configuration.
355 */
356 userPoolConfig?: CognitoUserPoolConfig;
357 }
358 export type AdditionalAuthenticationProviders = AdditionalAuthenticationProvider[];
359 export interface ApiCache {
360 /**
361 * TTL in seconds for cache entries. Valid values are between 1 and 3600 seconds.
362 */
363 ttl?: Long;
364 /**
365 * Caching behavior. FULL_REQUEST_CACHING: All requests are fully cached. PER_RESOLVER_CACHING: Individual resovlers that you specify are cached.
366 */
367 apiCachingBehavior?: ApiCachingBehavior;
368 /**
369 * Transit encryption flag when connecting to cache. This setting cannot be updated after creation.
370 */
371 transitEncryptionEnabled?: Boolean;
372 /**
373 * At rest encryption flag for cache. This setting cannot be updated after creation.
374 */
375 atRestEncryptionEnabled?: Boolean;
376 /**
377 * The cache instance type. T2_SMALL: A t2.small instance type. T2_MEDIUM: A t2.medium instance type. R4_LARGE: A r4.large instance type. R4_XLARGE: A r4.xlarge instance type. R4_2XLARGE: A r4.2xlarge instance type. R4_4XLARGE: A r4.4xlarge instance type. R4_8XLARGE: A r4.8xlarge instance type.
378 */
379 type?: ApiCacheType;
380 /**
381 * The cache instance status. AVAILABLE: The instance is available for use. CREATING: The instance is currently creating. DELETING: The instance is currently deleting. MODIFYING: The instance is currently modifying. FAILED: The instance has failed creation.
382 */
383 status?: ApiCacheStatus;
384 }
385 export type ApiCacheStatus = "AVAILABLE"|"CREATING"|"DELETING"|"MODIFYING"|"FAILED"|string;
386 export type ApiCacheType = "T2_SMALL"|"T2_MEDIUM"|"R4_LARGE"|"R4_XLARGE"|"R4_2XLARGE"|"R4_4XLARGE"|"R4_8XLARGE"|string;
387 export type ApiCachingBehavior = "FULL_REQUEST_CACHING"|"PER_RESOLVER_CACHING"|string;
388 export interface ApiKey {
389 /**
390 * The API key ID.
391 */
392 id?: String;
393 /**
394 * A description of the purpose of the API key.
395 */
396 description?: String;
397 /**
398 * The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.
399 */
400 expires?: Long;
401 }
402 export type ApiKeys = ApiKey[];
403 export type AuthenticationType = "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|string;
404 export interface AuthorizationConfig {
405 /**
406 * The authorization type required by the HTTP endpoint. AWS_IAM: The authorization type is Sigv4.
407 */
408 authorizationType: AuthorizationType;
409 /**
410 * The AWS IAM settings.
411 */
412 awsIamConfig?: AwsIamConfig;
413 }
414 export type AuthorizationType = "AWS_IAM"|string;
415 export interface AwsIamConfig {
416 /**
417 * The signing region for AWS IAM authorization.
418 */
419 signingRegion?: String;
420 /**
421 * The signing service name for AWS IAM authorization.
422 */
423 signingServiceName?: String;
424 }
425 export type _Blob = Buffer|Uint8Array|Blob|string;
426 export type Boolean = boolean;
427 export type BooleanValue = boolean;
428 export interface CachingConfig {
429 /**
430 * The TTL in seconds for a resolver that has caching enabled. Valid values are between 1 and 3600 seconds.
431 */
432 ttl?: Long;
433 /**
434 * The caching keys for a resolver that has caching enabled. Valid values are entries from the $context.identity and $context.arguments maps.
435 */
436 cachingKeys?: CachingKeys;
437 }
438 export type CachingKeys = String[];
439 export interface CognitoUserPoolConfig {
440 /**
441 * The user pool ID.
442 */
443 userPoolId: String;
444 /**
445 * The AWS Region in which the user pool was created.
446 */
447 awsRegion: String;
448 /**
449 * A regular expression for validating the incoming Amazon Cognito user pool app client ID.
450 */
451 appIdClientRegex?: String;
452 }
453 export type ConflictDetectionType = "VERSION"|"NONE"|string;
454 export type ConflictHandlerType = "OPTIMISTIC_CONCURRENCY"|"LAMBDA"|"AUTOMERGE"|"NONE"|string;
455 export interface CreateApiCacheRequest {
456 /**
457 * The GraphQL API Id.
458 */
459 apiId: String;
460 /**
461 * TTL in seconds for cache entries. Valid values are between 1 and 3600 seconds.
462 */
463 ttl: Long;
464 /**
465 * Transit encryption flag when connecting to cache. This setting cannot be updated after creation.
466 */
467 transitEncryptionEnabled?: Boolean;
468 /**
469 * At rest encryption flag for cache. This setting cannot be updated after creation.
470 */
471 atRestEncryptionEnabled?: Boolean;
472 /**
473 * Caching behavior. FULL_REQUEST_CACHING: All requests are fully cached. PER_RESOLVER_CACHING: Individual resovlers that you specify are cached.
474 */
475 apiCachingBehavior: ApiCachingBehavior;
476 /**
477 * The cache instance type. T2_SMALL: A t2.small instance type. T2_MEDIUM: A t2.medium instance type. R4_LARGE: A r4.large instance type. R4_XLARGE: A r4.xlarge instance type. R4_2XLARGE: A r4.2xlarge instance type. R4_4XLARGE: A r4.4xlarge instance type. R4_8XLARGE: A r4.8xlarge instance type.
478 */
479 type: ApiCacheType;
480 }
481 export interface CreateApiCacheResponse {
482 /**
483 * The ApiCache object.
484 */
485 apiCache?: ApiCache;
486 }
487 export interface CreateApiKeyRequest {
488 /**
489 * The ID for your GraphQL API.
490 */
491 apiId: String;
492 /**
493 * A description of the purpose of the API key.
494 */
495 description?: String;
496 /**
497 * The time from creation time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see .
498 */
499 expires?: Long;
500 }
501 export interface CreateApiKeyResponse {
502 /**
503 * The API key.
504 */
505 apiKey?: ApiKey;
506 }
507 export interface CreateDataSourceRequest {
508 /**
509 * The API ID for the GraphQL API for the DataSource.
510 */
511 apiId: String;
512 /**
513 * A user-supplied name for the DataSource.
514 */
515 name: ResourceName;
516 /**
517 * A description of the DataSource.
518 */
519 description?: String;
520 /**
521 * The type of the DataSource.
522 */
523 type: DataSourceType;
524 /**
525 * The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.
526 */
527 serviceRoleArn?: String;
528 /**
529 * Amazon DynamoDB settings.
530 */
531 dynamodbConfig?: DynamodbDataSourceConfig;
532 /**
533 * AWS Lambda settings.
534 */
535 lambdaConfig?: LambdaDataSourceConfig;
536 /**
537 * Amazon Elasticsearch Service settings.
538 */
539 elasticsearchConfig?: ElasticsearchDataSourceConfig;
540 /**
541 * HTTP endpoint settings.
542 */
543 httpConfig?: HttpDataSourceConfig;
544 /**
545 * Relational database settings.
546 */
547 relationalDatabaseConfig?: RelationalDatabaseDataSourceConfig;
548 }
549 export interface CreateDataSourceResponse {
550 /**
551 * The DataSource object.
552 */
553 dataSource?: DataSource;
554 }
555 export interface CreateFunctionRequest {
556 /**
557 * The GraphQL API ID.
558 */
559 apiId: String;
560 /**
561 * The Function name. The function name does not have to be unique.
562 */
563 name: ResourceName;
564 /**
565 * The Function description.
566 */
567 description?: String;
568 /**
569 * The Function DataSource name.
570 */
571 dataSourceName: ResourceName;
572 /**
573 * The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
574 */
575 requestMappingTemplate: MappingTemplate;
576 /**
577 * The Function response mapping template.
578 */
579 responseMappingTemplate?: MappingTemplate;
580 /**
581 * The version of the request mapping template. Currently the supported value is 2018-05-29.
582 */
583 functionVersion: String;
584 }
585 export interface CreateFunctionResponse {
586 /**
587 * The Function object.
588 */
589 functionConfiguration?: FunctionConfiguration;
590 }
591 export interface CreateGraphqlApiRequest {
592 /**
593 * A user-supplied name for the GraphqlApi.
594 */
595 name: String;
596 /**
597 * The Amazon CloudWatch Logs configuration.
598 */
599 logConfig?: LogConfig;
600 /**
601 * The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
602 */
603 authenticationType: AuthenticationType;
604 /**
605 * The Amazon Cognito user pool configuration.
606 */
607 userPoolConfig?: UserPoolConfig;
608 /**
609 * The OpenID Connect configuration.
610 */
611 openIDConnectConfig?: OpenIDConnectConfig;
612 /**
613 * A TagMap object.
614 */
615 tags?: TagMap;
616 /**
617 * A list of additional authentication providers for the GraphqlApi API.
618 */
619 additionalAuthenticationProviders?: AdditionalAuthenticationProviders;
620 /**
621 * A flag indicating whether to enable X-Ray tracing for the GraphqlApi.
622 */
623 xrayEnabled?: Boolean;
624 }
625 export interface CreateGraphqlApiResponse {
626 /**
627 * The GraphqlApi.
628 */
629 graphqlApi?: GraphqlApi;
630 }
631 export interface CreateResolverRequest {
632 /**
633 * The ID for the GraphQL API for which the resolver is being created.
634 */
635 apiId: String;
636 /**
637 * The name of the Type.
638 */
639 typeName: ResourceName;
640 /**
641 * The name of the field to attach the resolver to.
642 */
643 fieldName: ResourceName;
644 /**
645 * The name of the data source for which the resolver is being created.
646 */
647 dataSourceName?: ResourceName;
648 /**
649 * The mapping template to be used for requests. A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).
650 */
651 requestMappingTemplate: MappingTemplate;
652 /**
653 * The mapping template to be used for responses from the data source.
654 */
655 responseMappingTemplate?: MappingTemplate;
656 /**
657 * The resolver type. UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source. PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
658 */
659 kind?: ResolverKind;
660 /**
661 * The PipelineConfig.
662 */
663 pipelineConfig?: PipelineConfig;
664 /**
665 * The SyncConfig for a resolver attached to a versioned datasource.
666 */
667 syncConfig?: SyncConfig;
668 /**
669 * The caching configuration for the resolver.
670 */
671 cachingConfig?: CachingConfig;
672 }
673 export interface CreateResolverResponse {
674 /**
675 * The Resolver object.
676 */
677 resolver?: Resolver;
678 }
679 export interface CreateTypeRequest {
680 /**
681 * The API ID.
682 */
683 apiId: String;
684 /**
685 * The type definition, in GraphQL Schema Definition Language (SDL) format. For more information, see the GraphQL SDL documentation.
686 */
687 definition: String;
688 /**
689 * The type format: SDL or JSON.
690 */
691 format: TypeDefinitionFormat;
692 }
693 export interface CreateTypeResponse {
694 /**
695 * The Type object.
696 */
697 type?: Type;
698 }
699 export interface DataSource {
700 /**
701 * The data source ARN.
702 */
703 dataSourceArn?: String;
704 /**
705 * The name of the data source.
706 */
707 name?: ResourceName;
708 /**
709 * The description of the data source.
710 */
711 description?: String;
712 /**
713 * The type of the data source. AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table. AMAZON_ELASTICSEARCH: The data source is an Amazon Elasticsearch Service domain. AWS_LAMBDA: The data source is an AWS Lambda function. NONE: There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation. HTTP: The data source is an HTTP endpoint. RELATIONAL_DATABASE: The data source is a relational database.
714 */
715 type?: DataSourceType;
716 /**
717 * The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.
718 */
719 serviceRoleArn?: String;
720 /**
721 * Amazon DynamoDB settings.
722 */
723 dynamodbConfig?: DynamodbDataSourceConfig;
724 /**
725 * AWS Lambda settings.
726 */
727 lambdaConfig?: LambdaDataSourceConfig;
728 /**
729 * Amazon Elasticsearch Service settings.
730 */
731 elasticsearchConfig?: ElasticsearchDataSourceConfig;
732 /**
733 * HTTP endpoint settings.
734 */
735 httpConfig?: HttpDataSourceConfig;
736 /**
737 * Relational database settings.
738 */
739 relationalDatabaseConfig?: RelationalDatabaseDataSourceConfig;
740 }
741 export type DataSourceType = "AWS_LAMBDA"|"AMAZON_DYNAMODB"|"AMAZON_ELASTICSEARCH"|"NONE"|"HTTP"|"RELATIONAL_DATABASE"|string;
742 export type DataSources = DataSource[];
743 export type DefaultAction = "ALLOW"|"DENY"|string;
744 export interface DeleteApiCacheRequest {
745 /**
746 * The API ID.
747 */
748 apiId: String;
749 }
750 export interface DeleteApiCacheResponse {
751 }
752 export interface DeleteApiKeyRequest {
753 /**
754 * The API ID.
755 */
756 apiId: String;
757 /**
758 * The ID for the API key.
759 */
760 id: String;
761 }
762 export interface DeleteApiKeyResponse {
763 }
764 export interface DeleteDataSourceRequest {
765 /**
766 * The API ID.
767 */
768 apiId: String;
769 /**
770 * The name of the data source.
771 */
772 name: ResourceName;
773 }
774 export interface DeleteDataSourceResponse {
775 }
776 export interface DeleteFunctionRequest {
777 /**
778 * The GraphQL API ID.
779 */
780 apiId: String;
781 /**
782 * The Function ID.
783 */
784 functionId: ResourceName;
785 }
786 export interface DeleteFunctionResponse {
787 }
788 export interface DeleteGraphqlApiRequest {
789 /**
790 * The API ID.
791 */
792 apiId: String;
793 }
794 export interface DeleteGraphqlApiResponse {
795 }
796 export interface DeleteResolverRequest {
797 /**
798 * The API ID.
799 */
800 apiId: String;
801 /**
802 * The name of the resolver type.
803 */
804 typeName: ResourceName;
805 /**
806 * The resolver field name.
807 */
808 fieldName: ResourceName;
809 }
810 export interface DeleteResolverResponse {
811 }
812 export interface DeleteTypeRequest {
813 /**
814 * The API ID.
815 */
816 apiId: String;
817 /**
818 * The type name.
819 */
820 typeName: ResourceName;
821 }
822 export interface DeleteTypeResponse {
823 }
824 export interface DeltaSyncConfig {
825 /**
826 * The number of minutes an Item is stored in the datasource.
827 */
828 baseTableTTL?: Long;
829 /**
830 * The Delta Sync table name.
831 */
832 deltaSyncTableName?: String;
833 /**
834 * The number of minutes a Delta Sync log entry is stored in the Delta Sync table.
835 */
836 deltaSyncTableTTL?: Long;
837 }
838 export interface DynamodbDataSourceConfig {
839 /**
840 * The table name.
841 */
842 tableName: String;
843 /**
844 * The AWS Region.
845 */
846 awsRegion: String;
847 /**
848 * Set to TRUE to use Amazon Cognito credentials with this data source.
849 */
850 useCallerCredentials?: Boolean;
851 /**
852 * The DeltaSyncConfig for a versioned datasource.
853 */
854 deltaSyncConfig?: DeltaSyncConfig;
855 /**
856 * Set to TRUE to use Conflict Detection and Resolution with this data source.
857 */
858 versioned?: Boolean;
859 }
860 export interface ElasticsearchDataSourceConfig {
861 /**
862 * The endpoint.
863 */
864 endpoint: String;
865 /**
866 * The AWS Region.
867 */
868 awsRegion: String;
869 }
870 export type FieldLogLevel = "NONE"|"ERROR"|"ALL"|string;
871 export interface FlushApiCacheRequest {
872 /**
873 * The API ID.
874 */
875 apiId: String;
876 }
877 export interface FlushApiCacheResponse {
878 }
879 export interface FunctionConfiguration {
880 /**
881 * A unique ID representing the Function object.
882 */
883 functionId?: String;
884 /**
885 * The ARN of the Function object.
886 */
887 functionArn?: String;
888 /**
889 * The name of the Function object.
890 */
891 name?: ResourceName;
892 /**
893 * The Function description.
894 */
895 description?: String;
896 /**
897 * The name of the DataSource.
898 */
899 dataSourceName?: ResourceName;
900 /**
901 * The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
902 */
903 requestMappingTemplate?: MappingTemplate;
904 /**
905 * The Function response mapping template.
906 */
907 responseMappingTemplate?: MappingTemplate;
908 /**
909 * The version of the request mapping template. Currently only the 2018-05-29 version of the template is supported.
910 */
911 functionVersion?: String;
912 }
913 export type Functions = FunctionConfiguration[];
914 export type FunctionsIds = String[];
915 export interface GetApiCacheRequest {
916 /**
917 * The API ID.
918 */
919 apiId: String;
920 }
921 export interface GetApiCacheResponse {
922 /**
923 * The ApiCache object.
924 */
925 apiCache?: ApiCache;
926 }
927 export interface GetDataSourceRequest {
928 /**
929 * The API ID.
930 */
931 apiId: String;
932 /**
933 * The name of the data source.
934 */
935 name: ResourceName;
936 }
937 export interface GetDataSourceResponse {
938 /**
939 * The DataSource object.
940 */
941 dataSource?: DataSource;
942 }
943 export interface GetFunctionRequest {
944 /**
945 * The GraphQL API ID.
946 */
947 apiId: String;
948 /**
949 * The Function ID.
950 */
951 functionId: ResourceName;
952 }
953 export interface GetFunctionResponse {
954 /**
955 * The Function object.
956 */
957 functionConfiguration?: FunctionConfiguration;
958 }
959 export interface GetGraphqlApiRequest {
960 /**
961 * The API ID for the GraphQL API.
962 */
963 apiId: String;
964 }
965 export interface GetGraphqlApiResponse {
966 /**
967 * The GraphqlApi object.
968 */
969 graphqlApi?: GraphqlApi;
970 }
971 export interface GetIntrospectionSchemaRequest {
972 /**
973 * The API ID.
974 */
975 apiId: String;
976 /**
977 * The schema format: SDL or JSON.
978 */
979 format: OutputType;
980 /**
981 * A flag that specifies whether the schema introspection should contain directives.
982 */
983 includeDirectives?: BooleanValue;
984 }
985 export interface GetIntrospectionSchemaResponse {
986 /**
987 * The schema, in GraphQL Schema Definition Language (SDL) format. For more information, see the GraphQL SDL documentation.
988 */
989 schema?: _Blob;
990 }
991 export interface GetResolverRequest {
992 /**
993 * The API ID.
994 */
995 apiId: String;
996 /**
997 * The resolver type name.
998 */
999 typeName: ResourceName;
1000 /**
1001 * The resolver field name.
1002 */
1003 fieldName: ResourceName;
1004 }
1005 export interface GetResolverResponse {
1006 /**
1007 * The Resolver object.
1008 */
1009 resolver?: Resolver;
1010 }
1011 export interface GetSchemaCreationStatusRequest {
1012 /**
1013 * The API ID.
1014 */
1015 apiId: String;
1016 }
1017 export interface GetSchemaCreationStatusResponse {
1018 /**
1019 * The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.
1020 */
1021 status?: SchemaStatus;
1022 /**
1023 * Detailed information about the status of the schema creation operation.
1024 */
1025 details?: String;
1026 }
1027 export interface GetTypeRequest {
1028 /**
1029 * The API ID.
1030 */
1031 apiId: String;
1032 /**
1033 * The type name.
1034 */
1035 typeName: ResourceName;
1036 /**
1037 * The type format: SDL or JSON.
1038 */
1039 format: TypeDefinitionFormat;
1040 }
1041 export interface GetTypeResponse {
1042 /**
1043 * The Type object.
1044 */
1045 type?: Type;
1046 }
1047 export interface GraphqlApi {
1048 /**
1049 * The API name.
1050 */
1051 name?: ResourceName;
1052 /**
1053 * The API ID.
1054 */
1055 apiId?: String;
1056 /**
1057 * The authentication type.
1058 */
1059 authenticationType?: AuthenticationType;
1060 /**
1061 * The Amazon CloudWatch Logs configuration.
1062 */
1063 logConfig?: LogConfig;
1064 /**
1065 * The Amazon Cognito user pool configuration.
1066 */
1067 userPoolConfig?: UserPoolConfig;
1068 /**
1069 * The OpenID Connect configuration.
1070 */
1071 openIDConnectConfig?: OpenIDConnectConfig;
1072 /**
1073 * The ARN.
1074 */
1075 arn?: String;
1076 /**
1077 * The URIs.
1078 */
1079 uris?: MapOfStringToString;
1080 /**
1081 * The tags.
1082 */
1083 tags?: TagMap;
1084 /**
1085 * A list of additional authentication providers for the GraphqlApi API.
1086 */
1087 additionalAuthenticationProviders?: AdditionalAuthenticationProviders;
1088 /**
1089 * A flag representing whether X-Ray tracing is enabled for this GraphqlApi.
1090 */
1091 xrayEnabled?: Boolean;
1092 }
1093 export type GraphqlApis = GraphqlApi[];
1094 export interface HttpDataSourceConfig {
1095 /**
1096 * The HTTP URL endpoint. You can either specify the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If the port is not specified, AWS AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.
1097 */
1098 endpoint?: String;
1099 /**
1100 * The authorization config in case the HTTP endpoint requires authorization.
1101 */
1102 authorizationConfig?: AuthorizationConfig;
1103 }
1104 export interface LambdaConflictHandlerConfig {
1105 /**
1106 * The Arn for the Lambda function to use as the Conflict Handler.
1107 */
1108 lambdaConflictHandlerArn?: String;
1109 }
1110 export interface LambdaDataSourceConfig {
1111 /**
1112 * The ARN for the Lambda function.
1113 */
1114 lambdaFunctionArn: String;
1115 }
1116 export interface ListApiKeysRequest {
1117 /**
1118 * The API ID.
1119 */
1120 apiId: String;
1121 /**
1122 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1123 */
1124 nextToken?: PaginationToken;
1125 /**
1126 * The maximum number of results you want the request to return.
1127 */
1128 maxResults?: MaxResults;
1129 }
1130 export interface ListApiKeysResponse {
1131 /**
1132 * The ApiKey objects.
1133 */
1134 apiKeys?: ApiKeys;
1135 /**
1136 * An identifier to be passed in the next request to this operation to return the next set of items in the list.
1137 */
1138 nextToken?: PaginationToken;
1139 }
1140 export interface ListDataSourcesRequest {
1141 /**
1142 * The API ID.
1143 */
1144 apiId: String;
1145 /**
1146 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1147 */
1148 nextToken?: PaginationToken;
1149 /**
1150 * The maximum number of results you want the request to return.
1151 */
1152 maxResults?: MaxResults;
1153 }
1154 export interface ListDataSourcesResponse {
1155 /**
1156 * The DataSource objects.
1157 */
1158 dataSources?: DataSources;
1159 /**
1160 * An identifier to be passed in the next request to this operation to return the next set of items in the list.
1161 */
1162 nextToken?: PaginationToken;
1163 }
1164 export interface ListFunctionsRequest {
1165 /**
1166 * The GraphQL API ID.
1167 */
1168 apiId: String;
1169 /**
1170 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1171 */
1172 nextToken?: PaginationToken;
1173 /**
1174 * The maximum number of results you want the request to return.
1175 */
1176 maxResults?: MaxResults;
1177 }
1178 export interface ListFunctionsResponse {
1179 /**
1180 * A list of Function objects.
1181 */
1182 functions?: Functions;
1183 /**
1184 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1185 */
1186 nextToken?: PaginationToken;
1187 }
1188 export interface ListGraphqlApisRequest {
1189 /**
1190 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1191 */
1192 nextToken?: PaginationToken;
1193 /**
1194 * The maximum number of results you want the request to return.
1195 */
1196 maxResults?: MaxResults;
1197 }
1198 export interface ListGraphqlApisResponse {
1199 /**
1200 * The GraphqlApi objects.
1201 */
1202 graphqlApis?: GraphqlApis;
1203 /**
1204 * An identifier to be passed in the next request to this operation to return the next set of items in the list.
1205 */
1206 nextToken?: PaginationToken;
1207 }
1208 export interface ListResolversByFunctionRequest {
1209 /**
1210 * The API ID.
1211 */
1212 apiId: String;
1213 /**
1214 * The Function ID.
1215 */
1216 functionId: String;
1217 /**
1218 * An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.
1219 */
1220 nextToken?: PaginationToken;
1221 /**
1222 * The maximum number of results you want the request to return.
1223 */
1224 maxResults?: MaxResults;
1225 }
1226 export interface ListResolversByFunctionResponse {
1227 /**
1228 * The list of resolvers.
1229 */
1230 resolvers?: Resolvers;
1231 /**
1232 * An identifier that can be used to return the next set of items in the list.
1233 */
1234 nextToken?: PaginationToken;
1235 }
1236 export interface ListResolversRequest {
1237 /**
1238 * The API ID.
1239 */
1240 apiId: String;
1241 /**
1242 * The type name.
1243 */
1244 typeName: String;
1245 /**
1246 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1247 */
1248 nextToken?: PaginationToken;
1249 /**
1250 * The maximum number of results you want the request to return.
1251 */
1252 maxResults?: MaxResults;
1253 }
1254 export interface ListResolversResponse {
1255 /**
1256 * The Resolver objects.
1257 */
1258 resolvers?: Resolvers;
1259 /**
1260 * An identifier to be passed in the next request to this operation to return the next set of items in the list.
1261 */
1262 nextToken?: PaginationToken;
1263 }
1264 export interface ListTagsForResourceRequest {
1265 /**
1266 * The GraphqlApi ARN.
1267 */
1268 resourceArn: ResourceArn;
1269 }
1270 export interface ListTagsForResourceResponse {
1271 /**
1272 * A TagMap object.
1273 */
1274 tags?: TagMap;
1275 }
1276 export interface ListTypesRequest {
1277 /**
1278 * The API ID.
1279 */
1280 apiId: String;
1281 /**
1282 * The type format: SDL or JSON.
1283 */
1284 format: TypeDefinitionFormat;
1285 /**
1286 * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
1287 */
1288 nextToken?: PaginationToken;
1289 /**
1290 * The maximum number of results you want the request to return.
1291 */
1292 maxResults?: MaxResults;
1293 }
1294 export interface ListTypesResponse {
1295 /**
1296 * The Type objects.
1297 */
1298 types?: TypeList;
1299 /**
1300 * An identifier to be passed in the next request to this operation to return the next set of items in the list.
1301 */
1302 nextToken?: PaginationToken;
1303 }
1304 export interface LogConfig {
1305 /**
1306 * The field logging level. Values can be NONE, ERROR, or ALL. NONE: No field-level logs are captured. ERROR: Logs the following information only for the fields that are in error: The error section in the server response. Field-level errors. The generated request/response functions that got resolved for error fields. ALL: The following information is logged for all fields in the query: Field-level tracing information. The generated request/response functions that got resolved for each field.
1307 */
1308 fieldLogLevel: FieldLogLevel;
1309 /**
1310 * The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
1311 */
1312 cloudWatchLogsRoleArn: String;
1313 /**
1314 * Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
1315 */
1316 excludeVerboseContent?: Boolean;
1317 }
1318 export type Long = number;
1319 export type MapOfStringToString = {[key: string]: String};
1320 export type MappingTemplate = string;
1321 export type MaxResults = number;
1322 export interface OpenIDConnectConfig {
1323 /**
1324 * The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
1325 */
1326 issuer: String;
1327 /**
1328 * The client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.
1329 */
1330 clientId?: String;
1331 /**
1332 * The number of milliseconds a token is valid after being issued to a user.
1333 */
1334 iatTTL?: Long;
1335 /**
1336 * The number of milliseconds a token is valid after being authenticated.
1337 */
1338 authTTL?: Long;
1339 }
1340 export type OutputType = "SDL"|"JSON"|string;
1341 export type PaginationToken = string;
1342 export interface PipelineConfig {
1343 /**
1344 * A list of Function objects.
1345 */
1346 functions?: FunctionsIds;
1347 }
1348 export interface RdsHttpEndpointConfig {
1349 /**
1350 * AWS Region for RDS HTTP endpoint.
1351 */
1352 awsRegion?: String;
1353 /**
1354 * Amazon RDS cluster identifier.
1355 */
1356 dbClusterIdentifier?: String;
1357 /**
1358 * Logical database name.
1359 */
1360 databaseName?: String;
1361 /**
1362 * Logical schema name.
1363 */
1364 schema?: String;
1365 /**
1366 * AWS secret store ARN for database credentials.
1367 */
1368 awsSecretStoreArn?: String;
1369 }
1370 export interface RelationalDatabaseDataSourceConfig {
1371 /**
1372 * Source type for the relational database. RDS_HTTP_ENDPOINT: The relational database source type is an Amazon RDS HTTP endpoint.
1373 */
1374 relationalDatabaseSourceType?: RelationalDatabaseSourceType;
1375 /**
1376 * Amazon RDS HTTP endpoint settings.
1377 */
1378 rdsHttpEndpointConfig?: RdsHttpEndpointConfig;
1379 }
1380 export type RelationalDatabaseSourceType = "RDS_HTTP_ENDPOINT"|string;
1381 export interface Resolver {
1382 /**
1383 * The resolver type name.
1384 */
1385 typeName?: ResourceName;
1386 /**
1387 * The resolver field name.
1388 */
1389 fieldName?: ResourceName;
1390 /**
1391 * The resolver data source name.
1392 */
1393 dataSourceName?: ResourceName;
1394 /**
1395 * The resolver ARN.
1396 */
1397 resolverArn?: String;
1398 /**
1399 * The request mapping template.
1400 */
1401 requestMappingTemplate?: MappingTemplate;
1402 /**
1403 * The response mapping template.
1404 */
1405 responseMappingTemplate?: MappingTemplate;
1406 /**
1407 * The resolver type. UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source. PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
1408 */
1409 kind?: ResolverKind;
1410 /**
1411 * The PipelineConfig.
1412 */
1413 pipelineConfig?: PipelineConfig;
1414 /**
1415 * The SyncConfig for a resolver attached to a versioned datasource.
1416 */
1417 syncConfig?: SyncConfig;
1418 /**
1419 * The caching configuration for the resolver.
1420 */
1421 cachingConfig?: CachingConfig;
1422 }
1423 export type ResolverKind = "UNIT"|"PIPELINE"|string;
1424 export type Resolvers = Resolver[];
1425 export type ResourceArn = string;
1426 export type ResourceName = string;
1427 export type SchemaStatus = "PROCESSING"|"ACTIVE"|"DELETING"|"FAILED"|"SUCCESS"|"NOT_APPLICABLE"|string;
1428 export interface StartSchemaCreationRequest {
1429 /**
1430 * The API ID.
1431 */
1432 apiId: String;
1433 /**
1434 * The schema definition, in GraphQL schema language format.
1435 */
1436 definition: _Blob;
1437 }
1438 export interface StartSchemaCreationResponse {
1439 /**
1440 * The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.
1441 */
1442 status?: SchemaStatus;
1443 }
1444 export type String = string;
1445 export interface SyncConfig {
1446 /**
1447 * The Conflict Resolution strategy to perform in the event of a conflict. OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions do not match the latest version at the server. AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy. LAMBDA: Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.
1448 */
1449 conflictHandler?: ConflictHandlerType;
1450 /**
1451 * The Conflict Detection strategy to use. VERSION: Detect conflicts based on object versions for this resolver. NONE: Do not detect conflicts when executing this resolver.
1452 */
1453 conflictDetection?: ConflictDetectionType;
1454 /**
1455 * The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
1456 */
1457 lambdaConflictHandlerConfig?: LambdaConflictHandlerConfig;
1458 }
1459 export type TagKey = string;
1460 export type TagKeyList = TagKey[];
1461 export type TagMap = {[key: string]: TagValue};
1462 export interface TagResourceRequest {
1463 /**
1464 * The GraphqlApi ARN.
1465 */
1466 resourceArn: ResourceArn;
1467 /**
1468 * A TagMap object.
1469 */
1470 tags: TagMap;
1471 }
1472 export interface TagResourceResponse {
1473 }
1474 export type TagValue = string;
1475 export interface Type {
1476 /**
1477 * The type name.
1478 */
1479 name?: ResourceName;
1480 /**
1481 * The type description.
1482 */
1483 description?: String;
1484 /**
1485 * The type ARN.
1486 */
1487 arn?: String;
1488 /**
1489 * The type definition.
1490 */
1491 definition?: String;
1492 /**
1493 * The type format: SDL or JSON.
1494 */
1495 format?: TypeDefinitionFormat;
1496 }
1497 export type TypeDefinitionFormat = "SDL"|"JSON"|string;
1498 export type TypeList = Type[];
1499 export interface UntagResourceRequest {
1500 /**
1501 * The GraphqlApi ARN.
1502 */
1503 resourceArn: ResourceArn;
1504 /**
1505 * A list of TagKey objects.
1506 */
1507 tagKeys: TagKeyList;
1508 }
1509 export interface UntagResourceResponse {
1510 }
1511 export interface UpdateApiCacheRequest {
1512 /**
1513 * The GraphQL API Id.
1514 */
1515 apiId: String;
1516 /**
1517 * TTL in seconds for cache entries. Valid values are between 1 and 3600 seconds.
1518 */
1519 ttl: Long;
1520 /**
1521 * Caching behavior. FULL_REQUEST_CACHING: All requests are fully cached. PER_RESOLVER_CACHING: Individual resovlers that you specify are cached.
1522 */
1523 apiCachingBehavior: ApiCachingBehavior;
1524 /**
1525 * The cache instance type. T2_SMALL: A t2.small instance type. T2_MEDIUM: A t2.medium instance type. R4_LARGE: A r4.large instance type. R4_XLARGE: A r4.xlarge instance type. R4_2XLARGE: A r4.2xlarge instance type. R4_4XLARGE: A r4.4xlarge instance type. R4_8XLARGE: A r4.8xlarge instance type.
1526 */
1527 type: ApiCacheType;
1528 }
1529 export interface UpdateApiCacheResponse {
1530 /**
1531 * The ApiCache object.
1532 */
1533 apiCache?: ApiCache;
1534 }
1535 export interface UpdateApiKeyRequest {
1536 /**
1537 * The ID for the GraphQL API.
1538 */
1539 apiId: String;
1540 /**
1541 * The API key ID.
1542 */
1543 id: String;
1544 /**
1545 * A description of the purpose of the API key.
1546 */
1547 description?: String;
1548 /**
1549 * The time from update time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .
1550 */
1551 expires?: Long;
1552 }
1553 export interface UpdateApiKeyResponse {
1554 /**
1555 * The API key.
1556 */
1557 apiKey?: ApiKey;
1558 }
1559 export interface UpdateDataSourceRequest {
1560 /**
1561 * The API ID.
1562 */
1563 apiId: String;
1564 /**
1565 * The new name for the data source.
1566 */
1567 name: ResourceName;
1568 /**
1569 * The new description for the data source.
1570 */
1571 description?: String;
1572 /**
1573 * The new data source type.
1574 */
1575 type: DataSourceType;
1576 /**
1577 * The new service role ARN for the data source.
1578 */
1579 serviceRoleArn?: String;
1580 /**
1581 * The new Amazon DynamoDB configuration.
1582 */
1583 dynamodbConfig?: DynamodbDataSourceConfig;
1584 /**
1585 * The new AWS Lambda configuration.
1586 */
1587 lambdaConfig?: LambdaDataSourceConfig;
1588 /**
1589 * The new Elasticsearch Service configuration.
1590 */
1591 elasticsearchConfig?: ElasticsearchDataSourceConfig;
1592 /**
1593 * The new HTTP endpoint configuration.
1594 */
1595 httpConfig?: HttpDataSourceConfig;
1596 /**
1597 * The new relational database configuration.
1598 */
1599 relationalDatabaseConfig?: RelationalDatabaseDataSourceConfig;
1600 }
1601 export interface UpdateDataSourceResponse {
1602 /**
1603 * The updated DataSource object.
1604 */
1605 dataSource?: DataSource;
1606 }
1607 export interface UpdateFunctionRequest {
1608 /**
1609 * The GraphQL API ID.
1610 */
1611 apiId: String;
1612 /**
1613 * The Function name.
1614 */
1615 name: ResourceName;
1616 /**
1617 * The Function description.
1618 */
1619 description?: String;
1620 /**
1621 * The function ID.
1622 */
1623 functionId: ResourceName;
1624 /**
1625 * The Function DataSource name.
1626 */
1627 dataSourceName: ResourceName;
1628 /**
1629 * The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
1630 */
1631 requestMappingTemplate: MappingTemplate;
1632 /**
1633 * The Function request mapping template.
1634 */
1635 responseMappingTemplate?: MappingTemplate;
1636 /**
1637 * The version of the request mapping template. Currently the supported value is 2018-05-29.
1638 */
1639 functionVersion: String;
1640 }
1641 export interface UpdateFunctionResponse {
1642 /**
1643 * The Function object.
1644 */
1645 functionConfiguration?: FunctionConfiguration;
1646 }
1647 export interface UpdateGraphqlApiRequest {
1648 /**
1649 * The API ID.
1650 */
1651 apiId: String;
1652 /**
1653 * The new name for the GraphqlApi object.
1654 */
1655 name: String;
1656 /**
1657 * The Amazon CloudWatch Logs configuration for the GraphqlApi object.
1658 */
1659 logConfig?: LogConfig;
1660 /**
1661 * The new authentication type for the GraphqlApi object.
1662 */
1663 authenticationType?: AuthenticationType;
1664 /**
1665 * The new Amazon Cognito user pool configuration for the GraphqlApi object.
1666 */
1667 userPoolConfig?: UserPoolConfig;
1668 /**
1669 * The OpenID Connect configuration for the GraphqlApi object.
1670 */
1671 openIDConnectConfig?: OpenIDConnectConfig;
1672 /**
1673 * A list of additional authentication providers for the GraphqlApi API.
1674 */
1675 additionalAuthenticationProviders?: AdditionalAuthenticationProviders;
1676 /**
1677 * A flag indicating whether to enable X-Ray tracing for the GraphqlApi.
1678 */
1679 xrayEnabled?: Boolean;
1680 }
1681 export interface UpdateGraphqlApiResponse {
1682 /**
1683 * The updated GraphqlApi object.
1684 */
1685 graphqlApi?: GraphqlApi;
1686 }
1687 export interface UpdateResolverRequest {
1688 /**
1689 * The API ID.
1690 */
1691 apiId: String;
1692 /**
1693 * The new type name.
1694 */
1695 typeName: ResourceName;
1696 /**
1697 * The new field name.
1698 */
1699 fieldName: ResourceName;
1700 /**
1701 * The new data source name.
1702 */
1703 dataSourceName?: ResourceName;
1704 /**
1705 * The new request mapping template.
1706 */
1707 requestMappingTemplate: MappingTemplate;
1708 /**
1709 * The new response mapping template.
1710 */
1711 responseMappingTemplate?: MappingTemplate;
1712 /**
1713 * The resolver type. UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source. PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
1714 */
1715 kind?: ResolverKind;
1716 /**
1717 * The PipelineConfig.
1718 */
1719 pipelineConfig?: PipelineConfig;
1720 /**
1721 * The SyncConfig for a resolver attached to a versioned datasource.
1722 */
1723 syncConfig?: SyncConfig;
1724 /**
1725 * The caching configuration for the resolver.
1726 */
1727 cachingConfig?: CachingConfig;
1728 }
1729 export interface UpdateResolverResponse {
1730 /**
1731 * The updated Resolver object.
1732 */
1733 resolver?: Resolver;
1734 }
1735 export interface UpdateTypeRequest {
1736 /**
1737 * The API ID.
1738 */
1739 apiId: String;
1740 /**
1741 * The new type name.
1742 */
1743 typeName: ResourceName;
1744 /**
1745 * The new definition.
1746 */
1747 definition?: String;
1748 /**
1749 * The new type format: SDL or JSON.
1750 */
1751 format: TypeDefinitionFormat;
1752 }
1753 export interface UpdateTypeResponse {
1754 /**
1755 * The updated Type object.
1756 */
1757 type?: Type;
1758 }
1759 export interface UserPoolConfig {
1760 /**
1761 * The user pool ID.
1762 */
1763 userPoolId: String;
1764 /**
1765 * The AWS Region in which the user pool was created.
1766 */
1767 awsRegion: String;
1768 /**
1769 * The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.
1770 */
1771 defaultAction: DefaultAction;
1772 /**
1773 * A regular expression for validating the incoming Amazon Cognito user pool app client ID.
1774 */
1775 appIdClientRegex?: String;
1776 }
1777 /**
1778 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1779 */
1780 export type apiVersion = "2017-07-25"|"latest"|string;
1781 export interface ClientApiVersions {
1782 /**
1783 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1784 */
1785 apiVersion?: apiVersion;
1786 }
1787 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1788 /**
1789 * Contains interfaces for use with the AppSync client.
1790 */
1791 export import Types = AppSync;
1792}
1793export = AppSync;