com.amazonaws.services.cognitosync

Interface AmazonCognitoSyncAsync

All Superinterfaces:

AmazonCognitoSync

All Known Implementing Classes:

AmazonCognitoSyncAsyncClient

public interface AmazonCognitoSyncAsync
extends AmazonCognitoSync

Interface for accessing AmazonCognitoSync asynchronously. Each asynchronous method will return a Java Future object, and users are also allowed to provide a callback handler. 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.

Method Summary

Methods

Modifier and Type	Method and Description
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 metadata about a dataset by identity and dataset name.
Future<DescribeDatasetResult>	describeDatasetAsync(DescribeDatasetRequest describeDatasetRequest, AsyncHandler<DescribeDatasetRequest,DescribeDatasetResult> asyncHandler) Gets metadata 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<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<UpdateRecordsResult>	updateRecordsAsync(UpdateRecordsRequest updateRecordsRequest) Posts updates to records and add and delete records for a dataset and user.
Future<UpdateRecordsResult>	updateRecordsAsync(UpdateRecordsRequest updateRecordsRequest, AsyncHandler<UpdateRecordsRequest,UpdateRecordsResult> asyncHandler) Posts updates to records and add and delete records for a dataset and user.

Methods inherited from interface com.amazonaws.services.cognitosync.AmazonCognitoSync

deleteDataset, describeDataset, describeIdentityPoolUsage, describeIdentityUsage, getCachedResponseMetadata, listDatasets, listIdentityPoolUsage, listRecords, setEndpoint, setRegion, shutdown, updateRecords

Method Detail

updateRecordsAsync

Future<UpdateRecordsResult> updateRecordsAsync(UpdateRecordsRequest updateRecordsRequest)
                                               throws AmazonServiceException,
                                                      AmazonClientException

Posts updates to records and add and delete records for a dataset and user.

Parameters:

updateRecordsRequest - Container for the necessary parameters to execute the UpdateRecords operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the UpdateRecords service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

updateRecordsAsync

Future<UpdateRecordsResult> updateRecordsAsync(UpdateRecordsRequest updateRecordsRequest,
                                             AsyncHandler<UpdateRecordsRequest,UpdateRecordsResult> asyncHandler)
                                               throws AmazonServiceException,
                                                      AmazonClientException

Posts updates to records and add and delete records for a dataset and user.

Parameters:

updateRecordsRequest - Container for the necessary parameters to execute the UpdateRecords operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the UpdateRecords service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

describeIdentityPoolUsageAsync

Future<DescribeIdentityPoolUsageResult> describeIdentityPoolUsageAsync(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest)
                                                                       throws AmazonServiceException,
                                                                              AmazonClientException

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

Parameters:

describeIdentityPoolUsageRequest - Container for the necessary parameters to execute the DescribeIdentityPoolUsage operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the DescribeIdentityPoolUsage service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

describeIdentityPoolUsageAsync

Future<DescribeIdentityPoolUsageResult> describeIdentityPoolUsageAsync(DescribeIdentityPoolUsageRequest describeIdentityPoolUsageRequest,
                                                                     AsyncHandler<DescribeIdentityPoolUsageRequest,DescribeIdentityPoolUsageResult> asyncHandler)
                                                                       throws AmazonServiceException,
                                                                              AmazonClientException

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

Parameters:

describeIdentityPoolUsageRequest - Container for the necessary parameters to execute the DescribeIdentityPoolUsage operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DescribeIdentityPoolUsage service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

listDatasetsAsync

Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest listDatasetsRequest)
                                             throws AmazonServiceException,
                                                    AmazonClientException

Lists datasets for an identity.

Parameters:

listDatasetsRequest - Container for the necessary parameters to execute the ListDatasets operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the ListDatasets service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

listDatasetsAsync

Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest listDatasetsRequest,
                                           AsyncHandler<ListDatasetsRequest,ListDatasetsResult> asyncHandler)
                                             throws AmazonServiceException,
                                                    AmazonClientException

Lists datasets for an identity.

Parameters:

listDatasetsRequest - Container for the necessary parameters to execute the ListDatasets operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the ListDatasets service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

listIdentityPoolUsageAsync

