Gathering detailed insights and metrics for @aws-sdk/client-appsync
Gathering detailed insights and metrics for @aws-sdk/client-appsync
Modularized AWS SDK for JavaScript.
Installations
npm install @aws-sdk/client-appsyncDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS, UMD
Min. Node Version
>=18.0.0
Node Version
18.20.6
NPM Version
10.9.2
Releases
995
Languages
11
TypeScript
Java
JavaScript
Gherkin
Starlark
Objective-C
Ruby
Shell
Handlebars
Smithy
Makefile
TypeScript (99.65%)
Java (0.23%)
JavaScript (0.1%)
Gherkin (0.02%)
Developer
aws
Download Statistics
Total Downloads
12,692,995
Last Day
33,879
Last Week
204,795
Last Month
858,595
Last Year
8,151,365
GitHub Statistics
Apache-2.0 License
3,296 Stars
9,204 Commits
614 Forks
43 Watchers
25 Branches
164 Contributors
Updated on May 09, 2025
Maintainers
2
Package Meta Information
Latest Version
3.803.0
Package Id
@aws-sdk/client-appsync@3.803.0
Unpacked Size
1.36 MB
Size
137.36 kB
File Count
332
NPM Version
10.9.2
Node Version
18.20.6
Published on
May 05, 2025
Total Downloads
Cumulative downloads
Total Downloads
12,692,995
Dependencies
40
@aws-crypto/sha256-browser@aws-crypto/sha256-js@aws-sdk/core@aws-sdk/credential-provider-node@aws-sdk/middleware-host-header@aws-sdk/middleware-logger@aws-sdk/middleware-recursion-detection@aws-sdk/middleware-user-agent@aws-sdk/region-config-resolver@aws-sdk/types@aws-sdk/util-endpoints@aws-sdk/util-user-agent-browser@aws-sdk/util-user-agent-node@smithy/config-resolver@smithy/core@smithy/fetch-http-handler@smithy/hash-node@smithy/invalid-dependency@smithy/middleware-content-length@smithy/middleware-endpoint@smithy/middleware-retry@smithy/middleware-serde@smithy/middleware-stack@smithy/node-config-provider@smithy/node-http-handler@smithy/protocol-http@smithy/smithy-client@smithy/types@smithy/url-parser@smithy/util-base64@smithy/util-body-length-browser@smithy/util-body-length-node@smithy/util-defaults-mode-browser@smithy/util-defaults-mode-node@smithy/util-endpoints@smithy/util-middleware@smithy/util-retry@smithy/util-stream@smithy/util-utf8tslib
Dev Dependencies
6
@aws-sdk/client-appsync
Description
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.
Installing
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-appsync
Getting Started
Import
The 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:
1// ES5 example 2const { AppSyncClient, ListApisCommand } = require("@aws-sdk/client-appsync");
1// ES6+ example 2import { AppSyncClient, ListApisCommand } from "@aws-sdk/client-appsync";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call
sendoperation on client with command object as input. - If you are using a custom http handler, you may call
destroy()to close open connections.
1// a client can be shared by different commands. 2const client = new AppSyncClient({ region: "REGION" }); 3 4const params = { 5 /** input parameters */ 6}; 7const command = new ListApisCommand(params);
Async/await
We recommend using await operator to wait for the promise returned by send operation as follows:
1// async/await. 2try { 3 const data = await client.send(command); 4 // process data. 5} catch (error) { 6 // error handling. 7} finally { 8 // finally. 9}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
Promises
You can also use Promise chaining to execute send operation.
1client.send(command).then( 2 (data) => { 3 // process data. 4 }, 5 (error) => { 6 // error handling. 7 } 8);
Promises can also be called using .catch() and .finally() as follows:
1client 2 .send(command) 3 .then((data) => { 4 // process data. 5 }) 6 .catch((error) => { 7 // error handling. 8 }) 9 .finally(() => { 10 // finally. 11 });
Callbacks
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
1// callbacks. 2client.send(command, (err, data) => { 3 // process err and data. 4});
v2 compatible style
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
1import * as AWS from "@aws-sdk/client-appsync"; 2const client = new AWS.AppSync({ region: "REGION" }); 3 4// async/await. 5try { 6 const data = await client.listApis(params); 7 // process data. 8} catch (error) { 9 // error handling. 10} 11 12// Promises. 13client 14 .listApis(params) 15 .then((data) => { 16 // process data. 17 }) 18 .catch((error) => { 19 // error handling. 20 }); 21 22// callbacks. 23client.listApis(params, (err, data) => { 24 // process err and data. 25});
Troubleshooting
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
1try { 2 const data = await client.send(command); 3 // process data. 4} catch (error) { 5 const { requestId, cfId, extendedRequestId } = error.$metadata; 6 console.log({ requestId, cfId, extendedRequestId }); 7 /** 8 * The keys within exceptions are also parsed. 9 * You can access them by specifying exception names: 10 * if (error.name === 'SomeServiceException') { 11 * const value = error.specialKeyInException; 12 * } 13 */ 14}
Getting Help
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.
- Visit Developer Guide or API Reference.
- Check out the blog posts tagged with
aws-sdk-json AWS Developer Blog. - Ask a question on StackOverflow and tag it with
aws-sdk-js. - Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.
To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
Contributing
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.
License
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
Client Commands (Operations List)
AssociateApi
AssociateMergedGraphqlApi
AssociateSourceGraphqlApi
CreateApi
CreateApiCache
CreateApiKey
CreateChannelNamespace
CreateDataSource
CreateDomainName
CreateFunction
CreateGraphqlApi
CreateResolver
CreateType
DeleteApi
DeleteApiCache
DeleteApiKey
DeleteChannelNamespace
DeleteDataSource
DeleteDomainName
DeleteFunction
DeleteGraphqlApi
DeleteResolver
DeleteType
DisassociateApi
DisassociateMergedGraphqlApi
DisassociateSourceGraphqlApi
EvaluateCode
EvaluateMappingTemplate
FlushApiCache
GetApi
GetApiAssociation
GetApiCache
GetChannelNamespace
GetDataSource
GetDataSourceIntrospection
GetDomainName
GetFunction
GetGraphqlApi
GetGraphqlApiEnvironmentVariables
GetIntrospectionSchema
GetResolver
GetSchemaCreationStatus
GetSourceApiAssociation
GetType
ListApiKeys
ListApis
ListChannelNamespaces
ListDataSources
ListDomainNames
ListFunctions
ListGraphqlApis
ListResolvers
ListResolversByFunction
ListSourceApiAssociations
ListTagsForResource
ListTypes
ListTypesByAssociation
PutGraphqlApiEnvironmentVariables
StartDataSourceIntrospection
StartSchemaCreation
StartSchemaMerge
TagResource
UntagResource
UpdateApi
UpdateApiCache
UpdateApiKey
UpdateChannelNamespace
UpdateDataSource
UpdateDomainName
UpdateFunction
UpdateGraphqlApi
UpdateResolver
UpdateSourceApiAssociation
UpdateType
No vulnerabilities found.
Reason
30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0
Reason
no dangerous workflow patterns detected
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/aws/.github/SECURITY.md:1
- Info: Found linked content: github.com/aws/.github/SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/aws/.github/SECURITY.md:1
- Info: Found text in security policy: github.com/aws/.github/SECURITY.md:1
Reason
binaries present in source code
Details
- Warn: binary detected: codegen/gradle/wrapper/gradle-wrapper.jar:1
- Warn: binary detected: tests/react-native/End2End/android/gradle/wrapper/gradle-wrapper.jar:1
Reason
Found 7/30 approved changesets -- score normalized to 2
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact v3.804.0 not signed: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/216848896
- Warn: release artifact v3.803.0 not signed: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/216585859
- Warn: release artifact v3.802.0 not signed: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/216229549
- Warn: release artifact v3.801.0 not signed: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/216038593
- Warn: release artifact v3.800.0 not signed: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/215847928
- Warn: release artifact v3.804.0 does not have provenance: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/216848896
- Warn: release artifact v3.803.0 does not have provenance: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/216585859
- Warn: release artifact v3.802.0 does not have provenance: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/216229549
- Warn: release artifact v3.801.0 does not have provenance: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/216038593
- Warn: release artifact v3.800.0 does not have provenance: https://api.github.com/repos/aws/aws-sdk-js-v3/releases/215847928
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/stale_issues.yml:12
- Warn: no topLevel permission defined: .github/workflows/closed-issue-message.yml:1
- Warn: no topLevel permission defined: .github/workflows/codegen-ci.yml:1
- Warn: no topLevel permission defined: .github/workflows/commit-message-lint.yml:1
- Warn: no topLevel permission defined: .github/workflows/git-sync.yml:1
- Warn: no topLevel permission defined: .github/workflows/handle-stale-discussions.yml:1
- Warn: no topLevel permission defined: .github/workflows/issue-regression-labeler.yml:1
- Warn: no topLevel permission defined: .github/workflows/lock.yml:1
- Warn: no topLevel permission defined: .github/workflows/pre-commit-hooks.yml:1
- Warn: no topLevel permission defined: .github/workflows/stale_issues.yml:1
- Info: no jobLevel write permissions found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 7 are checked with a SAST tool
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/closed-issue-message.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/closed-issue-message.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codegen-ci.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/codegen-ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codegen-ci.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/codegen-ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/commit-message-lint.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/commit-message-lint.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/commit-message-lint.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/commit-message-lint.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/git-sync.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/git-sync.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/handle-stale-discussions.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/handle-stale-discussions.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/issue-regression-labeler.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/issue-regression-labeler.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/lock.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/lock.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pre-commit-hooks.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/pre-commit-hooks.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pre-commit-hooks.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/pre-commit-hooks.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/stale_issues.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/aws/aws-sdk-js-v3/stale_issues.yml/main?enable=pin
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 6 third-party GitHubAction dependencies pinned
Reason
26 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5
- Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
- Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99
- Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-4r4m-qw57-chr8
- Warn: Project is vulnerable to: GHSA-xcj6-pq6g-qj4x
- Warn: Project is vulnerable to: GHSA-356w-63v5-8wf4
- Warn: Project is vulnerable to: GHSA-859w-5945-r5v3
- Warn: Project is vulnerable to: GHSA-vg6x-rcgg-rjx6
- Warn: Project is vulnerable to: GHSA-x574-m823-4x7w
- Warn: Project is vulnerable to: GHSA-9crc-q9x8-hgqq
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Score
4.1
/10
Last Scanned on 2025-05-05
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More