(constructor)

[configuration]

Constructs a new instance of the <code>AppSyncClient</code> class

config

The resolved configuration of AppSyncClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-appsync!AppSyncClientConfig:Interface).

destroy

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.

middlewareStack

send

command

options

AppSyncClient

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

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

AssociateApiCommand

Maps an endpoint to your custom domain.

AssociateMergedGraphqlApiCommand

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

AssociateSourceGraphqlApiCommand

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

CreateApiCacheCommand

Creates a cache for the GraphQL API.

CreateApiCommand

Creates an <code>Api</code> object. Use this operation to create an AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

CreateApiKeyCommand

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

CreateChannelNamespaceCommand

Creates a <code>ChannelNamespace</code> for an <code>Api</code>.

CreateDataSourceCommand

Creates a <code>DataSource</code> object.

CreateDomainNameCommand

Creates a custom <code>DomainName</code> object.

CreateFunctionCommand

Creates a <code>Function</code> object. A function is a reusable entity. You can use multiple functions to compose the resolver logic.

CreateGraphqlApiCommand

Creates a <code>GraphqlApi</code> object.

CreateResolverCommand

Creates a <code>Resolver</code> object. A resolver converts incoming requests into a format that a data source can understand, and converts the data source's responses into GraphQL.

CreateTypeCommand

Creates a <code>Type</code> object.

DeleteApiCacheCommand

Deletes an <code>ApiCache</code> object.

DeleteApiCommand

Deletes an <code>Api</code> object

DeleteApiKeyCommand

DeleteChannelNamespaceCommand

Deletes a <code>ChannelNamespace</code>.

DeleteDataSourceCommand

Deletes a <code>DataSource</code> object.

DeleteDomainNameCommand

Deletes a custom <code>DomainName</code> object.

DeleteFunctionCommand

DeleteGraphqlApiCommand

Deletes a <code>GraphqlApi</code> object.

DeleteResolverCommand

Deletes a <code>Resolver</code> object.

DeleteTypeCommand

Deletes a <code>Type</code> object.

DisassociateApiCommand

Removes an <code>ApiAssociation</code> object from a custom domain.

DisassociateMergedGraphqlApiCommand

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

DisassociateSourceGraphqlApiCommand

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

EvaluateCodeCommand

Evaluates the given code and returns the response. The code definition requirements depend on the specified runtime. For <code>APPSYNC_JS</code> 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.

EvaluateMappingTemplateCommand

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

FlushApiCacheCommand

Flushes an <code>ApiCache</code> object.

GetApiAssociationCommand

Retrieves an <code>ApiAssociation</code> object.

GetApiCacheCommand

Retrieves an <code>ApiCache</code> object.

GetApiCommand

Retrieves an <code>Api</code> object.

GetChannelNamespaceCommand

Retrieves the channel namespace for a specified <code>Api</code>.

GetDataSourceCommand

Retrieves a <code>DataSource</code> object.

GetDataSourceIntrospectionCommand

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.

GetDomainNameCommand

Retrieves a custom <code>DomainName</code> object.

GetFunctionCommand

GetGraphqlApiCommand

Retrieves a <code>GraphqlApi</code> object.

GetGraphqlApiEnvironmentVariablesCommand

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

GetIntrospectionSchemaCommand

Retrieves the introspection schema for a GraphQL API.

GetResolverCommand

Retrieves a <code>Resolver</code> object.

GetSchemaCreationStatusCommand

Retrieves the current status of a schema creation operation.

GetSourceApiAssociationCommand

Retrieves a <code>SourceApiAssociation</code> object.

GetTypeCommand

Retrieves a <code>Type</code> object.

ListApiKeysCommand

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 <code>DeleteApiKey</code> to manually delete a key before it's automatically deleted. </note>

ListApisCommand

Lists the APIs in your AppSync account. <code>ListApis</code> returns only the high level API details. For more detailed information about an API, use <code>GetApi</code>.

ListChannelNamespacesCommand

Lists the channel namespaces for a specified <code>Api</code>. <code>ListChannelNamespaces</code> returns only high level details for the channel namespace. To retrieve code handlers, use <code>GetChannelNamespace</code>.

ListDataSourcesCommand

Lists the data sources for a given API.

ListDomainNamesCommand

Lists multiple custom domain names.

ListFunctionsCommand

ListGraphqlApisCommand

ListResolversByFunctionCommand

List the resolvers that are associated with a specific function.

ListResolversCommand

Lists the resolvers for a given API and type.

ListSourceApiAssociationsCommand

Lists the <code>SourceApiAssociationSummary</code> data.

ListTagsForResourceCommand

ListTypesByAssociationCommand

Lists <code>Type</code> objects by the source API association ID.

ListTypesCommand

PutGraphqlApiEnvironmentVariablesCommand

Creates a list of environmental variables in an API by its ID value. When creating an environmental variable, it must follow the constraints below: <ul> <li> Both JavaScript and VTL templates support environmental variables. </li> <li> Environmental variables are not evaluated before function invocation. </li> <li> Environmental variables only support string values. </li> <li> Any defined value in an environmental variable is considered a string literal and not expanded. </li> <li> Variable evaluations should ideally be performed in the function code. </li> </ul> When creating an environmental variable key-value pair, it must follow the additional constraints below: <ul> <li> Keys must begin with a letter. </li> <li> Keys must be at least two characters long. </li> <li> Keys can only contain letters, numbers, and the underscore character (_). </li> <li> Values can be up to 512 characters long. </li> <li> You can configure up to 50 key-value pairs in a GraphQL API. </li> </ul> You can create a list of environmental variables by adding it to the <code>environmentVariables</code> payload as a list in the format <code>{"key1":"value1","key2":"value2", …}</code>. Note that each call of the <code>PutGraphqlApiEnvironmentVariables</code> 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.

StartDataSourceIntrospectionCommand

Creates a new introspection. Returns the <code>introspectionId</code> of the new introspection after its creation.

StartSchemaCreationCommand

Adds a new schema to your GraphQL API. This operation is asynchronous. Use to determine when it has completed.

StartSchemaMergeCommand

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

TagResourceCommand

Tags a resource with user-supplied tags.

UntagResourceCommand

UpdateApiCacheCommand

Updates the cache for the GraphQL API.

UpdateApiCommand

UpdateApiKeyCommand

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

UpdateChannelNamespaceCommand

Updates a <code>ChannelNamespace</code> associated with an <code>Api</code>.

UpdateDataSourceCommand

Updates a <code>DataSource</code> object.

UpdateDomainNameCommand

Updates a custom <code>DomainName</code> object.

UpdateFunctionCommand

Updates a <code>Function</code> object.

UpdateGraphqlApiCommand

Updates a <code>GraphqlApi</code> object.

UpdateResolverCommand

Updates a <code>Resolver</code> object.

UpdateSourceApiAssociationCommand

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

UpdateTypeCommand

Updates a <code>Type</code> object.