com.amazonaws.services.cognitosync.AmazonCognitoSyncAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cognitosync Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.cognitosync;
import javax.annotation.Generated;
import com.amazonaws.services.cognitosync.model.*;
/**
* Interface for accessing Amazon Cognito Sync asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code 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
* {@link com.amazonaws.services.cognitosync.AbstractAmazonCognitoSyncAsync} instead.
*
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonCognitoSyncAsync extends AmazonCognitoSync {
/**
*
* 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.
*
*
* @param bulkPublishRequest
* The input for the BulkPublish operation.
* @return A Java Future containing the result of the BulkPublish operation returned by the service.
* @sample AmazonCognitoSyncAsync.BulkPublish
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param bulkPublishRequest
* The input for the BulkPublish operation.
* @param 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.
* @return A Java Future containing the result of the BulkPublish operation returned by the service.
* @sample AmazonCognitoSyncAsyncHandler.BulkPublish
* @see AWS API
* Documentation
*/
java.util.concurrent.Future bulkPublishAsync(BulkPublishRequest bulkPublishRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param deleteDatasetRequest
* A request to delete the specific dataset.
* @return A Java Future containing the result of the DeleteDataset operation returned by the service.
* @sample AmazonCognitoSyncAsync.DeleteDataset
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param deleteDatasetRequest
* A request to delete the specific dataset.
* @param 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.
* @return A Java Future containing the result of the DeleteDataset operation returned by the service.
* @sample AmazonCognitoSyncAsyncHandler.DeleteDataset
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteDatasetAsync(DeleteDatasetRequest deleteDatasetRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param describeDatasetRequest
* A request for meta data about a dataset (creation date, number of records, size) by owner and dataset
* name.
* @return A Java Future containing the result of the DescribeDataset operation returned by the service.
* @sample AmazonCognitoSyncAsync.DescribeDataset
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param describeDatasetRequest
* A request for meta data about a dataset (creation date, number of records, size) by owner and dataset
* name.
* @param 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.
* @return A Java Future containing the result of the DescribeDataset operation returned by the service.
* @sample AmazonCognitoSyncAsyncHandler.DescribeDataset
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeDatasetAsync(DescribeDatasetRequest describeDatasetRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param describeIdentityPoolUsageRequest
* A request for usage information about the identity pool.
* @return A Java Future containing the result of the DescribeIdentityPoolUsage operation returned by the service.
* @sample AmazonCognitoSyncAsync.DescribeIdentityPoolUsage
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param describeIdentityPoolUsageRequest
* A request for usage information about the identity pool.
* @param 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.
* @return A Java Future containing the result of the DescribeIdentityPoolUsage operation returned by the service.
* @sample AmazonCognitoSyncAsyncHandler.DescribeIdentityPoolUsage
* @see AWS API Documentation
*/
java.util.concurrent.Future describeIdentityPoolUsageAsync(
DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param describeIdentityUsageRequest
* A request for information about the usage of an identity pool.
* @return A Java Future containing the result of the DescribeIdentityUsage operation returned by the service.
* @sample AmazonCognitoSyncAsync.DescribeIdentityUsage
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param describeIdentityUsageRequest
* A request for information about the usage of an identity pool.
* @param 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.
* @return A Java Future containing the result of the DescribeIdentityUsage operation returned by the service.
* @sample AmazonCognitoSyncAsyncHandler.DescribeIdentityUsage
* @see AWS API Documentation
*/
java.util.concurrent.Future describeIdentityUsageAsync(DescribeIdentityUsageRequest describeIdentityUsageRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param getBulkPublishDetailsRequest
* The input for the GetBulkPublishDetails operation.
* @return A Java Future containing the result of the GetBulkPublishDetails operation returned by the service.
* @sample AmazonCognitoSyncAsync.GetBulkPublishDetails
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param getBulkPublishDetailsRequest
* The input for the GetBulkPublishDetails operation.
* @param 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.
* @return A Java Future containing the result of the GetBulkPublishDetails operation returned by the service.
* @sample AmazonCognitoSyncAsyncHandler.GetBulkPublishDetails
* @see AWS API Documentation
*/
java.util.concurrent.Future getBulkPublishDetailsAsync(GetBulkPublishDetailsRequest getBulkPublishDetailsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param getCognitoEventsRequest
* A request for a list of the configured Cognito Events
* @return A Java Future containing the result of the GetCognitoEvents operation returned by the service.
* @sample AmazonCognitoSyncAsync.GetCognitoEvents
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param getCognitoEventsRequest
* A request for a list of the configured Cognito Events
* @param 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.
* @return A Java Future containing the result of the GetCognitoEvents operation returned by the service.
* @sample AmazonCognitoSyncAsyncHandler.GetCognitoEvents
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getCognitoEventsAsync(GetCognitoEventsRequest getCognitoEventsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param getIdentityPoolConfigurationRequest
* The input for the GetIdentityPoolConfiguration operation.
* @return A Java Future containing the result of the GetIdentityPoolConfiguration operation returned by the
* service.
* @sample AmazonCognitoSyncAsync.GetIdentityPoolConfiguration
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param getIdentityPoolConfigurationRequest
* The input for the GetIdentityPoolConfiguration operation.
* @param 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.
* @return A Java Future containing the result of the GetIdentityPoolConfiguration operation returned by the
* service.
* @sample AmazonCognitoSyncAsyncHandler.GetIdentityPoolConfiguration
* @see AWS API Documentation
*/
java.util.concurrent.Future getIdentityPoolConfigurationAsync(
GetIdentityPoolConfigurationRequest getIdentityPoolConfigurationRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param listDatasetsRequest
* Request for a list of datasets for an identity.
* @return A Java Future containing the result of the ListDatasets operation returned by the service.
* @sample AmazonCognitoSyncAsync.ListDatasets
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param listDatasetsRequest
* Request for a list of datasets for an identity.
* @param 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.
* @return A Java Future containing the result of the ListDatasets operation returned by the service.
* @sample AmazonCognitoSyncAsyncHandler.ListDatasets
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listDatasetsAsync(ListDatasetsRequest listDatasetsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param listIdentityPoolUsageRequest
* A request for usage information on an identity pool.
* @return A Java Future containing the result of the ListIdentityPoolUsage operation returned by the service.
* @sample AmazonCognitoSyncAsync.ListIdentityPoolUsage
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param listIdentityPoolUsageRequest
* A request for usage information on an identity pool.
* @param 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.
* @return A Java Future containing the result of the ListIdentityPoolUsage operation returned by the service.
* @sample AmazonCognitoSyncAsyncHandler.ListIdentityPoolUsage
* @see AWS API Documentation
*/
java.util.concurrent.Future listIdentityPoolUsageAsync(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param listRecordsRequest
* A request for a list of records.
* @return A Java Future containing the result of the ListRecords operation returned by the service.
* @sample AmazonCognitoSyncAsync.ListRecords
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param listRecordsRequest
* A request for a list of records.
* @param 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.
* @return A Java Future containing the result of the ListRecords operation returned by the service.
* @sample AmazonCognitoSyncAsyncHandler.ListRecords
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listRecordsAsync(ListRecordsRequest listRecordsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param registerDeviceRequest
* A request to RegisterDevice.
* @return A Java Future containing the result of the RegisterDevice operation returned by the service.
* @sample AmazonCognitoSyncAsync.RegisterDevice
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param registerDeviceRequest
* A request to RegisterDevice.
* @param 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.
* @return A Java Future containing the result of the RegisterDevice operation returned by the service.
* @sample AmazonCognitoSyncAsyncHandler.RegisterDevice
* @see AWS
* API Documentation
*/
java.util.concurrent.Future registerDeviceAsync(RegisterDeviceRequest registerDeviceRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param setCognitoEventsRequest
* A request to configure Cognito Events"
* @return A Java Future containing the result of the SetCognitoEvents operation returned by the service.
* @sample AmazonCognitoSyncAsync.SetCognitoEvents
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param setCognitoEventsRequest
* A request to configure Cognito Events"
* @param 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.
* @return A Java Future containing the result of the SetCognitoEvents operation returned by the service.
* @sample AmazonCognitoSyncAsyncHandler.SetCognitoEvents
* @see AWS
* API Documentation
*/
java.util.concurrent.Future setCognitoEventsAsync(SetCognitoEventsRequest setCognitoEventsRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param setIdentityPoolConfigurationRequest
* The input for the SetIdentityPoolConfiguration operation.
* @return A Java Future containing the result of the SetIdentityPoolConfiguration operation returned by the
* service.
* @sample AmazonCognitoSyncAsync.SetIdentityPoolConfiguration
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param setIdentityPoolConfigurationRequest
* The input for the SetIdentityPoolConfiguration operation.
* @param 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.
* @return A Java Future containing the result of the SetIdentityPoolConfiguration operation returned by the
* service.
* @sample AmazonCognitoSyncAsyncHandler.SetIdentityPoolConfiguration
* @see AWS API Documentation
*/
java.util.concurrent.Future setIdentityPoolConfigurationAsync(
SetIdentityPoolConfigurationRequest setIdentityPoolConfigurationRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param subscribeToDatasetRequest
* A request to SubscribeToDatasetRequest.
* @return A Java Future containing the result of the SubscribeToDataset operation returned by the service.
* @sample AmazonCognitoSyncAsync.SubscribeToDataset
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param subscribeToDatasetRequest
* A request to SubscribeToDatasetRequest.
* @param 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.
* @return A Java Future containing the result of the SubscribeToDataset operation returned by the service.
* @sample AmazonCognitoSyncAsyncHandler.SubscribeToDataset
* @see AWS API Documentation
*/
java.util.concurrent.Future subscribeToDatasetAsync(SubscribeToDatasetRequest subscribeToDatasetRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param unsubscribeFromDatasetRequest
* A request to UnsubscribeFromDataset.
* @return A Java Future containing the result of the UnsubscribeFromDataset operation returned by the service.
* @sample AmazonCognitoSyncAsync.UnsubscribeFromDataset
* @see AWS API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param unsubscribeFromDatasetRequest
* A request to UnsubscribeFromDataset.
* @param 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.
* @return A Java Future containing the result of the UnsubscribeFromDataset operation returned by the service.
* @sample AmazonCognitoSyncAsyncHandler.UnsubscribeFromDataset
* @see AWS API Documentation
*/
java.util.concurrent.Future unsubscribeFromDatasetAsync(UnsubscribeFromDatasetRequest unsubscribeFromDatasetRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param updateRecordsRequest
* A request to post updates to records or add and delete records for a dataset and user.
* @return A Java Future containing the result of the UpdateRecords operation returned by the service.
* @sample AmazonCognitoSyncAsync.UpdateRecords
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param updateRecordsRequest
* A request to post updates to records or add and delete records for a dataset and user.
* @param 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.
* @return A Java Future containing the result of the UpdateRecords operation returned by the service.
* @sample AmazonCognitoSyncAsyncHandler.UpdateRecords
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateRecordsAsync(UpdateRecordsRequest updateRecordsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}