@aws-sdk/client-appsync
Advanced tools
AWS SDK for JavaScript Appsync Client for Node.js, Browser and React Native
@aws-sdk/client-appsync is a part of the AWS SDK for JavaScript, which allows developers to interact with AWS AppSync, a managed service that uses GraphQL to make it easy for applications to get exactly the data they need. This package provides methods to create, update, delete, and query AppSync resources such as GraphQL APIs, data sources, and resolvers.
Create GraphQL API
This code sample demonstrates how to create a new GraphQL API using the @aws-sdk/client-appsync package. It initializes the AppSync client, sets the parameters for the new API, and sends a request to create the API.
const { AppSyncClient, CreateGraphqlApiCommand } = require('@aws-sdk/client-appsync');
const client = new AppSyncClient({ region: 'us-west-2' });
const params = {
name: 'MyGraphQLAPI',
authenticationType: 'API_KEY',
};
const run = async () => {
try {
const data = await client.send(new CreateGraphqlApiCommand(params));
console.log(data);
} catch (err) {
console.error(err);
}
};
run();Update GraphQL API
This code sample shows how to update an existing GraphQL API. It uses the UpdateGraphqlApiCommand to change the name of the API.
const { AppSyncClient, UpdateGraphqlApiCommand } = require('@aws-sdk/client-appsync');
const client = new AppSyncClient({ region: 'us-west-2' });
const params = {
apiId: 'your-api-id',
name: 'UpdatedGraphQLAPI',
};
const run = async () => {
try {
const data = await client.send(new UpdateGraphqlApiCommand(params));
console.log(data);
} catch (err) {
console.error(err);
}
};
run();Delete GraphQL API
This code sample demonstrates how to delete a GraphQL API using the DeleteGraphqlApiCommand. It requires the API ID of the API to be deleted.
const { AppSyncClient, DeleteGraphqlApiCommand } = require('@aws-sdk/client-appsync');
const client = new AppSyncClient({ region: 'us-west-2' });
const params = {
apiId: 'your-api-id',
};
const run = async () => {
try {
const data = await client.send(new DeleteGraphqlApiCommand(params));
console.log(data);
} catch (err) {
console.error(err);
}
};
run();List GraphQL APIs
This code sample shows how to list all GraphQL APIs in your account using the ListGraphqlApisCommand.
const { AppSyncClient, ListGraphqlApisCommand } = require('@aws-sdk/client-appsync');
const client = new AppSyncClient({ region: 'us-west-2' });
const run = async () => {
try {
const data = await client.send(new ListGraphqlApisCommand({}));
console.log(data);
} catch (err) {
console.error(err);
}
};
run();Apollo Server is a community-driven, open-source GraphQL server that works with any GraphQL schema. It provides a robust set of features for building a GraphQL API, including schema stitching, subscriptions, and more. Unlike @aws-sdk/client-appsync, which is specific to AWS AppSync, Apollo Server can be used with any backend and is highly customizable.
GraphQL Yoga is a fully-featured GraphQL server with a focus on simplicity and ease of use. It is built on top of Express and Apollo Server, providing a simple setup and a powerful set of features. While @aws-sdk/client-appsync is tailored for AWS AppSync, GraphQL Yoga is more general-purpose and can be used with various backends.
Prisma is an open-source database toolkit that makes it easy to work with databases in a type-safe way. It provides a powerful ORM for GraphQL APIs, allowing developers to define their data models and generate a GraphQL API automatically. Prisma focuses on database interactions, whereas @aws-sdk/client-appsync is more about managing GraphQL APIs on AWS.
AWS SDK for JavaScript AppSync Client for Node.js, Browser and React Native.
AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.
To install this package, simply type add or install @aws-sdk/client-appsync using your favorite package manager:
npm install @aws-sdk/client-appsyncyarn add @aws-sdk/client-appsyncpnpm add @aws-sdk/client-appsyncThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the AppSyncClient and
the commands you need, for example ListApisCommand:
// ES5 example
const { AppSyncClient, ListApisCommand } = require("@aws-sdk/client-appsync");
// ES6+ example
import { AppSyncClient, ListApisCommand } from "@aws-sdk/client-appsync";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new AppSyncClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListApisCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-appsync";
const client = new AWS.AppSync({ region: "REGION" });
// async/await.
try {
const data = await client.listApis(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listApis(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listApis(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-appsync package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.696.0 (2024-11-19)
FAQs
AWS SDK for JavaScript Appsync Client for Node.js, Browser and React Native
We found that @aws-sdk/client-appsync demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.