cognitosync: Amazon Cognito Sync

Description Usage Arguments Service syntax Operations Examples

View source: R/cognitosync_service.R

Description

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.

Usage

1
cognitosync(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- cognitosync(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

bulk_publish Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream
delete_dataset Deletes the specific dataset
describe_dataset Gets meta data about a dataset by identity and dataset name
describe_identity_pool_usage Gets usage details (for example, data storage) about a particular identity pool
describe_identity_usage Gets usage information for an identity, including number of datasets and data usage
get_bulk_publish_details Get the status of the last BulkPublish operation for an identity pool
get_cognito_events Gets the events and the corresponding Lambda functions associated with an identity pool
get_identity_pool_configuration Gets the configuration settings of an identity pool
list_datasets Lists datasets for an identity
list_identity_pool_usage Gets a list of identity pools registered with Cognito
list_records Gets paginated records, optionally changed after a particular sync count for a dataset and identity
register_device Registers a device to receive push sync notifications
set_cognito_events Sets the AWS Lambda function for a given event type for an identity pool
set_identity_pool_configuration Sets the necessary configuration for push sync
subscribe_to_dataset Subscribes to receive notifications when a dataset is modified by another device
unsubscribe_from_dataset Unsubscribes from receiving notifications when a dataset is modified by another device
update_records Posts updates to records and adds and deletes records for a dataset and user

Examples

1
2
3
4
svc <- cognitosync()
svc$bulk_publish(
  Foo = 123
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.