AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing CognitoSync 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.

Inheritance Hierarchy

Amazon.CognitoSync.IAmazonCognitoSync

Namespace: Amazon.CognitoSync
Assembly: AWSSDK.CognitoSync.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonCognitoSync
         IAmazonService, IDisposable

The IAmazonCognitoSync type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method BulkPublish(BulkPublishRequest)

Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

Public Method BulkPublishAsync(BulkPublishRequest, CancellationToken)

Initiates the asynchronous execution of the BulkPublish operation.

Public Method DeleteDataset(DeleteDatasetRequest)

Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

Public Method DeleteDatasetAsync(DeleteDatasetRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDataset operation.

Public Method DescribeDataset(DescribeDatasetRequest)

Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

Public Method DescribeDatasetAsync(DescribeDatasetRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDataset operation.

Public Method DescribeIdentityPoolUsage(string)

Gets usage details (for example, data storage) about a particular identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

Public Method DescribeIdentityPoolUsage(DescribeIdentityPoolUsageRequest)

Gets usage details (for example, data storage) about a particular identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

Public Method DescribeIdentityPoolUsageAsync(string, CancellationToken)

Gets usage details (for example, data storage) about a particular identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

Public Method DescribeIdentityPoolUsageAsync(DescribeIdentityPoolUsageRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeIdentityPoolUsage operation.

Public Method DescribeIdentityUsage(DescribeIdentityUsageRequest)

Gets usage information for an identity, including number of datasets and data usage.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

Public Method DescribeIdentityUsageAsync(DescribeIdentityUsageRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeIdentityUsage operation.

Public Method GetBulkPublishDetails(GetBulkPublishDetailsRequest)

Get the status of the last BulkPublish operation for an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

Public Method GetBulkPublishDetailsAsync(GetBulkPublishDetailsRequest, CancellationToken)

Initiates the asynchronous execution of the GetBulkPublishDetails operation.

Public Method GetCognitoEvents(GetCognitoEventsRequest)

Gets the events and the corresponding Lambda functions associated with an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

Public Method GetCognitoEventsAsync(GetCognitoEventsRequest, CancellationToken)

Initiates the asynchronous execution of the GetCognitoEvents operation.

Public Method GetIdentityPoolConfiguration(string)

Gets the configuration settings of an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

Public Method GetIdentityPoolConfiguration(GetIdentityPoolConfigurationRequest)

Gets the configuration settings of an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

Public Method GetIdentityPoolConfigurationAsync(string, CancellationToken)

Gets the configuration settings of an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

Public Method GetIdentityPoolConfigurationAsync(GetIdentityPoolConfigurationRequest, CancellationToken)

Initiates the asynchronous execution of the GetIdentityPoolConfiguration operation.

Public Method ListDatasets(ListDatasetsRequest)

Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.

Public Method ListDatasetsAsync(ListDatasetsRequest, CancellationToken)

Initiates the asynchronous execution of the ListDatasets operation.

Public Method ListIdentityPoolUsage(ListIdentityPoolUsageRequest)

Gets a list of identity pools registered with Cognito.

ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.

Public Method ListIdentityPoolUsageAsync(ListIdentityPoolUsageRequest, CancellationToken)

Initiates the asynchronous execution of the ListIdentityPoolUsage operation.

Public Method ListRecords(ListRecordsRequest)

Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

Public Method ListRecordsAsync(ListRecordsRequest, CancellationToken)

Initiates the asynchronous execution of the ListRecords operation.

Public Method RegisterDevice(RegisterDeviceRequest)

Registers a device to receive push sync notifications.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

Public Method RegisterDeviceAsync(RegisterDeviceRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterDevice operation.

Public Method SetCognitoEvents(SetCognitoEventsRequest)

Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

Public Method SetCognitoEventsAsync(SetCognitoEventsRequest, CancellationToken)

Initiates the asynchronous execution of the SetCognitoEvents operation.

Public Method SetIdentityPoolConfiguration(SetIdentityPoolConfigurationRequest)

Sets the necessary configuration for push sync.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

Public Method SetIdentityPoolConfigurationAsync(SetIdentityPoolConfigurationRequest, CancellationToken)

Initiates the asynchronous execution of the SetIdentityPoolConfiguration operation.

Public Method SubscribeToDataset(SubscribeToDatasetRequest)

Subscribes to receive notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

Public Method SubscribeToDatasetAsync(SubscribeToDatasetRequest, CancellationToken)

Initiates the asynchronous execution of the SubscribeToDataset operation.

Public Method UnsubscribeFromDataset(UnsubscribeFromDatasetRequest)

Unsubscribes from receiving notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

Public Method UnsubscribeFromDatasetAsync(UnsubscribeFromDatasetRequest, CancellationToken)

Initiates the asynchronous execution of the UnsubscribeFromDataset operation.

Public Method UpdateRecords(UpdateRecordsRequest)

Posts updates to records and adds and deletes records for a dataset and user.

The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.

For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

Public Method UpdateRecordsAsync(UpdateRecordsRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateRecords operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone