@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonCognitoSyncAsync extends AmazonCognitoSync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonCognitoSyncAsync
instead.
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.
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
Future<BulkPublishResult> |
bulkPublishAsync(BulkPublishRequest bulkPublishRequest)
Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream.
|
Future<BulkPublishResult> |
bulkPublishAsync(BulkPublishRequest bulkPublishRequest,
AsyncHandler<BulkPublishRequest,BulkPublishResult> asyncHandler)
Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream.
|
Future<DeleteDatasetResult> |
deleteDatasetAsync(DeleteDatasetRequest deleteDatasetRequest)
Deletes the specific dataset.
|
Future<DeleteDatasetResult> |
deleteDatasetAsync(DeleteDatasetRequest deleteDatasetRequest,
AsyncHandler<DeleteDatasetRequest,DeleteDatasetResult> asyncHandler)
Deletes the specific dataset.
|
Future<DescribeDatasetResult> |
describeDatasetAsync(DescribeDatasetRequest describeDatasetRequest)
Gets meta data about a dataset by identity and dataset name.
|
Future<DescribeDatasetResult> |
describeDatasetAsync(DescribeDatasetRequest describeDatasetRequest,
AsyncHandler<DescribeDatasetRequest,DescribeDatasetResult> asyncHandler)
Gets meta data about a dataset by identity and dataset name.
|
Future<DescribeIdentityPoolUsageResult> |
describeIdentityPoolUsageAsync(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest)
Gets usage details (for example, data storage) about a particular identity pool.
|
Future<DescribeIdentityPoolUsageResult> |
describeIdentityPoolUsageAsync(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest,
AsyncHandler<DescribeIdentityPoolUsageRequest,DescribeIdentityPoolUsageResult> asyncHandler)
Gets usage details (for example, data storage) about a particular identity pool.
|
Future<DescribeIdentityUsageResult> |
describeIdentityUsageAsync(DescribeIdentityUsageRequest describeIdentityUsageRequest)
Gets usage information for an identity, including number of datasets and data usage.
|
Future<DescribeIdentityUsageResult> |
describeIdentityUsageAsync(DescribeIdentityUsageRequest describeIdentityUsageRequest,
AsyncHandler<DescribeIdentityUsageRequest,DescribeIdentityUsageResult> asyncHandler)
Gets usage information for an identity, including number of datasets and data usage.
|
Future<GetBulkPublishDetailsResult> |
getBulkPublishDetailsAsync(GetBulkPublishDetailsRequest getBulkPublishDetailsRequest)
Get the status of the last BulkPublish operation for an identity pool.
|
Future<GetBulkPublishDetailsResult> |
getBulkPublishDetailsAsync(GetBulkPublishDetailsRequest getBulkPublishDetailsRequest,
AsyncHandler<GetBulkPublishDetailsRequest,GetBulkPublishDetailsResult> asyncHandler)
Get the status of the last BulkPublish operation for an identity pool.
|
Future<GetCognitoEventsResult> |
getCognitoEventsAsync(GetCognitoEventsRequest getCognitoEventsRequest)
Gets the events and the corresponding Lambda functions associated with an identity pool.
|
Future<GetCognitoEventsResult> |
getCognitoEventsAsync(GetCognitoEventsRequest getCognitoEventsRequest,
AsyncHandler<GetCognitoEventsRequest,GetCognitoEventsResult> asyncHandler)
Gets the events and the corresponding Lambda functions associated with an identity pool.
|
Future<GetIdentityPoolConfigurationResult> |
getIdentityPoolConfigurationAsync(GetIdentityPoolConfigurationRequest getIdentityPoolConfigurationRequest)
Gets the configuration settings of an identity pool.
|
Future<GetIdentityPoolConfigurationResult> |
getIdentityPoolConfigurationAsync(GetIdentityPoolConfigurationRequest getIdentityPoolConfigurationRequest,
AsyncHandler<GetIdentityPoolConfigurationRequest,GetIdentityPoolConfigurationResult> asyncHandler)
Gets the configuration settings of an identity pool.
|
Future<ListDatasetsResult> |
listDatasetsAsync(ListDatasetsRequest listDatasetsRequest)
Lists datasets for an identity.
|
Future<ListDatasetsResult> |
listDatasetsAsync(ListDatasetsRequest listDatasetsRequest,
AsyncHandler<ListDatasetsRequest,ListDatasetsResult> asyncHandler)
Lists datasets for an identity.
|
Future<ListIdentityPoolUsageResult> |
listIdentityPoolUsageAsync(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest)
Gets a list of identity pools registered with Cognito.
|
Future<ListIdentityPoolUsageResult> |
listIdentityPoolUsageAsync(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest,
AsyncHandler<ListIdentityPoolUsageRequest,ListIdentityPoolUsageResult> asyncHandler)
Gets a list of identity pools registered with Cognito.
|
Future<ListRecordsResult> |
listRecordsAsync(ListRecordsRequest listRecordsRequest)
Gets paginated records, optionally changed after a particular sync count for a dataset and identity.
|
Future<ListRecordsResult> |
listRecordsAsync(ListRecordsRequest listRecordsRequest,
AsyncHandler<ListRecordsRequest,ListRecordsResult> asyncHandler)
Gets paginated records, optionally changed after a particular sync count for a dataset and identity.
|
Future<RegisterDeviceResult> |
registerDeviceAsync(RegisterDeviceRequest registerDeviceRequest)
Registers a device to receive push sync notifications.
|
Future<RegisterDeviceResult> |
registerDeviceAsync(RegisterDeviceRequest registerDeviceRequest,
AsyncHandler<RegisterDeviceRequest,RegisterDeviceResult> asyncHandler)
Registers a device to receive push sync notifications.
|
Future<SetCognitoEventsResult> |
setCognitoEventsAsync(SetCognitoEventsRequest setCognitoEventsRequest)
Sets the AWS Lambda function for a given event type for an identity pool.
|
Future<SetCognitoEventsResult> |
setCognitoEventsAsync(SetCognitoEventsRequest setCognitoEventsRequest,
AsyncHandler<SetCognitoEventsRequest,SetCognitoEventsResult> asyncHandler)
Sets the AWS Lambda function for a given event type for an identity pool.
|
Future<SetIdentityPoolConfigurationResult> |
setIdentityPoolConfigurationAsync(SetIdentityPoolConfigurationRequest setIdentityPoolConfigurationRequest)
Sets the necessary configuration for push sync.
|
Future<SetIdentityPoolConfigurationResult> |
setIdentityPoolConfigurationAsync(SetIdentityPoolConfigurationRequest setIdentityPoolConfigurationRequest,
AsyncHandler<SetIdentityPoolConfigurationRequest,SetIdentityPoolConfigurationResult> asyncHandler)
Sets the necessary configuration for push sync.
|
Future<SubscribeToDatasetResult> |
subscribeToDatasetAsync(SubscribeToDatasetRequest subscribeToDatasetRequest)
Subscribes to receive notifications when a dataset is modified by another device.
|
Future<SubscribeToDatasetResult> |
subscribeToDatasetAsync(SubscribeToDatasetRequest subscribeToDatasetRequest,
AsyncHandler<SubscribeToDatasetRequest,SubscribeToDatasetResult> asyncHandler)
Subscribes to receive notifications when a dataset is modified by another device.
|
Future<UnsubscribeFromDatasetResult> |
unsubscribeFromDatasetAsync(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest)
Unsubscribes from receiving notifications when a dataset is modified by another device.
|
Future<UnsubscribeFromDatasetResult> |
unsubscribeFromDatasetAsync(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest,
AsyncHandler<UnsubscribeFromDatasetRequest,UnsubscribeFromDatasetResult> asyncHandler)
Unsubscribes from receiving notifications when a dataset is modified by another device.
|
Future<UpdateRecordsResult> |
updateRecordsAsync(UpdateRecordsRequest updateRecordsRequest)
Posts updates to records and adds and deletes records for a dataset and user.
|
Future<UpdateRecordsResult> |
updateRecordsAsync(UpdateRecordsRequest updateRecordsRequest,
AsyncHandler<UpdateRecordsRequest,UpdateRecordsResult> asyncHandler)
Posts updates to records and adds and deletes records for a dataset and user.
|
bulkPublish, deleteDataset, describeDataset, describeIdentityPoolUsage, describeIdentityUsage, getBulkPublishDetails, getCachedResponseMetadata, getCognitoEvents, getIdentityPoolConfiguration, listDatasets, listIdentityPoolUsage, listRecords, registerDevice, setCognitoEvents, setEndpoint, setIdentityPoolConfiguration, setRegion, shutdown, subscribeToDataset, unsubscribeFromDataset, updateRecords
Future<BulkPublishResult> bulkPublishAsync(BulkPublishRequest 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.
bulkPublishRequest
- The input for the BulkPublish operation.Future<BulkPublishResult> bulkPublishAsync(BulkPublishRequest bulkPublishRequest, AsyncHandler<BulkPublishRequest,BulkPublishResult> asyncHandler)
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.
bulkPublishRequest
- The input for the BulkPublish operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDatasetResult> deleteDatasetAsync(DeleteDatasetRequest 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.
deleteDatasetRequest
- A request to delete the specific dataset.Future<DeleteDatasetResult> deleteDatasetAsync(DeleteDatasetRequest deleteDatasetRequest, AsyncHandler<DeleteDatasetRequest,DeleteDatasetResult> asyncHandler)
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.
deleteDatasetRequest
- A request to delete the specific dataset.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDatasetResult> describeDatasetAsync(DescribeDatasetRequest 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.
describeDatasetRequest
- A request for meta data about a dataset (creation date, number of records, size) by owner and dataset
name.Future<DescribeDatasetResult> describeDatasetAsync(DescribeDatasetRequest describeDatasetRequest, AsyncHandler<DescribeDatasetRequest,DescribeDatasetResult> asyncHandler)
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.
describeDatasetRequest
- A request for meta data about a dataset (creation date, number of records, size) by owner and dataset
name.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeIdentityPoolUsageResult> describeIdentityPoolUsageAsync(DescribeIdentityPoolUsageRequest 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.
describeIdentityPoolUsageRequest
- A request for usage information about the identity pool.Future<DescribeIdentityPoolUsageResult> describeIdentityPoolUsageAsync(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest, AsyncHandler<DescribeIdentityPoolUsageRequest,DescribeIdentityPoolUsageResult> asyncHandler)
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.
describeIdentityPoolUsageRequest
- A request for usage information about the identity pool.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeIdentityUsageResult> describeIdentityUsageAsync(DescribeIdentityUsageRequest 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.
describeIdentityUsageRequest
- A request for information about the usage of an identity pool.Future<DescribeIdentityUsageResult> describeIdentityUsageAsync(DescribeIdentityUsageRequest describeIdentityUsageRequest, AsyncHandler<DescribeIdentityUsageRequest,DescribeIdentityUsageResult> asyncHandler)
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.
describeIdentityUsageRequest
- A request for information about the usage of an identity pool.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBulkPublishDetailsResult> getBulkPublishDetailsAsync(GetBulkPublishDetailsRequest 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.
getBulkPublishDetailsRequest
- The input for the GetBulkPublishDetails operation.Future<GetBulkPublishDetailsResult> getBulkPublishDetailsAsync(GetBulkPublishDetailsRequest getBulkPublishDetailsRequest, AsyncHandler<GetBulkPublishDetailsRequest,GetBulkPublishDetailsResult> asyncHandler)
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.
getBulkPublishDetailsRequest
- The input for the GetBulkPublishDetails operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetCognitoEventsResult> getCognitoEventsAsync(GetCognitoEventsRequest 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.
getCognitoEventsRequest
- A request for a list of the configured Cognito EventsFuture<GetCognitoEventsResult> getCognitoEventsAsync(GetCognitoEventsRequest getCognitoEventsRequest, AsyncHandler<GetCognitoEventsRequest,GetCognitoEventsResult> asyncHandler)
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.
getCognitoEventsRequest
- A request for a list of the configured Cognito EventsasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetIdentityPoolConfigurationResult> getIdentityPoolConfigurationAsync(GetIdentityPoolConfigurationRequest 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.
getIdentityPoolConfigurationRequest
- The input for the GetIdentityPoolConfiguration operation.Future<GetIdentityPoolConfigurationResult> getIdentityPoolConfigurationAsync(GetIdentityPoolConfigurationRequest getIdentityPoolConfigurationRequest, AsyncHandler<GetIdentityPoolConfigurationRequest,GetIdentityPoolConfigurationResult> asyncHandler)
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.
getIdentityPoolConfigurationRequest
- The input for the GetIdentityPoolConfiguration operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest 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.
listDatasetsRequest
- Request for a list of datasets for an identity.Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest listDatasetsRequest, AsyncHandler<ListDatasetsRequest,ListDatasetsResult> asyncHandler)
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.
listDatasetsRequest
- Request for a list of datasets for an identity.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListIdentityPoolUsageResult> listIdentityPoolUsageAsync(ListIdentityPoolUsageRequest 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.
listIdentityPoolUsageRequest
- A request for usage information on an identity pool.Future<ListIdentityPoolUsageResult> listIdentityPoolUsageAsync(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest, AsyncHandler<ListIdentityPoolUsageRequest,ListIdentityPoolUsageResult> asyncHandler)
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.
listIdentityPoolUsageRequest
- A request for usage information on an identity pool.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListRecordsResult> listRecordsAsync(ListRecordsRequest 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.
listRecordsRequest
- A request for a list of records.Future<ListRecordsResult> listRecordsAsync(ListRecordsRequest listRecordsRequest, AsyncHandler<ListRecordsRequest,ListRecordsResult> asyncHandler)
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.
listRecordsRequest
- A request for a list of records.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RegisterDeviceResult> registerDeviceAsync(RegisterDeviceRequest 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.
registerDeviceRequest
- A request to RegisterDevice.Future<RegisterDeviceResult> registerDeviceAsync(RegisterDeviceRequest registerDeviceRequest, AsyncHandler<RegisterDeviceRequest,RegisterDeviceResult> asyncHandler)
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.
registerDeviceRequest
- A request to RegisterDevice.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SetCognitoEventsResult> setCognitoEventsAsync(SetCognitoEventsRequest 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.
setCognitoEventsRequest
- A request to configure Cognito Events"Future<SetCognitoEventsResult> setCognitoEventsAsync(SetCognitoEventsRequest setCognitoEventsRequest, AsyncHandler<SetCognitoEventsRequest,SetCognitoEventsResult> asyncHandler)
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.
setCognitoEventsRequest
- A request to configure Cognito Events"asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SetIdentityPoolConfigurationResult> setIdentityPoolConfigurationAsync(SetIdentityPoolConfigurationRequest 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.
setIdentityPoolConfigurationRequest
- The input for the SetIdentityPoolConfiguration operation.Future<SetIdentityPoolConfigurationResult> setIdentityPoolConfigurationAsync(SetIdentityPoolConfigurationRequest setIdentityPoolConfigurationRequest, AsyncHandler<SetIdentityPoolConfigurationRequest,SetIdentityPoolConfigurationResult> asyncHandler)
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.
setIdentityPoolConfigurationRequest
- The input for the SetIdentityPoolConfiguration operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SubscribeToDatasetResult> subscribeToDatasetAsync(SubscribeToDatasetRequest 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.
subscribeToDatasetRequest
- A request to SubscribeToDatasetRequest.Future<SubscribeToDatasetResult> subscribeToDatasetAsync(SubscribeToDatasetRequest subscribeToDatasetRequest, AsyncHandler<SubscribeToDatasetRequest,SubscribeToDatasetResult> asyncHandler)
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.
subscribeToDatasetRequest
- A request to SubscribeToDatasetRequest.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UnsubscribeFromDatasetResult> unsubscribeFromDatasetAsync(UnsubscribeFromDatasetRequest 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.
unsubscribeFromDatasetRequest
- A request to UnsubscribeFromDataset.Future<UnsubscribeFromDatasetResult> unsubscribeFromDatasetAsync(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest, AsyncHandler<UnsubscribeFromDatasetRequest,UnsubscribeFromDatasetResult> asyncHandler)
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.
unsubscribeFromDatasetRequest
- A request to UnsubscribeFromDataset.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateRecordsResult> updateRecordsAsync(UpdateRecordsRequest 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.
updateRecordsRequest
- A request to post updates to records or add and delete records for a dataset and user.Future<UpdateRecordsResult> updateRecordsAsync(UpdateRecordsRequest updateRecordsRequest, AsyncHandler<UpdateRecordsRequest,UpdateRecordsResult> asyncHandler)
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.
updateRecordsRequest
- A request to post updates to records or add and delete records for a dataset and user.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.