UNPKG

cdk-amazon-chime-resources

Version:

![Experimental](https://img.shields.io/badge/experimental-important.svg?style=for-the-badge)

1,122 lines 85.1 kB
import {Request} from '../lib/request'; import {Response} from '../lib/response'; import {AWSError} from '../lib/error'; import {Service} from '../lib/service'; import {ServiceConfigurationOptions} from '../lib/service'; import {ConfigBase as Config} from '../lib/config-base'; interface Blob {} declare class AppSync extends Service { /** * Constructs a service object. This object has one method for each API operation. */ constructor(options?: AppSync.Types.ClientConfiguration) config: Config & AppSync.Types.ClientConfiguration; /** * Maps an endpoint to your custom domain. */ associateApi(params: AppSync.Types.AssociateApiRequest, callback?: (err: AWSError, data: AppSync.Types.AssociateApiResponse) => void): Request<AppSync.Types.AssociateApiResponse, AWSError>; /** * Maps an endpoint to your custom domain. */ associateApi(callback?: (err: AWSError, data: AppSync.Types.AssociateApiResponse) => void): Request<AppSync.Types.AssociateApiResponse, AWSError>; /** * Creates a cache for the GraphQL API. */ createApiCache(params: AppSync.Types.CreateApiCacheRequest, callback?: (err: AWSError, data: AppSync.Types.CreateApiCacheResponse) => void): Request<AppSync.Types.CreateApiCacheResponse, AWSError>; /** * Creates a cache for the GraphQL API. */ createApiCache(callback?: (err: AWSError, data: AppSync.Types.CreateApiCacheResponse) => void): Request<AppSync.Types.CreateApiCacheResponse, AWSError>; /** * Creates a unique key that you can distribute to clients who invoke your API. */ createApiKey(params: AppSync.Types.CreateApiKeyRequest, callback?: (err: AWSError, data: AppSync.Types.CreateApiKeyResponse) => void): Request<AppSync.Types.CreateApiKeyResponse, AWSError>; /** * Creates a unique key that you can distribute to clients who invoke your API. */ createApiKey(callback?: (err: AWSError, data: AppSync.Types.CreateApiKeyResponse) => void): Request<AppSync.Types.CreateApiKeyResponse, AWSError>; /** * Creates a DataSource object. */ createDataSource(params: AppSync.Types.CreateDataSourceRequest, callback?: (err: AWSError, data: AppSync.Types.CreateDataSourceResponse) => void): Request<AppSync.Types.CreateDataSourceResponse, AWSError>; /** * Creates a DataSource object. */ createDataSource(callback?: (err: AWSError, data: AppSync.Types.CreateDataSourceResponse) => void): Request<AppSync.Types.CreateDataSourceResponse, AWSError>; /** * Creates a custom DomainName object. */ createDomainName(params: AppSync.Types.CreateDomainNameRequest, callback?: (err: AWSError, data: AppSync.Types.CreateDomainNameResponse) => void): Request<AppSync.Types.CreateDomainNameResponse, AWSError>; /** * Creates a custom DomainName object. */ createDomainName(callback?: (err: AWSError, data: AppSync.Types.CreateDomainNameResponse) => void): Request<AppSync.Types.CreateDomainNameResponse, AWSError>; /** * Creates a Function object. A function is a reusable entity. You can use multiple functions to compose the resolver logic. */ createFunction(params: AppSync.Types.CreateFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.CreateFunctionResponse) => void): Request<AppSync.Types.CreateFunctionResponse, AWSError>; /** * Creates a Function object. A function is a reusable entity. You can use multiple functions to compose the resolver logic. */ createFunction(callback?: (err: AWSError, data: AppSync.Types.CreateFunctionResponse) => void): Request<AppSync.Types.CreateFunctionResponse, AWSError>; /** * Creates a GraphqlApi object. */ createGraphqlApi(params: AppSync.Types.CreateGraphqlApiRequest, callback?: (err: AWSError, data: AppSync.Types.CreateGraphqlApiResponse) => void): Request<AppSync.Types.CreateGraphqlApiResponse, AWSError>; /** * Creates a GraphqlApi object. */ createGraphqlApi(callback?: (err: AWSError, data: AppSync.Types.CreateGraphqlApiResponse) => void): Request<AppSync.Types.CreateGraphqlApiResponse, AWSError>; /** * 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. */ createResolver(params: AppSync.Types.CreateResolverRequest, callback?: (err: AWSError, data: AppSync.Types.CreateResolverResponse) => void): Request<AppSync.Types.CreateResolverResponse, AWSError>; /** * 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. */ createResolver(callback?: (err: AWSError, data: AppSync.Types.CreateResolverResponse) => void): Request<AppSync.Types.CreateResolverResponse, AWSError>; /** * Creates a Type object. */ createType(params: AppSync.Types.CreateTypeRequest, callback?: (err: AWSError, data: AppSync.Types.CreateTypeResponse) => void): Request<AppSync.Types.CreateTypeResponse, AWSError>; /** * Creates a Type object. */ createType(callback?: (err: AWSError, data: AppSync.Types.CreateTypeResponse) => void): Request<AppSync.Types.CreateTypeResponse, AWSError>; /** * Deletes an ApiCache object. */ deleteApiCache(params: AppSync.Types.DeleteApiCacheRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteApiCacheResponse) => void): Request<AppSync.Types.DeleteApiCacheResponse, AWSError>; /** * Deletes an ApiCache object. */ deleteApiCache(callback?: (err: AWSError, data: AppSync.Types.DeleteApiCacheResponse) => void): Request<AppSync.Types.DeleteApiCacheResponse, AWSError>; /** * Deletes an API key. */ deleteApiKey(params: AppSync.Types.DeleteApiKeyRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteApiKeyResponse) => void): Request<AppSync.Types.DeleteApiKeyResponse, AWSError>; /** * Deletes an API key. */ deleteApiKey(callback?: (err: AWSError, data: AppSync.Types.DeleteApiKeyResponse) => void): Request<AppSync.Types.DeleteApiKeyResponse, AWSError>; /** * Deletes a DataSource object. */ deleteDataSource(params: AppSync.Types.DeleteDataSourceRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteDataSourceResponse) => void): Request<AppSync.Types.DeleteDataSourceResponse, AWSError>; /** * Deletes a DataSource object. */ deleteDataSource(callback?: (err: AWSError, data: AppSync.Types.DeleteDataSourceResponse) => void): Request<AppSync.Types.DeleteDataSourceResponse, AWSError>; /** * Deletes a custom DomainName object. */ deleteDomainName(params: AppSync.Types.DeleteDomainNameRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteDomainNameResponse) => void): Request<AppSync.Types.DeleteDomainNameResponse, AWSError>; /** * Deletes a custom DomainName object. */ deleteDomainName(callback?: (err: AWSError, data: AppSync.Types.DeleteDomainNameResponse) => void): Request<AppSync.Types.DeleteDomainNameResponse, AWSError>; /** * Deletes a Function. */ deleteFunction(params: AppSync.Types.DeleteFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteFunctionResponse) => void): Request<AppSync.Types.DeleteFunctionResponse, AWSError>; /** * Deletes a Function. */ deleteFunction(callback?: (err: AWSError, data: AppSync.Types.DeleteFunctionResponse) => void): Request<AppSync.Types.DeleteFunctionResponse, AWSError>; /** * Deletes a GraphqlApi object. */ deleteGraphqlApi(params: AppSync.Types.DeleteGraphqlApiRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteGraphqlApiResponse) => void): Request<AppSync.Types.DeleteGraphqlApiResponse, AWSError>; /** * Deletes a GraphqlApi object. */ deleteGraphqlApi(callback?: (err: AWSError, data: AppSync.Types.DeleteGraphqlApiResponse) => void): Request<AppSync.Types.DeleteGraphqlApiResponse, AWSError>; /** * Deletes a Resolver object. */ deleteResolver(params: AppSync.Types.DeleteResolverRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteResolverResponse) => void): Request<AppSync.Types.DeleteResolverResponse, AWSError>; /** * Deletes a Resolver object. */ deleteResolver(callback?: (err: AWSError, data: AppSync.Types.DeleteResolverResponse) => void): Request<AppSync.Types.DeleteResolverResponse, AWSError>; /** * Deletes a Type object. */ deleteType(params: AppSync.Types.DeleteTypeRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteTypeResponse) => void): Request<AppSync.Types.DeleteTypeResponse, AWSError>; /** * Deletes a Type object. */ deleteType(callback?: (err: AWSError, data: AppSync.Types.DeleteTypeResponse) => void): Request<AppSync.Types.DeleteTypeResponse, AWSError>; /** * Removes an ApiAssociation object from a custom domain. */ disassociateApi(params: AppSync.Types.DisassociateApiRequest, callback?: (err: AWSError, data: AppSync.Types.DisassociateApiResponse) => void): Request<AppSync.Types.DisassociateApiResponse, AWSError>; /** * Removes an ApiAssociation object from a custom domain. */ disassociateApi(callback?: (err: AWSError, data: AppSync.Types.DisassociateApiResponse) => void): Request<AppSync.Types.DisassociateApiResponse, AWSError>; /** * Evaluates the given code and returns the response. The code definition requirements depend on the specified runtime. For APPSYNC_JS runtimes, the code defines the request and response functions. The request function takes the incoming request after a GraphQL operation is parsed and converts it into a request configuration for the selected data source operation. The response function interprets responses from the data source and maps it to the shape of the GraphQL field output type. */ evaluateCode(params: AppSync.Types.EvaluateCodeRequest, callback?: (err: AWSError, data: AppSync.Types.EvaluateCodeResponse) => void): Request<AppSync.Types.EvaluateCodeResponse, AWSError>; /** * Evaluates the given code and returns the response. The code definition requirements depend on the specified runtime. For APPSYNC_JS runtimes, the code defines the request and response functions. The request function takes the incoming request after a GraphQL operation is parsed and converts it into a request configuration for the selected data source operation. The response function interprets responses from the data source and maps it to the shape of the GraphQL field output type. */ evaluateCode(callback?: (err: AWSError, data: AppSync.Types.EvaluateCodeResponse) => void): Request<AppSync.Types.EvaluateCodeResponse, AWSError>; /** * Evaluates a given template and returns the response. The mapping template can be a request or response template. Request templates take the incoming request after a GraphQL operation is parsed and convert it into a request configuration for the selected data source operation. Response templates interpret responses from the data source and map it to the shape of the GraphQL field output type. Mapping templates are written in the Apache Velocity Template Language (VTL). */ evaluateMappingTemplate(params: AppSync.Types.EvaluateMappingTemplateRequest, callback?: (err: AWSError, data: AppSync.Types.EvaluateMappingTemplateResponse) => void): Request<AppSync.Types.EvaluateMappingTemplateResponse, AWSError>; /** * Evaluates a given template and returns the response. The mapping template can be a request or response template. Request templates take the incoming request after a GraphQL operation is parsed and convert it into a request configuration for the selected data source operation. Response templates interpret responses from the data source and map it to the shape of the GraphQL field output type. Mapping templates are written in the Apache Velocity Template Language (VTL). */ evaluateMappingTemplate(callback?: (err: AWSError, data: AppSync.Types.EvaluateMappingTemplateResponse) => void): Request<AppSync.Types.EvaluateMappingTemplateResponse, AWSError>; /** * Flushes an ApiCache object. */ flushApiCache(params: AppSync.Types.FlushApiCacheRequest, callback?: (err: AWSError, data: AppSync.Types.FlushApiCacheResponse) => void): Request<AppSync.Types.FlushApiCacheResponse, AWSError>; /** * Flushes an ApiCache object. */ flushApiCache(callback?: (err: AWSError, data: AppSync.Types.FlushApiCacheResponse) => void): Request<AppSync.Types.FlushApiCacheResponse, AWSError>; /** * Retrieves an ApiAssociation object. */ getApiAssociation(params: AppSync.Types.GetApiAssociationRequest, callback?: (err: AWSError, data: AppSync.Types.GetApiAssociationResponse) => void): Request<AppSync.Types.GetApiAssociationResponse, AWSError>; /** * Retrieves an ApiAssociation object. */ getApiAssociation(callback?: (err: AWSError, data: AppSync.Types.GetApiAssociationResponse) => void): Request<AppSync.Types.GetApiAssociationResponse, AWSError>; /** * Retrieves an ApiCache object. */ getApiCache(params: AppSync.Types.GetApiCacheRequest, callback?: (err: AWSError, data: AppSync.Types.GetApiCacheResponse) => void): Request<AppSync.Types.GetApiCacheResponse, AWSError>; /** * Retrieves an ApiCache object. */ getApiCache(callback?: (err: AWSError, data: AppSync.Types.GetApiCacheResponse) => void): Request<AppSync.Types.GetApiCacheResponse, AWSError>; /** * Retrieves a DataSource object. */ getDataSource(params: AppSync.Types.GetDataSourceRequest, callback?: (err: AWSError, data: AppSync.Types.GetDataSourceResponse) => void): Request<AppSync.Types.GetDataSourceResponse, AWSError>; /** * Retrieves a DataSource object. */ getDataSource(callback?: (err: AWSError, data: AppSync.Types.GetDataSourceResponse) => void): Request<AppSync.Types.GetDataSourceResponse, AWSError>; /** * Retrieves a custom DomainName object. */ getDomainName(params: AppSync.Types.GetDomainNameRequest, callback?: (err: AWSError, data: AppSync.Types.GetDomainNameResponse) => void): Request<AppSync.Types.GetDomainNameResponse, AWSError>; /** * Retrieves a custom DomainName object. */ getDomainName(callback?: (err: AWSError, data: AppSync.Types.GetDomainNameResponse) => void): Request<AppSync.Types.GetDomainNameResponse, AWSError>; /** * Get a Function. */ getFunction(params: AppSync.Types.GetFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.GetFunctionResponse) => void): Request<AppSync.Types.GetFunctionResponse, AWSError>; /** * Get a Function. */ getFunction(callback?: (err: AWSError, data: AppSync.Types.GetFunctionResponse) => void): Request<AppSync.Types.GetFunctionResponse, AWSError>; /** * Retrieves a GraphqlApi object. */ getGraphqlApi(params: AppSync.Types.GetGraphqlApiRequest, callback?: (err: AWSError, data: AppSync.Types.GetGraphqlApiResponse) => void): Request<AppSync.Types.GetGraphqlApiResponse, AWSError>; /** * Retrieves a GraphqlApi object. */ getGraphqlApi(callback?: (err: AWSError, data: AppSync.Types.GetGraphqlApiResponse) => void): Request<AppSync.Types.GetGraphqlApiResponse, AWSError>; /** * Retrieves the introspection schema for a GraphQL API. */ getIntrospectionSchema(params: AppSync.Types.GetIntrospectionSchemaRequest, callback?: (err: AWSError, data: AppSync.Types.GetIntrospectionSchemaResponse) => void): Request<AppSync.Types.GetIntrospectionSchemaResponse, AWSError>; /** * Retrieves the introspection schema for a GraphQL API. */ getIntrospectionSchema(callback?: (err: AWSError, data: AppSync.Types.GetIntrospectionSchemaResponse) => void): Request<AppSync.Types.GetIntrospectionSchemaResponse, AWSError>; /** * Retrieves a Resolver object. */ getResolver(params: AppSync.Types.GetResolverRequest, callback?: (err: AWSError, data: AppSync.Types.GetResolverResponse) => void): Request<AppSync.Types.GetResolverResponse, AWSError>; /** * Retrieves a Resolver object. */ getResolver(callback?: (err: AWSError, data: AppSync.Types.GetResolverResponse) => void): Request<AppSync.Types.GetResolverResponse, AWSError>; /** * Retrieves the current status of a schema creation operation. */ getSchemaCreationStatus(params: AppSync.Types.GetSchemaCreationStatusRequest, callback?: (err: AWSError, data: AppSync.Types.GetSchemaCreationStatusResponse) => void): Request<AppSync.Types.GetSchemaCreationStatusResponse, AWSError>; /** * Retrieves the current status of a schema creation operation. */ getSchemaCreationStatus(callback?: (err: AWSError, data: AppSync.Types.GetSchemaCreationStatusResponse) => void): Request<AppSync.Types.GetSchemaCreationStatusResponse, AWSError>; /** * Retrieves a Type object. */ getType(params: AppSync.Types.GetTypeRequest, callback?: (err: AWSError, data: AppSync.Types.GetTypeResponse) => void): Request<AppSync.Types.GetTypeResponse, AWSError>; /** * Retrieves a Type object. */ getType(callback?: (err: AWSError, data: AppSync.Types.GetTypeResponse) => void): Request<AppSync.Types.GetTypeResponse, AWSError>; /** * Lists the API keys for a given API. API keys are deleted automatically 60 days 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. */ listApiKeys(params: AppSync.Types.ListApiKeysRequest, callback?: (err: AWSError, data: AppSync.Types.ListApiKeysResponse) => void): Request<AppSync.Types.ListApiKeysResponse, AWSError>; /** * Lists the API keys for a given API. API keys are deleted automatically 60 days 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. */ listApiKeys(callback?: (err: AWSError, data: AppSync.Types.ListApiKeysResponse) => void): Request<AppSync.Types.ListApiKeysResponse, AWSError>; /** * Lists the data sources for a given API. */ listDataSources(params: AppSync.Types.ListDataSourcesRequest, callback?: (err: AWSError, data: AppSync.Types.ListDataSourcesResponse) => void): Request<AppSync.Types.ListDataSourcesResponse, AWSError>; /** * Lists the data sources for a given API. */ listDataSources(callback?: (err: AWSError, data: AppSync.Types.ListDataSourcesResponse) => void): Request<AppSync.Types.ListDataSourcesResponse, AWSError>; /** * Lists multiple custom domain names. */ listDomainNames(params: AppSync.Types.ListDomainNamesRequest, callback?: (err: AWSError, data: AppSync.Types.ListDomainNamesResponse) => void): Request<AppSync.Types.ListDomainNamesResponse, AWSError>; /** * Lists multiple custom domain names. */ listDomainNames(callback?: (err: AWSError, data: AppSync.Types.ListDomainNamesResponse) => void): Request<AppSync.Types.ListDomainNamesResponse, AWSError>; /** * List multiple functions. */ listFunctions(params: AppSync.Types.ListFunctionsRequest, callback?: (err: AWSError, data: AppSync.Types.ListFunctionsResponse) => void): Request<AppSync.Types.ListFunctionsResponse, AWSError>; /** * List multiple functions. */ listFunctions(callback?: (err: AWSError, data: AppSync.Types.ListFunctionsResponse) => void): Request<AppSync.Types.ListFunctionsResponse, AWSError>; /** * Lists your GraphQL APIs. */ listGraphqlApis(params: AppSync.Types.ListGraphqlApisRequest, callback?: (err: AWSError, data: AppSync.Types.ListGraphqlApisResponse) => void): Request<AppSync.Types.ListGraphqlApisResponse, AWSError>; /** * Lists your GraphQL APIs. */ listGraphqlApis(callback?: (err: AWSError, data: AppSync.Types.ListGraphqlApisResponse) => void): Request<AppSync.Types.ListGraphqlApisResponse, AWSError>; /** * Lists the resolvers for a given API and type. */ listResolvers(params: AppSync.Types.ListResolversRequest, callback?: (err: AWSError, data: AppSync.Types.ListResolversResponse) => void): Request<AppSync.Types.ListResolversResponse, AWSError>; /** * Lists the resolvers for a given API and type. */ listResolvers(callback?: (err: AWSError, data: AppSync.Types.ListResolversResponse) => void): Request<AppSync.Types.ListResolversResponse, AWSError>; /** * List the resolvers that are associated with a specific function. */ listResolversByFunction(params: AppSync.Types.ListResolversByFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.ListResolversByFunctionResponse) => void): Request<AppSync.Types.ListResolversByFunctionResponse, AWSError>; /** * List the resolvers that are associated with a specific function. */ listResolversByFunction(callback?: (err: AWSError, data: AppSync.Types.ListResolversByFunctionResponse) => void): Request<AppSync.Types.ListResolversByFunctionResponse, AWSError>; /** * Lists the tags for a resource. */ listTagsForResource(params: AppSync.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: AppSync.Types.ListTagsForResourceResponse) => void): Request<AppSync.Types.ListTagsForResourceResponse, AWSError>; /** * Lists the tags for a resource. */ listTagsForResource(callback?: (err: AWSError, data: AppSync.Types.ListTagsForResourceResponse) => void): Request<AppSync.Types.ListTagsForResourceResponse, AWSError>; /** * Lists the types for a given API. */ listTypes(params: AppSync.Types.ListTypesRequest, callback?: (err: AWSError, data: AppSync.Types.ListTypesResponse) => void): Request<AppSync.Types.ListTypesResponse, AWSError>; /** * Lists the types for a given API. */ listTypes(callback?: (err: AWSError, data: AppSync.Types.ListTypesResponse) => void): Request<AppSync.Types.ListTypesResponse, AWSError>; /** * Adds a new schema to your GraphQL API. This operation is asynchronous. Use to determine when it has completed. */ startSchemaCreation(params: AppSync.Types.StartSchemaCreationRequest, callback?: (err: AWSError, data: AppSync.Types.StartSchemaCreationResponse) => void): Request<AppSync.Types.StartSchemaCreationResponse, AWSError>; /** * Adds a new schema to your GraphQL API. This operation is asynchronous. Use to determine when it has completed. */ startSchemaCreation(callback?: (err: AWSError, data: AppSync.Types.StartSchemaCreationResponse) => void): Request<AppSync.Types.StartSchemaCreationResponse, AWSError>; /** * Tags a resource with user-supplied tags. */ tagResource(params: AppSync.Types.TagResourceRequest, callback?: (err: AWSError, data: AppSync.Types.TagResourceResponse) => void): Request<AppSync.Types.TagResourceResponse, AWSError>; /** * Tags a resource with user-supplied tags. */ tagResource(callback?: (err: AWSError, data: AppSync.Types.TagResourceResponse) => void): Request<AppSync.Types.TagResourceResponse, AWSError>; /** * Untags a resource. */ untagResource(params: AppSync.Types.UntagResourceRequest, callback?: (err: AWSError, data: AppSync.Types.UntagResourceResponse) => void): Request<AppSync.Types.UntagResourceResponse, AWSError>; /** * Untags a resource. */ untagResource(callback?: (err: AWSError, data: AppSync.Types.UntagResourceResponse) => void): Request<AppSync.Types.UntagResourceResponse, AWSError>; /** * Updates the cache for the GraphQL API. */ updateApiCache(params: AppSync.Types.UpdateApiCacheRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateApiCacheResponse) => void): Request<AppSync.Types.UpdateApiCacheResponse, AWSError>; /** * Updates the cache for the GraphQL API. */ updateApiCache(callback?: (err: AWSError, data: AppSync.Types.UpdateApiCacheResponse) => void): Request<AppSync.Types.UpdateApiCacheResponse, AWSError>; /** * Updates an API key. You can update the key as long as it's not deleted. */ updateApiKey(params: AppSync.Types.UpdateApiKeyRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateApiKeyResponse) => void): Request<AppSync.Types.UpdateApiKeyResponse, AWSError>; /** * Updates an API key. You can update the key as long as it's not deleted. */ updateApiKey(callback?: (err: AWSError, data: AppSync.Types.UpdateApiKeyResponse) => void): Request<AppSync.Types.UpdateApiKeyResponse, AWSError>; /** * Updates a DataSource object. */ updateDataSource(params: AppSync.Types.UpdateDataSourceRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateDataSourceResponse) => void): Request<AppSync.Types.UpdateDataSourceResponse, AWSError>; /** * Updates a DataSource object. */ updateDataSource(callback?: (err: AWSError, data: AppSync.Types.UpdateDataSourceResponse) => void): Request<AppSync.Types.UpdateDataSourceResponse, AWSError>; /** * Updates a custom DomainName object. */ updateDomainName(params: AppSync.Types.UpdateDomainNameRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateDomainNameResponse) => void): Request<AppSync.Types.UpdateDomainNameResponse, AWSError>; /** * Updates a custom DomainName object. */ updateDomainName(callback?: (err: AWSError, data: AppSync.Types.UpdateDomainNameResponse) => void): Request<AppSync.Types.UpdateDomainNameResponse, AWSError>; /** * Updates a Function object. */ updateFunction(params: AppSync.Types.UpdateFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateFunctionResponse) => void): Request<AppSync.Types.UpdateFunctionResponse, AWSError>; /** * Updates a Function object. */ updateFunction(callback?: (err: AWSError, data: AppSync.Types.UpdateFunctionResponse) => void): Request<AppSync.Types.UpdateFunctionResponse, AWSError>; /** * Updates a GraphqlApi object. */ updateGraphqlApi(params: AppSync.Types.UpdateGraphqlApiRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateGraphqlApiResponse) => void): Request<AppSync.Types.UpdateGraphqlApiResponse, AWSError>; /** * Updates a GraphqlApi object. */ updateGraphqlApi(callback?: (err: AWSError, data: AppSync.Types.UpdateGraphqlApiResponse) => void): Request<AppSync.Types.UpdateGraphqlApiResponse, AWSError>; /** * Updates a Resolver object. */ updateResolver(params: AppSync.Types.UpdateResolverRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateResolverResponse) => void): Request<AppSync.Types.UpdateResolverResponse, AWSError>; /** * Updates a Resolver object. */ updateResolver(callback?: (err: AWSError, data: AppSync.Types.UpdateResolverResponse) => void): Request<AppSync.Types.UpdateResolverResponse, AWSError>; /** * Updates a Type object. */ updateType(params: AppSync.Types.UpdateTypeRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateTypeResponse) => void): Request<AppSync.Types.UpdateTypeResponse, AWSError>; /** * Updates a Type object. */ updateType(callback?: (err: AWSError, data: AppSync.Types.UpdateTypeResponse) => void): Request<AppSync.Types.UpdateTypeResponse, AWSError>; } declare namespace AppSync { export interface AdditionalAuthenticationProvider { /** * The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda. */ authenticationType?: AuthenticationType; /** * The OIDC configuration. */ openIDConnectConfig?: OpenIDConnectConfig; /** * The Amazon Cognito user pool configuration. */ userPoolConfig?: CognitoUserPoolConfig; /** * Configuration for Lambda function authorization. */ lambdaAuthorizerConfig?: LambdaAuthorizerConfig; } export type AdditionalAuthenticationProviders = AdditionalAuthenticationProvider[]; export interface ApiAssociation { /** * The domain name. */ domainName?: DomainName; /** * The API ID. */ apiId?: String; /** * Identifies the status of an association. PROCESSING: The API association is being created. You cannot modify association requests during processing. SUCCESS: The API association was successful. You can modify associations after success. FAILED: The API association has failed. You can modify associations after failure. */ associationStatus?: AssociationStatus; /** * Details about the last deployment status. */ deploymentDetail?: String; } export interface ApiCache { /** * TTL in seconds for cache entries. Valid values are 1–3,600 seconds. */ ttl?: Long; /** * Caching behavior. FULL_REQUEST_CACHING: All requests are fully cached. PER_RESOLVER_CACHING: Individual resolvers that you specify are cached. */ apiCachingBehavior?: ApiCachingBehavior; /** * Transit encryption flag when connecting to cache. You cannot update this setting after creation. */ transitEncryptionEnabled?: Boolean; /** * At-rest encryption flag for cache. You cannot update this setting after creation. */ atRestEncryptionEnabled?: Boolean; /** * The cache instance type. Valid values are SMALL MEDIUM LARGE XLARGE LARGE_2X LARGE_4X LARGE_8X (not available in all regions) LARGE_12X Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used. The following legacy instance types are available, but their use is discouraged: 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. */ type?: ApiCacheType; /** * 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. */ status?: ApiCacheStatus; } export type ApiCacheStatus = "AVAILABLE"|"CREATING"|"DELETING"|"MODIFYING"|"FAILED"|string; export type ApiCacheType = "T2_SMALL"|"T2_MEDIUM"|"R4_LARGE"|"R4_XLARGE"|"R4_2XLARGE"|"R4_4XLARGE"|"R4_8XLARGE"|"SMALL"|"MEDIUM"|"LARGE"|"XLARGE"|"LARGE_2X"|"LARGE_4X"|"LARGE_8X"|"LARGE_12X"|string; export type ApiCachingBehavior = "FULL_REQUEST_CACHING"|"PER_RESOLVER_CACHING"|string; export interface ApiKey { /** * The API key ID. */ id?: String; /** * A description of the purpose of the API key. */ description?: String; /** * The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. */ expires?: Long; /** * The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the nearest hour. */ deletes?: Long; } export type ApiKeys = ApiKey[]; export interface AppSyncRuntime { /** * The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS. */ name: RuntimeName; /** * The version of the runtime to use. Currently, the only allowed version is 1.0.0. */ runtimeVersion: String; } export interface AssociateApiRequest { /** * The domain name. */ domainName: DomainName; /** * The API ID. */ apiId: String; } export interface AssociateApiResponse { /** * The ApiAssociation object. */ apiAssociation?: ApiAssociation; } export type AssociationStatus = "PROCESSING"|"FAILED"|"SUCCESS"|string; export type AuthenticationType = "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|"AWS_LAMBDA"|string; export interface AuthorizationConfig { /** * The authorization type that the HTTP endpoint requires. AWS_IAM: The authorization type is Signature Version 4 (SigV4). */ authorizationType: AuthorizationType; /** * The Identity and Access Management (IAM) settings. */ awsIamConfig?: AwsIamConfig; } export type AuthorizationType = "AWS_IAM"|string; export interface AwsIamConfig { /** * The signing Amazon Web Services Region for IAM authorization. */ signingRegion?: String; /** * The signing service name for IAM authorization. */ signingServiceName?: String; } export type _Blob = Buffer|Uint8Array|Blob|string; export type Boolean = boolean; export type BooleanValue = boolean; export interface CachingConfig { /** * The TTL in seconds for a resolver that has caching activated. Valid values are 1–3,600 seconds. */ ttl: Long; /** * The caching keys for a resolver that has caching activated. Valid values are entries from the $context.arguments, $context.source, and $context.identity maps. */ cachingKeys?: CachingKeys; } export type CachingKeys = String[]; export type CertificateArn = string; export type Code = string; export interface CodeError { /** * The type of code error. Examples include, but aren't limited to: LINT_ERROR, PARSER_ERROR. */ errorType?: String; /** * A user presentable error. Examples include, but aren't limited to: Parsing error: Unterminated string literal. */ value?: String; /** * The line, column, and span location of the error in the code. */ location?: CodeErrorLocation; } export type CodeErrorColumn = number; export type CodeErrorLine = number; export interface CodeErrorLocation { /** * The line number in the code. Defaults to 0 if unknown. */ line?: CodeErrorLine; /** * The column number in the code. Defaults to 0 if unknown. */ column?: CodeErrorColumn; /** * The span/length of the error. Defaults to -1 if unknown. */ span?: CodeErrorSpan; } export type CodeErrorSpan = number; export type CodeErrors = CodeError[]; export interface CognitoUserPoolConfig { /** * The user pool ID. */ userPoolId: String; /** * The Amazon Web Services Region in which the user pool was created. */ awsRegion: String; /** * A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied. */ appIdClientRegex?: String; } export type ConflictDetectionType = "VERSION"|"NONE"|string; export type ConflictHandlerType = "OPTIMISTIC_CONCURRENCY"|"LAMBDA"|"AUTOMERGE"|"NONE"|string; export type Context = string; export interface CreateApiCacheRequest { /** * The GraphQL API ID. */ apiId: String; /** * TTL in seconds for cache entries. Valid values are 1–3,600 seconds. */ ttl: Long; /** * Transit encryption flag when connecting to cache. You cannot update this setting after creation. */ transitEncryptionEnabled?: Boolean; /** * At-rest encryption flag for cache. You cannot update this setting after creation. */ atRestEncryptionEnabled?: Boolean; /** * Caching behavior. FULL_REQUEST_CACHING: All requests are fully cached. PER_RESOLVER_CACHING: Individual resolvers that you specify are cached. */ apiCachingBehavior: ApiCachingBehavior; /** * The cache instance type. Valid values are SMALL MEDIUM LARGE XLARGE LARGE_2X LARGE_4X LARGE_8X (not available in all regions) LARGE_12X Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used. The following legacy instance types are available, but their use is discouraged: 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. */ type: ApiCacheType; } export interface CreateApiCacheResponse { /** * The ApiCache object. */ apiCache?: ApiCache; } export interface CreateApiKeyRequest { /** * The ID for your GraphQL API. */ apiId: String; /** * A description of the purpose of the API key. */ description?: String; /** * From the creation time, the 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 . */ expires?: Long; } export interface CreateApiKeyResponse { /** * The API key. */ apiKey?: ApiKey; } export interface CreateDataSourceRequest { /** * The API ID for the GraphQL API for the DataSource. */ apiId: String; /** * A user-supplied name for the DataSource. */ name: ResourceName; /** * A description of the DataSource. */ description?: String; /** * The type of the DataSource. */ type: DataSourceType; /** * The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. The system assumes this role when accessing the data source. */ serviceRoleArn?: String; /** * Amazon DynamoDB settings. */ dynamodbConfig?: DynamodbDataSourceConfig; /** * Lambda settings. */ lambdaConfig?: LambdaDataSourceConfig; /** * Amazon OpenSearch Service settings. As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to create an OpenSearch data source. */ elasticsearchConfig?: ElasticsearchDataSourceConfig; /** * Amazon OpenSearch Service settings. */ openSearchServiceConfig?: OpenSearchServiceDataSourceConfig; /** * HTTP endpoint settings. */ httpConfig?: HttpDataSourceConfig; /** * Relational database settings. */ relationalDatabaseConfig?: RelationalDatabaseDataSourceConfig; /** * Amazon EventBridge settings. */ eventBridgeConfig?: EventBridgeDataSourceConfig; } export interface CreateDataSourceResponse { /** * The DataSource object. */ dataSource?: DataSource; } export interface CreateDomainNameRequest { /** * The domain name. */ domainName: DomainName; /** * 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. */ certificateArn: CertificateArn; /** * A description of the DomainName. */ description?: Description; } export interface CreateDomainNameResponse { /** * The configuration for the DomainName. */ domainNameConfig?: DomainNameConfig; } export interface CreateFunctionRequest { /** * The GraphQL API ID. */ apiId: String; /** * The Function name. The function name does not have to be unique. */ name: ResourceName; /** * The Function description. */ description?: String; /** * The Function DataSource name. */ dataSourceName: ResourceName; /** * The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template. */ requestMappingTemplate?: MappingTemplate; /** * The Function response mapping template. */ responseMappingTemplate?: MappingTemplate; /** * The version of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, the functionVersion is required. */ functionVersion?: String; syncConfig?: SyncConfig; /** * The maximum batching size for a resolver. */ maxBatchSize?: MaxBatchSize; runtime?: AppSyncRuntime; /** * The function code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS. */ code?: Code; } export interface CreateFunctionResponse { /** * The Function object. */ functionConfiguration?: FunctionConfiguration; } export interface CreateGraphqlApiRequest { /** * A user-supplied name for the GraphqlApi. */ name: String; /** * The Amazon CloudWatch Logs configuration. */ logConfig?: LogConfig; /** * The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda. */ authenticationType: AuthenticationType; /** * The Amazon Cognito user pool configuration. */ userPoolConfig?: UserPoolConfig; /** * The OIDC configuration. */ openIDConnectConfig?: OpenIDConnectConfig; /** * A TagMap object. */ tags?: TagMap; /** * A list of additional authentication providers for the GraphqlApi API. */ additionalAuthenticationProviders?: AdditionalAuthenticationProviders; /** * A flag indicating whether to use X-Ray tracing for the GraphqlApi. */ xrayEnabled?: Boolean; /** * Configuration for Lambda function authorization. */ lambdaAuthorizerConfig?: LambdaAuthorizerConfig; } export interface CreateGraphqlApiResponse { /** * The GraphqlApi. */ graphqlApi?: GraphqlApi; } export interface CreateResolverRequest { /** * The ID for the GraphQL API for which the resolver is being created. */ apiId: String; /** * The name of the Type. */ typeName: ResourceName; /** * The name of the field to attach the resolver to. */ fieldName: ResourceName; /** * The name of the data source for which the resolver is being created. */ dataSourceName?: ResourceName; /** * The mapping template to use 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). VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required. */ requestMappingTemplate?: MappingTemplate; /** * The mapping template to use for responses from the data source. */ responseMappingTemplate?: MappingTemplate; /** * The resolver type. UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source. PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources. */ kind?: ResolverKind; /** * The PipelineConfig. */ pipelineConfig?: PipelineConfig; /** * The SyncConfig for a resolver attached to a versioned data source. */ syncConfig?: SyncConfig; /** * The caching configuration for the resolver. */ cachingConfig?: CachingConfig; /** * The maximum batching size for a resolver. */ maxBatchSize?: MaxBatchSize; runtime?: AppSyncRuntime; /** * The resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS. */ code?: Code; } export interface CreateResolverResponse { /** * The Resolver object. */ resolver?: Resolver; } export interface CreateTypeRequest { /** * The API ID. */ apiId: String; /** * The type definition, in GraphQL Schema Definition Language (SDL) format. For more information, see the GraphQL SDL documentation. */ definition: String; /** * The type format: SDL or JSON. */ format: TypeDefinitionFormat; } export interface CreateTypeResponse { /** * The Type object. */ type?: Type; } export interface DataSource { /** * The data source Amazon Resource Name (ARN). */ dataSourceArn?: String; /** * The name of the data source. */ name?: ResourceName; /** * The description of the data source. */ description?: String; /** * The type of the data source. AWS_LAMBDA: The data source is an Lambda function. AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table. AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain. AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain. AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge configuration. NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation. HTTP: The data source is an HTTP endpoint. RELATIONAL_DATABASE: The data source is a relational database. */ type?: DataSourceType; /** * The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. The system assumes this role when accessing the data source. */ serviceRoleArn?: String; /** * DynamoDB settings. */ dynamodbConfig?: DynamodbDataSourceConfig; /** * Lambda settings. */ lambdaConfig?: LambdaDataSourceConfig; /** * Amazon OpenSearch Service settings. */ elasticsearchConfig?: ElasticsearchDataSourceConfig; /** * Amazon OpenSearch Service settings. */ openSearchServiceConfig?: OpenSearchServiceDataSourceConfig; /** * HTTP endpoint settings. */ httpConfig?: HttpDataSourceConfig; /** * Relational database settings. */ relationalDatabaseConfig?: RelationalDatabaseDataSourceConfig; /** * Amazon EventBridge settings. */ eventBridgeConfig?: EventBridgeDataSourceConfig; } export type DataSourceType = "AWS_LAMBDA"|"AMAZON_DYNAMODB"|"AMAZON_ELASTICSEARCH"|"NONE"|"HTTP"|"RELATIONAL_DATABASE"|"AMAZON_OPENSEARCH_SERVICE"|"AMAZON_EVENTBRIDGE"|string; export type DataSources = DataSource[]; export type DefaultAction = "ALLOW"|"DENY"|string; export interface DeleteApiCacheRequest { /** * The API ID. */ apiId: String; } export interface DeleteApiCacheResponse { } export interface DeleteApiKeyRequest { /** * The API ID. */ apiId: String; /** * The ID for the API key. */ id: String; } export interface DeleteApiKeyResponse { } export interface DeleteDataSourceRequest { /** * The API ID. */ apiId: String; /** * The name of the data source. */ name: ResourceName; } export interface DeleteDataSourceResponse { } export interface DeleteDomainNameRequest { /** * The domain name. */ domainName: DomainName; } export interface DeleteDomainNameResponse { } export interface DeleteFunctionRequest { /** * The GraphQL API ID. */ apiId: String; /** * The Function ID. */ functionId: ResourceName; } export interface DeleteFunctionResponse { } export interface DeleteGraphqlApiRequest { /** * The API ID. */ apiId: String; } export interface DeleteGraphqlApiResponse { } export interface DeleteResolverRequest { /** * The API ID. */ apiId: String; /** * The name of the resolver type. */ typeName: ResourceName; /** * The resolver field name. */ fieldName: ResourceName; } export interface DeleteResolverResponse { } export interface DeleteTypeRequest { /** * The API ID. */ apiId: String; /** * The type name. */ typeName: ResourceName; } export interface DeleteTypeResponse { } export interface DeltaSyncConfig { /** * The number of minutes that an Item is stored in the data source. */ baseTableTTL?: Long; /** * The Delta Sync table name. */ deltaSyncTableName?: String; /** * The number of minutes that a Delta Sync log entry is stored in the Delta Sync table. */ deltaSyncTableTTL?: Long; } export type Description = string; export interface DisassociateApiRequest { /** * The domain name. */ domainName: DomainName; } export interface DisassociateApiResponse { } export type DomainName = string; export interface DomainNameConfig { /** * The domain name. */ domainName?: DomainName; /** * A description of the DomainName configuration. */ description?: Description; /** * 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. */ certificateArn?: CertificateArn; /** * The domain name that AppSync provides. */ appsyncDomainName?: String; /** * The ID of your Amazon Route 53 hosted zone. */ hostedZoneId?: String; } export type DomainNameConfigs = DomainNameConfig[]; export interface DynamodbDataSourceConfig { /** * The table name. */ tableName: String; /** * The Amazon Web Services Region. */ awsRegion: String; /** * Set to TRUE to use Amazon Cognito credentials with this data source. */ useCallerCredentials?: Boolean; /** * The DeltaSyncConfig for a versioned data source. */ deltaSyncConfig?: Delt