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.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-cognito-sync-browser\n```\n\n## Getting Started\n\n### Import\n\nThe 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`:\n\n```javascript\n//JavaScript\nconst {\n CognitoSyncClient\n} = require(\"@aws-sdk/client-cognito-sync-browser/CognitoSyncClient\");\nconst {\n BulkPublishCommand\n} = require(\"@aws-sdk/client-cognito-sync-browser/commands/BulkPublishCommand\");\n```\n\n```javascript\n//TypeScript\nimport { CognitoSyncClient } from \"@aws-sdk/client-cognito-sync-browser/CognitoSyncClient\";\nimport { BulkPublishCommand } from \"@aws-sdk/client-cognito-sync-browser/commands/BulkPublishCommand\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst cognitoSync = new CognitoSyncClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n IdentityPoolId: /**a string value*/,\n};\nconst bulkPublishCommand = new BulkPublishCommand(params);\ncognitoSync.send(bulkPublishCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await cognitoSync.send(bulkPublishCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ncognitoSync.send(bulkPublishCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/@aws-sdk/client-cognito-sync-browser/CognitoSync\";\nconst cognitoSync = new AWS.CognitoSync({ region: \"region\" });\ncognitoSync.bulkPublish(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await cognitoSync.send(bulkPublishCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease 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.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-cognito-sync-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-cognito-sync-browser has been renamed to @aws-sdk/client-cognito-sync. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Cognito Sync","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.5","@aws-sdk/json-parser":"^0.1.0-preview.5","@aws-sdk/core-handler":"^0.1.0-preview.5","@aws-sdk/json-builder":"^0.1.0-preview.5","@aws-sdk/signature-v4":"^0.1.0-preview.7","@aws-sdk/protocol-rest":"^0.1.0-preview.7","@aws-sdk/config-resolver":"^0.1.0-preview.5","@aws-sdk/middleware-stack":"^0.1.0-preview.6","@aws-sdk/retry-middleware":"^0.1.0-preview.5","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.5","@aws-sdk/signing-middleware":"^0.1.0-preview.7","@aws-sdk/url-parser-browser":"^0.1.0-preview.5","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.5","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.6","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.6","@aws-sdk/stream-collector-browser":"^0.1.0-preview.5","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.5","@aws-sdk/middleware-header-default":"^0.1.0-preview.5"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-cognito-sync-browser_0.1.0-preview.3_1568908138432_0.726600879914514","host":"s3://npm-registry-packages"}},"0.1.0-preview.4":{"name":"@aws-sdk/client-cognito-sync-browser","version":"0.1.0-preview.4","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-cognito-sync-browser@0.1.0-preview.4","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"b66722ac564a5258bb75d890b3fec1ab5f654b43","tarball":"https://registry.npmjs.org/@aws-sdk/client-cognito-sync-browser/-/client-cognito-sync-browser-0.1.0-preview.4.tgz","fileCount":524,"integrity":"sha512-bqauNYCjFLNw1ZQq1Jy+jc8ecAotTwIvB12r01aVx9S0pWeSbNSz3wK1CYhLEnSyXiE3K7JU68jHNyAMG+ly9g==","signatures":[{"sig":"MEYCIQCmTFA70BNenCr1Q/TGXdGDv9MWupBk70VvpeITCsyYnQIhAMDJzQy+E1M098Pn/e6qYOoKLOn14fs4o/HFY4Kud9lZ","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":329354,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJduM56CRA9TVsSAnZWagAAYswP/1NrhiFj18IgjyUoGuxW\nHx21lG4h5kCiJtjqdkBI8WADeKQCTgzKfoXNKnjjN+Adsrz6KmbTfUX6YoxA\n0L9Pb0FicajNzhxqc7Fyes6PahY+6JyE9sRuQnAiEQFCVRBCCJ3R2gJPe7rX\nDkKU1WM7g/duQQNWhALJX21WPykO/PVl4S1cNKb7ePeYX2NP87Db04fTPBCg\nCRImEU4ClFMq/pTTjeO7+I7Ul55Q0BIEMs1mVistF5avG+OMP0Jq+u4+x4XH\niycA7pa86LLQxhGedTdNOD59ip2ATGL2/m5tiNMEgWjrXX0WZPrfgLytDxnD\nSVeKvbFqrAJuig7kQ/Ui8/Z+oAx82iCocaRlsjRVpiw2MgklAvYqIvJEZ0ZN\nEgziHYiuQTmy7lK+O/1k6mbhHjP+PjkOg4ZSzIhlozo1tm+rtK1Ppa0ruXfu\npSk67PEAv9Rp+8+iRci2jBlvRL/q87ll31TvMOh8zWOYjJUfHtsUtv9l4/cD\ndzn3grlAHojTzYyPRIkXAgBCmR2tSlM4NHNNLJzoBbmGT5UEej9Jh6wnSt6k\n+8sTdn1n3VF2Watb45tn6Y2WOX6kRXqpUABwTl85Yt0kG9BdQ+eqMSMMZXyo\nQZ92nD6L4RdpTOFlvpR6w2cmnCFtvUbJOEbzGAuK0SBwjj/r09Dd5ha3lr0Q\nSvqW\r\n=5eBL\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-cognito-sync-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-cognito-sync-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-cognito-sync-browser)\n\n## Description\n\nAmazon 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.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-cognito-sync-browser\n```\n\n## Getting Started\n\n### Import\n\nThe 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`:\n\n```javascript\n//JavaScript\nconst {\n CognitoSyncClient,\n BulkPublishCommand\n} = require(\"@aws-sdk/client-cognito-sync-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n CognitoSyncClient,\n BulkPublishCommand\n} from \"@aws-sdk/client-cognito-sync-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst cognitoSync = new CognitoSyncClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n IdentityPoolId: /**a string value*/,\n};\nconst bulkPublishCommand = new BulkPublishCommand(params);\ncognitoSync.send(bulkPublishCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await cognitoSync.send(bulkPublishCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ncognitoSync.send(bulkPublishCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-cognito-sync-browser\";\nconst cognitoSync = new AWS.CognitoSync({ region: \"region\" });\ncognitoSync.bulkPublish(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await cognitoSync.send(bulkPublishCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease 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.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-cognito-sync-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-cognito-sync-browser has been renamed to @aws-sdk/client-cognito-sync. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Cognito Sync","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.6","@aws-sdk/json-parser":"^0.1.0-preview.6","@aws-sdk/core-handler":"^0.1.0-preview.6","@aws-sdk/json-builder":"^0.1.0-preview.6","@aws-sdk/signature-v4":"^0.1.0-preview.8","@aws-sdk/protocol-rest":"^0.1.0-preview.8","@aws-sdk/config-resolver":"^0.1.0-preview.6","@aws-sdk/middleware-stack":"^0.1.0-preview.7","@aws-sdk/retry-middleware":"^0.1.0-preview.6","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.6","@aws-sdk/signing-middleware":"^0.1.0-preview.8","@aws-sdk/url-parser-browser":"^0.1.0-preview.6","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.6","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.7","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.7","@aws-sdk/stream-collector-browser":"^0.1.0-preview.6","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.6","@aws-sdk/middleware-header-default":"^0.1.0-preview.6"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-cognito-sync-browser_0.1.0-preview.4_1572392569844_0.3528489297146873","host":"s3://npm-registry-packages"}},"0.1.0-preview.5":{"name":"@aws-sdk/client-cognito-sync-browser","version":"0.1.0-preview.5","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-cognito-sync-browser@0.1.0-preview.5","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"981612ca4ac352b0291a8283fc616fc21b1dc2b5","tarball":"https://registry.npmjs.org/@aws-sdk/client-cognito-sync-browser/-/client-cognito-sync-browser-0.1.0-preview.5.tgz","fileCount":524,"integrity":"sha512-ZlZ0hZSr616KqHqP5mOnFEO6dcs4TNOkq1ne8ZJN2BerXpi0s//lQPUswiacRHfn68ab+6cb1gNKgUUbFsnvlw==","signatures":[{"sig":"MEQCIHBlHed/fOQaf0X8vzMaeYXbPICL2ZVaOUV52nboigkbAiBbacW+DA1BCkR1m7Oo2hEtkBSnvUYhAW/Huf5bJZLLBQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":329598,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdueFfCRA9TVsSAnZWagAAL2YP/Rvc1fDRGed5+l59l4ty\naP0CqZfCC0CjTYy7l5iMmgLgTCmuiSztxQ4ra6nTPlouwxNoQ6IhPxE6/SRt\ni513CMs0abVUVy9VHoY5OBIde6923BQkIQXFJVVsst+X4sfnPFVkaa19qSWa\nuwZGIewl4S/G5iYXglFvHsLz2RimglKRTSCx6TrWcTYFaVECPDMvkd/wzqPX\nS7fADUkzZu7oi0Cjx2ulswHuZTvaYptBNHF0LIYuD59RHhLjpc3P+RxWdBjq\nsiB891veajYYNiXxc4xQ41vcbAO8QKntxXpyVuXHEE25zvsscGs3yZbGHsFU\nBqJcb1EYjp49D8NTFwvcRx2hLWe7xagm6LQH9llgx8Gz4TBZ2PrbAmwpfN/e\nqkUApdWzq5hCJfCk2TjQAfyImzm9Q7QQRd/tcRl/ETUqAwLm6VOxu+fb1ujW\nTlrN0LYbcxurxlr+YT8pXy0OLyB+/j8t9KvcnDCXOlMfFPpNrB7O40S1C1Kt\nRb1Y6nBI/XC5QnVmXp7Um4pV+apwwbv2w59UotfSwD+M/MZuNh1SiZCxPiZJ\nTw+FWaVDYMQWg/e+mODo7zbLPSh3xCMjF8V/Xx1vD1SFBZPo+Z+lQVBoaRMA\n5664v9+fHX3GKpWwhVLTYnt4XLYbZHtFUX5kaDrzTcLrBBbs5wcnvY8AYfw/\nbbWp\r\n=2RuZ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-cognito-sync-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-cognito-sync-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-cognito-sync-browser)\n\n## Description\n\nAmazon 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.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-cognito-sync-browser\n```\n\n## Getting Started\n\n### Import\n\nThe 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`:\n\n```javascript\n//JavaScript\nconst {\n CognitoSyncClient,\n BulkPublishCommand\n} = require(\"@aws-sdk/client-cognito-sync-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n CognitoSyncClient,\n BulkPublishCommand\n} from \"@aws-sdk/client-cognito-sync-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst cognitoSync = new CognitoSyncClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n IdentityPoolId: /**a string value*/,\n};\nconst bulkPublishCommand = new BulkPublishCommand(params);\ncognitoSync.send(bulkPublishCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await cognitoSync.send(bulkPublishCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ncognitoSync.send(bulkPublishCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-cognito-sync-browser\";\nconst cognitoSync = new AWS.CognitoSync({ region: \"region\" });\ncognitoSync.bulkPublish(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await cognitoSync.send(bulkPublishCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease 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.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-cognito-sync-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-cognito-sync-browser has been renamed to @aws-sdk/client-cognito-sync. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Cognito Sync","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@aws-sdk/json-parser":"^0.1.0-preview.7","@aws-sdk/core-handler":"^0.1.0-preview.7","@aws-sdk/json-builder":"^0.1.0-preview.7","@aws-sdk/signature-v4":"^0.1.0-preview.9","@aws-sdk/protocol-rest":"^0.1.0-preview.9","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.8","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.7","@aws-sdk/signing-middleware":"^0.1.0-preview.9","@aws-sdk/url-parser-browser":"^0.1.0-preview.7","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.8","@aws-sdk/stream-collector-browser":"^0.1.0-preview.7","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.7","@aws-sdk/middleware-header-default":"^0.1.0-preview.7"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-cognito-sync-browser_0.1.0-preview.5_1572462942410_0.49020613380596245","host":"s3://npm-registry-packages"}},"0.1.0-preview.6":{"name":"@aws-sdk/client-cognito-sync-browser","version":"0.1.0-preview.6","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-cognito-sync-browser@0.1.0-preview.6","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"c1ffe521de360857f4cd77ff71c1d7bbe5d971da","tarball":"https://registry.npmjs.org/@aws-sdk/client-cognito-sync-browser/-/client-cognito-sync-browser-0.1.0-preview.6.tgz","fileCount":524,"integrity":"sha512-Gy6fZ6tvGMfwq0gmr5+eul7LlCINQVrE7pVhJBsCqdT4u7tKVPPZkLMDmXrh2jjwtyqGr5pUIOFNbvdF5CZkJw==","signatures":[{"sig":"MEQCIGiINQtoaloG9vYcqLdg6AIfocTo7Fi1bWkajUxDpCrzAiA6v7efOlnbsF3W3Nvozy6KhP3wlxBaqnpIfXklWl3EoA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":329869,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd1FMdCRA9TVsSAnZWagAA5pUQAKBxmOShlgRwbypwpoQF\n5gXdD2Hv763SlD739DGzE+8MuHy6JDYZzKWnUc66EPC6rHJDFRMJ7WIb5fGe\nio8hrSVeogNmVejwmtCZI0QMOkIEuZUigpQkYBbjr9BUvHUqfw2sxhf11d62\n06K5kvhydqrp4aPMo+o/y5La01YxeuNvtFYZBo0MzbqwQiFshaN6ubHRF3mP\nsDu8ups0SVEoYjEjLYhaMGMfEdmex3UUYe/8uqraElP/z14Fvwks684ZyJNO\nSZL4iXWxk8/hnrbKq+x0yMuCMRvJgK9SXBJE6T/feudEkh6Wg4iRM7uawWL1\npZXgnZiTdtY8KF1EfE1b/qAI/HxufTCS+9FN6dwGaEmCi7P72/DMe5MNOX2h\naMzxfeYkW7kcWDOvlA3GLK/w84xPG55Ve7M+KWenXuUNFypkqK6lwTlLyQWi\nd1HfkX2eTD5YlwU6x20pQmxtJgOqFX1ZMcijB1dKGUFNBmUQ+id0gDLEzAuc\npBE1m2a89QrLTeT93jDCYkaBBVj/GNey/AagQAtWoJ9VglXd+mvdIDq3vW/X\nomcy7Jj3I0RNlhWsD88l2qaRKHqEFPYNTqcmNmh6MxcgMV+4HzkvpdwPygZm\neF38VqmbhrsTTSveaq6erMzWol0Y80U+YrDEl8LFOWvDsxW3dNUqvdrC6aTe\nHXPU\r\n=xiMQ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-cognito-sync-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-cognito-sync-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-cognito-sync-browser)\n\n## Description\n\nAmazon 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.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-cognito-sync-browser\n```\n\n## Getting Started\n\n### Import\n\nThe 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`:\n\n```javascript\n//JavaScript\nconst {\n CognitoSyncClient,\n BulkPublishCommand\n} = require(\"@aws-sdk/client-cognito-sync-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n CognitoSyncClient,\n BulkPublishCommand\n} from \"@aws-sdk/client-cognito-sync-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst cognitoSync = new CognitoSyncClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n IdentityPoolId: /**a string value*/,\n};\nconst bulkPublishCommand = new BulkPublishCommand(params);\ncognitoSync.send(bulkPublishCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await cognitoSync.send(bulkPublishCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ncognitoSync.send(bulkPublishCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-cognito-sync-browser\";\nconst cognitoSync = new AWS.CognitoSync({ region: \"region\" });\ncognitoSync.bulkPublish(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await cognitoSync.send(bulkPublishCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease 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.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-cognito-sync-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-cognito-sync-browser has been renamed to @aws-sdk/client-cognito-sync. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for Amazon Cognito Sync","directories":{},"_nodeVersion":"10.16.3","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@aws-sdk/json-parser":"^0.1.0-preview.7","@aws-sdk/core-handler":"^0.1.0-preview.7","@aws-sdk/json-builder":"^0.1.0-preview.7","@aws-sdk/signature-v4":"^0.1.0-preview.10","@aws-sdk/protocol-rest":"^0.1.0-preview.10","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.9","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.8","@aws-sdk/signing-middleware":"^0.1.0-preview.10","@aws-sdk/url-parser-browser":"^0.1.0-preview.7","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.9","@aws-sdk/stream-collector-browser":"^0.1.0-preview.7","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.7","@aws-sdk/middleware-header-default":"^0.1.0-preview.7"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-cognito-sync-browser_0.1.0-preview.6_1574195996791_0.49665771429629735","host":"s3://npm-registry-packages"}}},"time":{"created":"2019-09-09T17:39:39.739Z","modified":"2025-03-27T18:41:23.652Z","0.1.0-preview.2":"2019-09-09T17:39:40.080Z","0.1.0-preview.3":"2019-09-19T15:48:58.534Z","0.1.0-preview.4":"2019-10-29T23:42:50.021Z","0.1.0-preview.5":"2019-10-30T19:15:42.559Z","0.1.0-preview.6":"2019-11-19T20:39:56.972Z"},"author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","description":"Browser SDK for Amazon Cognito Sync","maintainers":[{"email":"osa-3p@amazon.com","name":"amzn-oss"},{"email":"aws-sdk-js-automation@amazon.com","name":"aws-sdk-bot"}],"readme":"","readmeFilename":""}