Classes
The following classes are available globally.
-
An object that encapsulates a resolved conflict in Amazon Cognito.
Declaration
Objective-C
@interface AWSCognitoResolvedConflict : NSObject
Swift
class AWSCognitoResolvedConflict : NSObject
-
An object that encapsulates a tuple of Amazon Cognito records.
See moreDeclaration
Objective-C
@interface AWSCognitoRecordTuple : NSObject
Swift
class AWSCognitoRecordTuple : NSObject
-
An object that encapsulates a conflicting record where both the local and remote have been modified since the last synchronization.
See moreDeclaration
Objective-C
@interface AWSCognitoConflict : AWSCognitoRecordTuple
Swift
class AWSCognitoConflict : AWSCognitoRecordTuple
-
An object that encapsulates the dataset metadata.
See moreDeclaration
Objective-C
@interface AWSCognitoDatasetMetadata : NSObject
Swift
class AWSCognitoDatasetMetadata : NSObject
-
An object that encapsulates the dataset. The dataset is the unit of sync for Amazon Cognito.
See moreDeclaration
Objective-C
@interface AWSCognitoDataset : AWSCognitoDatasetMetadata
Swift
class AWSCognitoDataset : AWSCognitoDatasetMetadata
-
An object that encapsulates the record value.
See moreDeclaration
Objective-C
@interface AWSCognitoRecordValue : NSObject
Swift
class AWSCognitoRecordValue : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface AWSCognitoRecordMetadata : NSObject /** Record ID or name. */ @property (nonatomic, readonly) NSString *recordId; /** The last date the record was modified. */ @property (nonatomic, readonly) NSDate *lastModified; /** The ID of the client that last modified the record. Set in AWSCognitoConfig under the clientID property. */ @property (nonatomic, strong) NSString *lastModifiedBy; /** Boolean indicating whether or not the record has updates/deletes that need to be synced with the server. */ @property (nonatomic, readonly, getter = isDirty) BOOL dirty; /** Integer value indicating how many times the record has been written since the last sync. The value is 0 if the record has not been modified. The value is incremented by 1 each time the record is updated. The value is set to -1 when the record is marked as deleted from the local database. */ @property (nonatomic, assign) int64_t dirtyCount; /** Integer value of the server sync count of the record. */ @property (nonatomic, assign) int64_t syncCount; - (instancetype)initWithId:(NSString *)recordId; /** Checks if the metadata matches. @param object The object to be compared to the receiver. May be nil, in which case this method returns NO. @return YES if the receiver and object have equal metadata, otherwise NO. */ - (BOOL)isEqualMetadata:(id)object; @end
Swift
class AWSCognitoRecordMetadata : NSObject
-
Undocumented
See moreDeclaration
Objective-C
@interface AWSCognitoRecord : AWSCognitoRecordMetadata /** The data for the record. */ @property (nonatomic, strong) AWSCognitoRecordValue *data; /** Initializes a AWSCognitoRecord with the given recordID, given data, and a dirtyCount and recordVersion of 0. @param recordId The record ID of the AWSCognitoRecord @param data the initial data that the AWSCognitoRecord will contain */ - (instancetype)initWithId:(NSString *)recordId data:(AWSCognitoRecordValue *)data; /** Returns true if this record has been deleted @return YES if the record is deleted, NO otherwise */ - (BOOL)isDeleted; @end
Swift
class AWSCognitoRecord : AWSCognitoRecordMetadata
-
Deprecated
Use
AWSAppSync
for data synchronization.AWSCognito
Warning
The AWSCognito (Amazon Cognito Sync) SDK is deprecated. Please use AWSAppSync for data sync. @deprecated Please use AWSAppSync for data sync.Declaration
Objective-C
@interface AWSCognito
Swift
class AWSCognito
-
The input for the BulkPublish operation. Required parameters: [IdentityPoolId]
See moreDeclaration
Objective-C
@interface AWSCognitoSyncBulkPublishRequest
Swift
class AWSCognitoSyncBulkPublishRequest
-
The output for the BulkPublish operation.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncBulkPublishResponse
Swift
class AWSCognitoSyncBulkPublishResponse
-
Configuration options for configure Cognito streams.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncCognitoStreams
Swift
class AWSCognitoSyncCognitoStreams
-
A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don’t exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncDataset
Swift
class AWSCognitoSyncDataset
-
A request to delete the specific dataset. Required parameters: [IdentityPoolId, IdentityId, DatasetName]
See moreDeclaration
Objective-C
@interface AWSCognitoSyncDeleteDatasetRequest
Swift
class AWSCognitoSyncDeleteDatasetRequest
-
Response to a successful DeleteDataset request.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncDeleteDatasetResponse
Swift
class AWSCognitoSyncDeleteDatasetResponse
-
A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name. Required parameters: [IdentityPoolId, IdentityId, DatasetName]
See moreDeclaration
Objective-C
@interface AWSCognitoSyncDescribeDatasetRequest
Swift
class AWSCognitoSyncDescribeDatasetRequest
-
Response to a successful DescribeDataset request.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncDescribeDatasetResponse
Swift
class AWSCognitoSyncDescribeDatasetResponse
-
A request for usage information about the identity pool. Required parameters: [IdentityPoolId]
See moreDeclaration
Objective-C
@interface AWSCognitoSyncDescribeIdentityPoolUsageRequest
Swift
class AWSCognitoSyncDescribeIdentityPoolUsageRequest
-
Response to a successful DescribeIdentityPoolUsage request.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncDescribeIdentityPoolUsageResponse
Swift
class AWSCognitoSyncDescribeIdentityPoolUsageResponse
-
A request for information about the usage of an identity pool. Required parameters: [IdentityPoolId, IdentityId]
See moreDeclaration
Objective-C
@interface AWSCognitoSyncDescribeIdentityUsageRequest
Swift
class AWSCognitoSyncDescribeIdentityUsageRequest
-
The response to a successful DescribeIdentityUsage request.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncDescribeIdentityUsageResponse
Swift
class AWSCognitoSyncDescribeIdentityUsageResponse
-
The input for the GetBulkPublishDetails operation. Required parameters: [IdentityPoolId]
See moreDeclaration
Objective-C
@interface AWSCognitoSyncGetBulkPublishDetailsRequest
Swift
class AWSCognitoSyncGetBulkPublishDetailsRequest
-
The output for the GetBulkPublishDetails operation.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncGetBulkPublishDetailsResponse
Swift
class AWSCognitoSyncGetBulkPublishDetailsResponse
-
A request for a list of the configured Cognito Events
Required parameters: [IdentityPoolId]
See moreDeclaration
Objective-C
@interface AWSCognitoSyncGetCognitoEventsRequest
Swift
class AWSCognitoSyncGetCognitoEventsRequest
-
The response from the GetCognitoEvents request
See moreDeclaration
Objective-C
@interface AWSCognitoSyncGetCognitoEventsResponse
Swift
class AWSCognitoSyncGetCognitoEventsResponse
-
The input for the GetIdentityPoolConfiguration operation.
Required parameters: [IdentityPoolId]
See moreDeclaration
Objective-C
@interface AWSCognitoSyncGetIdentityPoolConfigurationRequest
Swift
class AWSCognitoSyncGetIdentityPoolConfigurationRequest
-
The output for the GetIdentityPoolConfiguration operation.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncGetIdentityPoolConfigurationResponse
Swift
class AWSCognitoSyncGetIdentityPoolConfigurationResponse
-
Usage information for the identity pool.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncIdentityPoolUsage
Swift
class AWSCognitoSyncIdentityPoolUsage
-
Usage information for the identity.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncIdentityUsage
Swift
class AWSCognitoSyncIdentityUsage
-
Request for a list of datasets for an identity. Required parameters: [IdentityId, IdentityPoolId]
See moreDeclaration
Objective-C
@interface AWSCognitoSyncListDatasetsRequest
Swift
class AWSCognitoSyncListDatasetsRequest
-
Returned for a successful ListDatasets request.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncListDatasetsResponse
Swift
class AWSCognitoSyncListDatasetsResponse
-
A request for usage information on an identity pool.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncListIdentityPoolUsageRequest
Swift
class AWSCognitoSyncListIdentityPoolUsageRequest
-
Returned for a successful ListIdentityPoolUsage request.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncListIdentityPoolUsageResponse
Swift
class AWSCognitoSyncListIdentityPoolUsageResponse
-
A request for a list of records. Required parameters: [IdentityPoolId, IdentityId, DatasetName]
See moreDeclaration
Objective-C
@interface AWSCognitoSyncListRecordsRequest
Swift
class AWSCognitoSyncListRecordsRequest
-
Returned for a successful ListRecordsRequest.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncListRecordsResponse
Swift
class AWSCognitoSyncListRecordsResponse
-
Configuration options to be applied to the identity pool.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncPushSync
Swift
class AWSCognitoSyncPushSync
-
The basic data structure of a dataset.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncRecord
Swift
class AWSCognitoSyncRecord
-
An update operation for a record. Required parameters: [Op, Key, SyncCount]
See moreDeclaration
Objective-C
@interface AWSCognitoSyncRecordPatch
Swift
class AWSCognitoSyncRecordPatch
-
A request to RegisterDevice.
Required parameters: [IdentityPoolId, IdentityId, Platform, Token]
See moreDeclaration
Objective-C
@interface AWSCognitoSyncRegisterDeviceRequest
Swift
class AWSCognitoSyncRegisterDeviceRequest
-
Response to a RegisterDevice request.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncRegisterDeviceResponse
Swift
class AWSCognitoSyncRegisterDeviceResponse
-
A request to configure Cognito Events"
“ Required parameters: [IdentityPoolId, Events] See moreDeclaration
Objective-C
@interface AWSCognitoSyncSetCognitoEventsRequest
Swift
class AWSCognitoSyncSetCognitoEventsRequest
-
The input for the SetIdentityPoolConfiguration operation.
Required parameters: [IdentityPoolId]
See moreDeclaration
Objective-C
@interface AWSCognitoSyncSetIdentityPoolConfigurationRequest
Swift
class AWSCognitoSyncSetIdentityPoolConfigurationRequest
-
The output for the SetIdentityPoolConfiguration operation
See moreDeclaration
Objective-C
@interface AWSCognitoSyncSetIdentityPoolConfigurationResponse
Swift
class AWSCognitoSyncSetIdentityPoolConfigurationResponse
-
A request to SubscribeToDatasetRequest.
Required parameters: [IdentityPoolId, IdentityId, DatasetName, DeviceId]
See moreDeclaration
Objective-C
@interface AWSCognitoSyncSubscribeToDatasetRequest
Swift
class AWSCognitoSyncSubscribeToDatasetRequest
-
Response to a SubscribeToDataset request.
Declaration
Objective-C
@interface AWSCognitoSyncSubscribeToDatasetResponse
Swift
class AWSCognitoSyncSubscribeToDatasetResponse
-
A request to UnsubscribeFromDataset.
Required parameters: [IdentityPoolId, IdentityId, DatasetName, DeviceId]
See moreDeclaration
Objective-C
@interface AWSCognitoSyncUnsubscribeFromDatasetRequest
Swift
class AWSCognitoSyncUnsubscribeFromDatasetRequest
-
Response to an UnsubscribeFromDataset request.
Declaration
Objective-C
@interface AWSCognitoSyncUnsubscribeFromDatasetResponse
Swift
class AWSCognitoSyncUnsubscribeFromDatasetResponse
-
A request to post updates to records or add and delete records for a dataset and user. Required parameters: [IdentityPoolId, IdentityId, DatasetName, SyncSessionToken]
See moreDeclaration
Objective-C
@interface AWSCognitoSyncUpdateRecordsRequest
Swift
class AWSCognitoSyncUpdateRecordsRequest
-
Returned for a successful UpdateRecordsRequest.
See moreDeclaration
Objective-C
@interface AWSCognitoSyncUpdateRecordsResponse
Swift
class AWSCognitoSyncUpdateRecordsResponse
-
Undocumented
See moreDeclaration
Objective-C
@interface AWSCognitoSyncResources : NSObject + (instancetype)sharedInstance; - (NSDictionary *)JSONObject; @end
Swift
class AWSCognitoSyncResources : NSObject
-
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.
See moreDeclaration
Objective-C
@interface AWSCognitoSync
Swift
class AWSCognitoSync