

***********
CognitoSync
***********



======
Client
======



.. py:class:: CognitoSync.Client

  A low-level client representing 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 <http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html>`__.

   

  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 <http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-sync.html>`__ and the `Developer Guide for iOS <http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-sync.html>`__.

  ::

    
    import boto3
    
    client = boto3.client('cognito-sync')

  

These are the available methods:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  cognito-sync/client/bulk_publish
  cognito-sync/client/can_paginate
  cognito-sync/client/close
  cognito-sync/client/delete_dataset
  cognito-sync/client/describe_dataset
  cognito-sync/client/describe_identity_pool_usage
  cognito-sync/client/describe_identity_usage
  cognito-sync/client/get_bulk_publish_details
  cognito-sync/client/get_cognito_events
  cognito-sync/client/get_identity_pool_configuration
  cognito-sync/client/get_paginator
  cognito-sync/client/get_waiter
  cognito-sync/client/list_datasets
  cognito-sync/client/list_identity_pool_usage
  cognito-sync/client/list_records
  cognito-sync/client/register_device
  cognito-sync/client/set_cognito_events
  cognito-sync/client/set_identity_pool_configuration
  cognito-sync/client/subscribe_to_dataset
  cognito-sync/client/unsubscribe_from_dataset
  cognito-sync/client/update_records
