@aws-sdk/client-cognito-sync

Description

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

Amazon Cognito Sync

Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of
application-related user data. High-level client libraries are available for both iOS and
Android. You can use these libraries to persist data locally so that it's available even if
the device is offline. Developer credentials don't need to be stored on the mobile device
to access the service. You can use Amazon Cognito to obtain a normalized user ID and
credentials. User data is persisted in a dataset that can store up to 1 MB of key-value
pairs, and you can have up to 20 datasets per user identity.

With Amazon Cognito Sync, the data stored for each identity is accessible only to
credentials assigned to that identity. In order to use the Cognito Sync service, you need
to make API calls using credentials retrieved with Amazon Cognito Identity service.

If you want to use Cognito Sync in an Android or iOS application, you will probably want to
make API calls via the AWS Mobile SDK. To learn more, see the Developer Guide for Android and the Developer Guide for iOS.

Installing

To install this package, simply type add or install @aws-sdk/client-cognito-sync
using your favorite package manager:
- npm install @aws-sdk/client-cognito-sync
- yarn add @aws-sdk/client-cognito-sync
- pnpm add @aws-sdk/client-cognito-sync

Getting Started

$3

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

``js
// ES5 example
const { CognitoSyncClient, ListIdentityPoolUsageCommand } = require("@aws-sdk/client-cognito-sync");
`

`ts
// ES6+ example
import { CognitoSyncClient, ListIdentityPoolUsageCommand } from "@aws-sdk/client-cognito-sync";
`

$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 CognitoSyncClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListIdentityPoolUsageCommand(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-cognito-sync";
const client = new AWS.CognitoSync({ region: "REGION" });

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

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

// callbacks.
client.listIdentityPoolUsage(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-cognito-sync` 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)

BulkPublish

Command API Reference / Input / Output

DeleteDataset

Command API Reference / Input / Output

DescribeDataset

Command API Reference / Input / Output

DescribeIdentityPoolUsage

Command API Reference / Input / Output

DescribeIdentityUsage

Command API Reference / Input / Output

GetBulkPublishDetails

Command API Reference / Input / Output

GetCognitoEvents

Command API Reference / Input / Output

GetIdentityPoolConfiguration

Command API Reference / Input / Output

ListDatasets

Command API Reference / Input / Output

ListIdentityPoolUsage

Command API Reference / Input / Output

ListRecords

Command API Reference / Input / Output

RegisterDevice

Command API Reference / Input / Output

SetCognitoEvents

Command API Reference / Input / Output

SetIdentityPoolConfiguration

Command API Reference / Input / Output

SubscribeToDataset

Command API Reference / Input / Output

UnsubscribeFromDataset

Command API Reference / Input / Output

UpdateRecords

Command API Reference / Input / Output