@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-appsync
- yarn add @aws-sdk/client-appsync
- pnpm add @aws-sdk/client-appsync

Getting Started

$3

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:

``js
// ES5 example
const { AppSyncClient, ListApisCommand } = require("@aws-sdk/client-appsync");
`

`ts
// ES6+ example
import { AppSyncClient, ListApisCommand } from "@aws-sdk/client-appsync";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new AppSyncClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListApisCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// 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.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### 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

`ts
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.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
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;
* }
*/
}
`

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-js
on 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

Command API Reference / Input / Output

AssociateMergedGraphqlApi

Command API Reference / Input / Output

AssociateSourceGraphqlApi

Command API Reference / Input / Output

CreateApi

Command API Reference / Input / Output

CreateApiCache

Command API Reference / Input / Output

CreateApiKey

Command API Reference / Input / Output

CreateChannelNamespace

Command API Reference / Input / Output

CreateDataSource

Command API Reference / Input / Output

CreateDomainName

Command API Reference / Input / Output

CreateFunction

Command API Reference / Input / Output

CreateGraphqlApi

Command API Reference / Input / Output

CreateResolver

Command API Reference / Input / Output

CreateType

Command API Reference / Input / Output

DeleteApi

Command API Reference / Input / Output

DeleteApiCache

Command API Reference / Input / Output

DeleteApiKey

Command API Reference / Input / Output

DeleteChannelNamespace

Command API Reference / Input / Output

DeleteDataSource

Command API Reference / Input / Output

DeleteDomainName

Command API Reference / Input / Output

DeleteFunction

Command API Reference / Input / Output

DeleteGraphqlApi

Command API Reference / Input / Output

DeleteResolver

Command API Reference / Input / Output

DeleteType

Command API Reference / Input / Output

DisassociateApi

Command API Reference / Input / Output

DisassociateMergedGraphqlApi

Command API Reference / Input / Output

DisassociateSourceGraphqlApi

Command API Reference / Input / Output

EvaluateCode

Command API Reference / Input / Output

EvaluateMappingTemplate

Command API Reference / Input / Output

FlushApiCache

Command API Reference / Input / Output

GetApi

Command API Reference / Input / Output

GetApiAssociation

Command API Reference / Input / Output

GetApiCache

Command API Reference / Input / Output

GetChannelNamespace

Command API Reference / Input / Output

GetDataSource

Command API Reference / Input / Output

GetDataSourceIntrospection

Command API Reference / Input / Output

GetDomainName

Command API Reference / Input / Output

GetFunction

Command API Reference / Input / Output

GetGraphqlApi

Command API Reference / Input / Output

GetGraphqlApiEnvironmentVariables

Command API Reference / Input / Output

GetIntrospectionSchema

Command API Reference / Input / Output

GetResolver

Command API Reference / Input / Output

GetSchemaCreationStatus

Command API Reference / Input / Output

GetSourceApiAssociation

Command API Reference / Input / Output

GetType

Command API Reference / Input / Output

ListApiKeys

Command API Reference / Input / Output

ListApis

Command API Reference / Input / Output

ListChannelNamespaces

Command API Reference / Input / Output

ListDataSources

Command API Reference / Input / Output

ListDomainNames

Command API Reference / Input / Output

ListFunctions

Command API Reference / Input / Output

ListGraphqlApis

Command API Reference / Input / Output

ListResolvers

Command API Reference / Input / Output

ListResolversByFunction

Command API Reference / Input / Output

ListSourceApiAssociations

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListTypes

Command API Reference / Input / Output

ListTypesByAssociation

Command API Reference / Input / Output

PutGraphqlApiEnvironmentVariables

Command API Reference / Input / Output

StartDataSourceIntrospection

Command API Reference / Input / Output

StartSchemaCreation

Command API Reference / Input / Output

StartSchemaMerge

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateApi

Command API Reference / Input / Output

UpdateApiCache

Command API Reference / Input / Output

UpdateApiKey

Command API Reference / Input / Output

UpdateChannelNamespace

Command API Reference / Input / Output

UpdateDataSource

Command API Reference / Input / Output

UpdateDomainName

Command API Reference / Input / Output

UpdateFunction

Command API Reference / Input / Output

UpdateGraphqlApi

Command API Reference / Input / Output

UpdateResolver

Command API Reference / Input / Output

UpdateSourceApiAssociation

Command API Reference / Input / Output

UpdateType

Command API Reference / Input / Output