Future<ListIdentityPoolUsageResult> listIdentityPoolUsageAsync(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

Gets a list of identity pools registered with Cognito.

Parameters:

listIdentityPoolUsageRequest - Container for the necessary parameters to execute the ListIdentityPoolUsage operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the ListIdentityPoolUsage service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

listIdentityPoolUsageAsync

Future<ListIdentityPoolUsageResult> listIdentityPoolUsageAsync(ListIdentityPoolUsageRequest listIdentityPoolUsageRequest,
                                                             AsyncHandler<ListIdentityPoolUsageRequest,ListIdentityPoolUsageResult> asyncHandler)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

Gets a list of identity pools registered with Cognito.

Parameters:

listIdentityPoolUsageRequest - Container for the necessary parameters to execute the ListIdentityPoolUsage operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the ListIdentityPoolUsage service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

listRecordsAsync

Future<ListRecordsResult> listRecordsAsync(ListRecordsRequest listRecordsRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException

Gets paginated records, optionally changed after a particular sync count for a dataset and identity.

Parameters:

listRecordsRequest - Container for the necessary parameters to execute the ListRecords operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the ListRecords service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

listRecordsAsync

Future<ListRecordsResult> listRecordsAsync(ListRecordsRequest listRecordsRequest,
                                         AsyncHandler<ListRecordsRequest,ListRecordsResult> asyncHandler)
                                           throws AmazonServiceException,
                                                  AmazonClientException

Gets paginated records, optionally changed after a particular sync count for a dataset and identity.

Parameters:

listRecordsRequest - Container for the necessary parameters to execute the ListRecords operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the ListRecords service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

describeDatasetAsync

Future<DescribeDatasetResult> describeDatasetAsync(DescribeDatasetRequest describeDatasetRequest)
                                                   throws AmazonServiceException,
                                                          AmazonClientException

Gets metadata about a dataset by identity and dataset name.

Parameters:

describeDatasetRequest - Container for the necessary parameters to execute the DescribeDataset operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the DescribeDataset service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

describeDatasetAsync

Future<DescribeDatasetResult> describeDatasetAsync(DescribeDatasetRequest describeDatasetRequest,
                                                 AsyncHandler<DescribeDatasetRequest,DescribeDatasetResult> asyncHandler)
                                                   throws AmazonServiceException,
                                                          AmazonClientException

Gets metadata about a dataset by identity and dataset name.

Parameters:

describeDatasetRequest - Container for the necessary parameters to execute the DescribeDataset operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DescribeDataset service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

deleteDatasetAsync

Future<DeleteDatasetResult> deleteDatasetAsync(DeleteDatasetRequest deleteDatasetRequest)
                                               throws AmazonServiceException,
                                                      AmazonClientException

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 consequent operation on this dataset will result in a ResourceNotFoundException.

Parameters:

deleteDatasetRequest - Container for the necessary parameters to execute the DeleteDataset operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the DeleteDataset service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

deleteDatasetAsync

Future<DeleteDatasetResult> deleteDatasetAsync(DeleteDatasetRequest deleteDatasetRequest,
                                             AsyncHandler<DeleteDatasetRequest,DeleteDatasetResult> asyncHandler)
                                               throws AmazonServiceException,
                                                      AmazonClientException

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 consequent operation on this dataset will result in a ResourceNotFoundException.

Parameters:

deleteDatasetRequest - Container for the necessary parameters to execute the DeleteDataset operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DeleteDataset service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

describeIdentityUsageAsync

Future<DescribeIdentityUsageResult> describeIdentityUsageAsync(DescribeIdentityUsageRequest describeIdentityUsageRequest)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

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

Parameters:

describeIdentityUsageRequest - Container for the necessary parameters to execute the DescribeIdentityUsage operation on AmazonCognitoSync.

Returns:

A Java Future object containing the response from the DescribeIdentityUsage service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.

describeIdentityUsageAsync

Future<DescribeIdentityUsageResult> describeIdentityUsageAsync(DescribeIdentityUsageRequest describeIdentityUsageRequest,
                                                             AsyncHandler<DescribeIdentityUsageRequest,DescribeIdentityUsageResult> asyncHandler)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

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

Parameters:

describeIdentityUsageRequest - Container for the necessary parameters to execute the DescribeIdentityUsage operation on AmazonCognitoSync.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DescribeIdentityUsage service method, as returned by AmazonCognitoSync.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCognitoSync indicating either a problem with the data in the request, or a server side issue.