Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AppSync

AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly config

The resolved configuration of AppSyncClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

Methods

associateApi

createApiCache

createApiKey

createDataSource

createDomainName

createFunction

createGraphqlApi

createResolver

createType

deleteApiCache

deleteApiKey

deleteDataSource

deleteDomainName

deleteFunction

deleteGraphqlApi

deleteResolver

deleteType

destroy

  • destroy(): void
  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void

disassociateApi

evaluateCode

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

    Parameters

    Returns Promise<EvaluateCodeCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: EvaluateCodeCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<EvaluateCodeCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

evaluateMappingTemplate

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

    Parameters

    Returns Promise<EvaluateMappingTemplateCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: EvaluateMappingTemplateCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<EvaluateMappingTemplateCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

flushApiCache

getApiAssociation

getApiCache

getDataSource

getDomainName

getFunction

getGraphqlApi

getIntrospectionSchema

getResolver

getSchemaCreationStatus

getType

listApiKeys

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

    Parameters

    Returns Promise<ListApiKeysCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: ListApiKeysCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListApiKeysCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

listDataSources

listDomainNames

listFunctions

listGraphqlApis

listResolvers

listResolversByFunction

listTagsForResource

listTypes

send

startSchemaCreation

tagResource

untagResource

updateApiCache

updateApiKey

updateDataSource

updateDomainName

updateFunction

updateGraphqlApi

updateResolver

updateType