Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

AppSync

import { AppSync } from "https://aws-api.deno.dev/v0.4/services/appsync.ts?docs=full";
class AppSync {
constructor(apiFactory: client.ApiFactory);
async associateApi(params: AssociateApiRequest, opts?: client.RequestOptions): Promise<AssociateApiResponse>;
async createApiCache(params: CreateApiCacheRequest, opts?: client.RequestOptions): Promise<CreateApiCacheResponse>;
async createApiKey(params: CreateApiKeyRequest, opts?: client.RequestOptions): Promise<CreateApiKeyResponse>;
async createDataSource(params: CreateDataSourceRequest, opts?: client.RequestOptions): Promise<CreateDataSourceResponse>;
async createDomainName(params: CreateDomainNameRequest, opts?: client.RequestOptions): Promise<CreateDomainNameResponse>;
async createFunction(params: CreateFunctionRequest, opts?: client.RequestOptions): Promise<CreateFunctionResponse>;
async createGraphqlApi(params: CreateGraphqlApiRequest, opts?: client.RequestOptions): Promise<CreateGraphqlApiResponse>;
async createResolver(params: CreateResolverRequest, opts?: client.RequestOptions): Promise<CreateResolverResponse>;
async createType(params: CreateTypeRequest, opts?: client.RequestOptions): Promise<CreateTypeResponse>;
async deleteApiCache(params: DeleteApiCacheRequest, opts?: client.RequestOptions): Promise<void>;
async deleteApiKey(params: DeleteApiKeyRequest, opts?: client.RequestOptions): Promise<void>;
async deleteDataSource(params: DeleteDataSourceRequest, opts?: client.RequestOptions): Promise<void>;
async deleteDomainName(params: DeleteDomainNameRequest, opts?: client.RequestOptions): Promise<void>;
async deleteFunction(params: DeleteFunctionRequest, opts?: client.RequestOptions): Promise<void>;
async deleteGraphqlApi(params: DeleteGraphqlApiRequest, opts?: client.RequestOptions): Promise<void>;
async deleteResolver(params: DeleteResolverRequest, opts?: client.RequestOptions): Promise<void>;
async deleteType(params: DeleteTypeRequest, opts?: client.RequestOptions): Promise<void>;
async disassociateApi(params: DisassociateApiRequest, opts?: client.RequestOptions): Promise<void>;
async evaluateCode(params: EvaluateCodeRequest, opts?: client.RequestOptions): Promise<EvaluateCodeResponse>;
async evaluateMappingTemplate(params: EvaluateMappingTemplateRequest, opts?: client.RequestOptions): Promise<EvaluateMappingTemplateResponse>;
async flushApiCache(params: FlushApiCacheRequest, opts?: client.RequestOptions): Promise<void>;
async getApiAssociation(params: GetApiAssociationRequest, opts?: client.RequestOptions): Promise<GetApiAssociationResponse>;
async getApiCache(params: GetApiCacheRequest, opts?: client.RequestOptions): Promise<GetApiCacheResponse>;
async getDataSource(params: GetDataSourceRequest, opts?: client.RequestOptions): Promise<GetDataSourceResponse>;
async getDomainName(params: GetDomainNameRequest, opts?: client.RequestOptions): Promise<GetDomainNameResponse>;
async getFunction(params: GetFunctionRequest, opts?: client.RequestOptions): Promise<GetFunctionResponse>;
async getGraphqlApi(params: GetGraphqlApiRequest, opts?: client.RequestOptions): Promise<GetGraphqlApiResponse>;
async getIntrospectionSchema(params: GetIntrospectionSchemaRequest, opts?: client.RequestOptions): Promise<GetIntrospectionSchemaResponse>;
async getResolver(params: GetResolverRequest, opts?: client.RequestOptions): Promise<GetResolverResponse>;
async getSchemaCreationStatus(params: GetSchemaCreationStatusRequest, opts?: client.RequestOptions): Promise<GetSchemaCreationStatusResponse>;
async getType(params: GetTypeRequest, opts?: client.RequestOptions): Promise<GetTypeResponse>;
async listApiKeys(params: ListApiKeysRequest, opts?: client.RequestOptions): Promise<ListApiKeysResponse>;
async listDataSources(params: ListDataSourcesRequest, opts?: client.RequestOptions): Promise<ListDataSourcesResponse>;
async listDomainNames(params?: ListDomainNamesRequest, opts?: client.RequestOptions): Promise<ListDomainNamesResponse>;
async listFunctions(params: ListFunctionsRequest, opts?: client.RequestOptions): Promise<ListFunctionsResponse>;
async listGraphqlApis(params?: ListGraphqlApisRequest, opts?: client.RequestOptions): Promise<ListGraphqlApisResponse>;
async listResolvers(params: ListResolversRequest, opts?: client.RequestOptions): Promise<ListResolversResponse>;
async listResolversByFunction(params: ListResolversByFunctionRequest, opts?: client.RequestOptions): Promise<ListResolversByFunctionResponse>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async listTypes(params: ListTypesRequest, opts?: client.RequestOptions): Promise<ListTypesResponse>;
async startSchemaCreation(params: StartSchemaCreationRequest, opts?: client.RequestOptions): Promise<StartSchemaCreationResponse>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateApiCache(params: UpdateApiCacheRequest, opts?: client.RequestOptions): Promise<UpdateApiCacheResponse>;
async updateApiKey(params: UpdateApiKeyRequest, opts?: client.RequestOptions): Promise<UpdateApiKeyResponse>;
async updateDataSource(params: UpdateDataSourceRequest, opts?: client.RequestOptions): Promise<UpdateDataSourceResponse>;
async updateDomainName(params: UpdateDomainNameRequest, opts?: client.RequestOptions): Promise<UpdateDomainNameResponse>;
async updateFunction(params: UpdateFunctionRequest, opts?: client.RequestOptions): Promise<UpdateFunctionResponse>;
async updateGraphqlApi(params: UpdateGraphqlApiRequest, opts?: client.RequestOptions): Promise<UpdateGraphqlApiResponse>;
async updateResolver(params: UpdateResolverRequest, opts?: client.RequestOptions): Promise<UpdateResolverResponse>;
async updateType(params: UpdateTypeRequest, opts?: client.RequestOptions): Promise<UpdateTypeResponse>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new AppSync(apiFactory: client.ApiFactory)
[src]

§Methods

§

Maps an endpoint to your custom domain.

§

Creates a cache for the GraphQL API.

§

Creates a unique key that you can distribute to clients who invoke your API.

§

Creates a DataSource object.

§

Creates a custom DomainName object.

§

Creates a Function object.

A function is a reusable entity. You can use multiple functions to compose the resolver logic.

§

Creates a GraphqlApi object.

§

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.

§

Creates a Type object.

§
deleteApiCache(params: DeleteApiCacheRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes an ApiCache object.

§
deleteApiKey(params: DeleteApiKeyRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes an API key.

§
deleteDataSource(params: DeleteDataSourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a DataSource object.

§
deleteDomainName(params: DeleteDomainNameRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a custom DomainName object.

§
deleteFunction(params: DeleteFunctionRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a Function.

§
deleteGraphqlApi(params: DeleteGraphqlApiRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a GraphqlApi object.

§
deleteResolver(params: DeleteResolverRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a Resolver object.

§
deleteType(params: DeleteTypeRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a Type object.

§
disassociateApi(params: DisassociateApiRequest, opts?: client.RequestOptions): Promise<void>
[src]

Removes an ApiAssociation object from a custom domain.

§

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.

§

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).

§
flushApiCache(params: FlushApiCacheRequest, opts?: client.RequestOptions): Promise<void>
[src]

Flushes an ApiCache object.

§

Retrieves an ApiAssociation object.

§

Retrieves an ApiCache object.

§

Retrieves a DataSource object.

§

Retrieves a custom DomainName object.

§

Get a Function.

§

Retrieves a GraphqlApi object.

§

Retrieves the introspection schema for a GraphQL API.

§

Retrieves a Resolver object.

§

Retrieves the current status of a schema creation operation.

§
getType(params: GetTypeRequest, opts?: client.RequestOptions): Promise<GetTypeResponse>
[src]

Retrieves a Type object.

§

Lists the API keys for a given API.

Note: 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.

§

Lists the data sources for a given API.

§

Lists multiple custom domain names.

§

List multiple functions.

§

Lists your GraphQL APIs.

§

Lists the resolvers for a given API and type.

§

List the resolvers that are associated with a specific function.

§

Lists the tags for a resource.

§

Lists the types for a given API.

§

Adds a new schema to your GraphQL API.

This operation is asynchronous. Use to determine when it has completed.

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Tags a resource with user-supplied tags.

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Untags a resource.

§

Updates the cache for the GraphQL API.

§

Updates an API key. You can update the key as long as it's not deleted.

§

Updates a DataSource object.

§

Updates a custom DomainName object.

§

Updates a Function object.

§

Updates a GraphqlApi object.

§

Updates a Resolver object.

§

Updates a Type object.

§Static Properties