Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

@aws-sdk/client-amplify

@aws-sdk/client-amplify

Description

AWS SDK for JavaScript Amplify Client for Node.js, Browser and React Native.

Amplify enables developers to develop and deploy cloud-powered mobile and web apps. The Amplify Console provides a continuous delivery and hosting service for web applications. For more information, see the Amplify Console User Guide. The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework.

Installing

To install the this package, simply type add or install @aws-sdk/client-amplify using your favorite package manager:

  • npm install @aws-sdk/client-amplify
  • yarn add @aws-sdk/client-amplify
  • pnpm add @aws-sdk/client-amplify

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the AmplifyClient and the commands you need, for example ListAppsCommand:

// ES5 example
const { AmplifyClient, ListAppsCommand } = require("@aws-sdk/client-amplify");
// ES6+ example
import { AmplifyClient, ListAppsCommand } from "@aws-sdk/client-amplify";

Usage

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.
// a client can be shared by different commands.
const client = new AmplifyClient({ region: "REGION" });

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

Async/await

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.

Promises

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

Callbacks

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

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

import * as AWS from "@aws-sdk/client-amplify";
const client = new AWS.Amplify({ region: "REGION" });

// async/await.
try {
const data = await client.listApps(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listApps(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listApps(params, (err, data) => {
// process err and data.
});

Troubleshooting

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

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.

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

CreateApp

Command API Reference / Input / Output

CreateBackendEnvironment

Command API Reference / Input / Output

CreateBranch

Command API Reference / Input / Output

CreateDeployment

Command API Reference / Input / Output

CreateDomainAssociation

Command API Reference / Input / Output

CreateWebhook

Command API Reference / Input / Output

DeleteApp

Command API Reference / Input / Output

DeleteBackendEnvironment

Command API Reference / Input / Output

DeleteBranch

Command API Reference / Input / Output

DeleteDomainAssociation

Command API Reference / Input / Output

DeleteJob

Command API Reference / Input / Output

DeleteWebhook

Command API Reference / Input / Output

GenerateAccessLogs

Command API Reference / Input / Output

GetApp

Command API Reference / Input / Output

GetArtifactUrl

Command API Reference / Input / Output

GetBackendEnvironment

Command API Reference / Input / Output

GetBranch

Command API Reference / Input / Output

GetDomainAssociation

Command API Reference / Input / Output

GetJob

Command API Reference / Input / Output

GetWebhook

Command API Reference / Input / Output

ListApps

Command API Reference / Input / Output

ListArtifacts

Command API Reference / Input / Output

ListBackendEnvironments

Command API Reference / Input / Output

ListBranches

Command API Reference / Input / Output

ListDomainAssociations

Command API Reference / Input / Output

ListJobs

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListWebhooks

Command API Reference / Input / Output

StartDeployment

Command API Reference / Input / Output

StartJob

Command API Reference / Input / Output

StopJob

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateApp

Command API Reference / Input / Output

UpdateBranch

Command API Reference / Input / Output

UpdateDomainAssociation

Command API Reference / Input / Output

UpdateWebhook

Command API Reference / Input / Output