This package has been deprecated

Author message:

The package @aws-sdk/client-cognito-sync-node has been renamed to @aws-sdk/client-cognito-sync. Please install the renamed package.

@aws-sdk/client-cognito-sync-node

Description

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 the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-cognito-sync-node

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(CognitoSyncClient) and the commands you need, for example BulkPublishCommand:

//JavaScript
const {
  CognitoSyncClient
} = require("@aws-sdk/client-cognito-sync-node/CognitoSyncClient");
const {
  BulkPublishCommand
} = require("@aws-sdk/client-cognito-sync-node/commands/BulkPublishCommand");

//TypeScript
import { CognitoSyncClient } from "@aws-sdk/client-cognito-sync-node/CognitoSyncClient";
import { BulkPublishCommand } from "@aws-sdk/client-cognito-sync-node/commands/BulkPublishCommand";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
• 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.

const cognitoSync = new CognitoSyncClient({region: 'region'});
//clients can be shared by different commands
const params = {
  IdentityPoolId: /**a string value*/,
};
const bulkPublishCommand = new BulkPublishCommand(params);
cognitoSync.send(bulkPublishCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await cognitoSync.send(bulkPublishCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
cognitoSync.send(bulkPublishCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-cognito-sync-node/CognitoSync";
const cognitoSync = new AWS.CognitoSync({ region: "region" });
cognitoSync.bulkPublish(params, (err, data) => {
  //do something
});

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 cognitoSync.send(bulkPublishCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.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 and have limited bandwidth to address them.

• Ask a question on StackOverflow and tag it with aws-sdk-js
• Come join the AWS JavaScript community on gitter
• If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-cognito-sync-node' package is updated. To contribute to SDK you can checkout our code generator package.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.