AWS.AppSync — AWS SDK for JavaScript (original) (raw)

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

associateApi(params = {}, callback) ⇒ AWS.Request

Maps an endpoint to your custom domain.

associateMergedGraphqlApi(params = {}, callback) ⇒ AWS.Request

Creates an association between a Merged API and source API using the source API's identifier.

associateSourceGraphqlApi(params = {}, callback) ⇒ AWS.Request

Creates an association between a Merged API and source API using the Merged API's identifier.

createApiCache(params = {}, callback) ⇒ AWS.Request

Creates a cache for the GraphQL API.

createApiKey(params = {}, callback) ⇒ AWS.Request

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

createDataSource(params = {}, callback) ⇒ AWS.Request

Creates a DataSource object.

createDomainName(params = {}, callback) ⇒ AWS.Request

Creates a custom DomainName object.

createFunction(params = {}, callback) ⇒ AWS.Request

Creates a Function object.

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

createGraphqlApi(params = {}, callback) ⇒ AWS.Request

Creates a GraphqlApi object.

createResolver(params = {}, callback) ⇒ AWS.Request

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.

deleteApiCache(params = {}, callback) ⇒ AWS.Request

Deletes an ApiCache object.

deleteDataSource(params = {}, callback) ⇒ AWS.Request

Deletes a DataSource object.

deleteDomainName(params = {}, callback) ⇒ AWS.Request

Deletes a custom DomainName object.

deleteFunction(params = {}, callback) ⇒ AWS.Request

deleteGraphqlApi(params = {}, callback) ⇒ AWS.Request

Deletes a GraphqlApi object.

deleteResolver(params = {}, callback) ⇒ AWS.Request

Deletes a Resolver object.

disassociateApi(params = {}, callback) ⇒ AWS.Request

Removes an ApiAssociation object from a custom domain.

disassociateMergedGraphqlApi(params = {}, callback) ⇒ AWS.Request

Deletes an association between a Merged API and source API using the source API's identifier and the association ID.

disassociateSourceGraphqlApi(params = {}, callback) ⇒ AWS.Request

Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.

evaluateCode(params = {}, callback) ⇒ AWS.Request

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.

evaluateMappingTemplate(params = {}, callback) ⇒ AWS.Request

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 = {}, callback) ⇒ AWS.Request

Flushes an ApiCache object.

getApiAssociation(params = {}, callback) ⇒ AWS.Request

Retrieves an ApiAssociation object.

getApiCache(params = {}, callback) ⇒ AWS.Request

Retrieves an ApiCache object.

getDataSource(params = {}, callback) ⇒ AWS.Request

Retrieves a DataSource object.

getDataSourceIntrospection(params = {}, callback) ⇒ AWS.Request

Retrieves the record of an existing introspection. If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval fails the operation, an error message will be returned instead.

getDomainName(params = {}, callback) ⇒ AWS.Request

Retrieves a custom DomainName object.

getGraphqlApi(params = {}, callback) ⇒ AWS.Request

Retrieves a GraphqlApi object.

getGraphqlApiEnvironmentVariables(params = {}, callback) ⇒ AWS.Request

Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.

getIntrospectionSchema(params = {}, callback) ⇒ AWS.Request

Retrieves the introspection schema for a GraphQL API.

getResolver(params = {}, callback) ⇒ AWS.Request

Retrieves a Resolver object.

getSchemaCreationStatus(params = {}, callback) ⇒ AWS.Request

Retrieves the current status of a schema creation operation.

getSourceApiAssociation(params = {}, callback) ⇒ AWS.Request

Retrieves a SourceApiAssociation object.

listApiKeys(params = {}, callback) ⇒ AWS.Request

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.

listDataSources(params = {}, callback) ⇒ AWS.Request

Lists the data sources for a given API.

listDomainNames(params = {}, callback) ⇒ AWS.Request

Lists multiple custom domain names.

listFunctions(params = {}, callback) ⇒ AWS.Request

listGraphqlApis(params = {}, callback) ⇒ AWS.Request

listResolvers(params = {}, callback) ⇒ AWS.Request

Lists the resolvers for a given API and type.

listResolversByFunction(params = {}, callback) ⇒ AWS.Request

List the resolvers that are associated with a specific function.

listSourceApiAssociations(params = {}, callback) ⇒ AWS.Request

Lists the SourceApiAssociationSummary data.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags for a resource.

listTypes(params = {}, callback) ⇒ AWS.Request

Lists the types for a given API.

listTypesByAssociation(params = {}, callback) ⇒ AWS.Request

Lists Type objects by the source API association ID.

putGraphqlApiEnvironmentVariables(params = {}, callback) ⇒ AWS.Request

Creates a list of environmental variables in an API by its ID value.

When creating an environmental variable, it must follow the constraints below:

• Both JavaScript and VTL templates support environmental variables.
• Environmental variables are not evaluated before function invocation.
• Environmental variables only support string values.
• Any defined value in an environmental variable is considered a string literal and not expanded.
• Variable evaluations should ideally be performed in the function code.

When creating an environmental variable key-value pair, it must follow the additional constraints below:

• Keys must begin with a letter.
• Keys must be at least two characters long.
• Keys can only contain letters, numbers, and the underscore character (_).
• Values can be up to 512 characters long.
• You can configure up to 50 key-value pairs in a GraphQL API.

You can create a list of environmental variables by adding it to the environmentVariables payload as a list in the format {"key1":"value1","key2":"value2", …}. Note that each call of the PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing environmental variable list of that API. This means the existing environmental variables will be lost. To avoid this, you must include all existing and new environmental variables in the list each time you call this action.

startDataSourceIntrospection(params = {}, callback) ⇒ AWS.Request

Creates a new introspection. Returns the introspectionId of the new introspection after its creation.

startSchemaCreation(params = {}, callback) ⇒ AWS.Request

Adds a new schema to your GraphQL API.

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

startSchemaMerge(params = {}, callback) ⇒ AWS.Request

Initiates a merge operation. Returns a status that shows the result of the merge operation.

tagResource(params = {}, callback) ⇒ AWS.Request

Tags a resource with user-supplied tags.

untagResource(params = {}, callback) ⇒ AWS.Request

updateApiCache(params = {}, callback) ⇒ AWS.Request

Updates the cache for the GraphQL API.

updateApiKey(params = {}, callback) ⇒ AWS.Request

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

updateDataSource(params = {}, callback) ⇒ AWS.Request

Updates a DataSource object.

updateDomainName(params = {}, callback) ⇒ AWS.Request

Updates a custom DomainName object.

updateFunction(params = {}, callback) ⇒ AWS.Request

Updates a Function object.

updateGraphqlApi(params = {}, callback) ⇒ AWS.Request

Updates a GraphqlApi object.

updateResolver(params = {}, callback) ⇒ AWS.Request

Updates a Resolver object.

updateSourceApiAssociation(params = {}, callback) ⇒ AWS.Request

Updates some of the configuration choices of a particular source API association.